com.ardikars.jxnet

Class ApplicationContext

java.lang.Object

com.ardikars.jxnet.ApplicationContext

All Implemented Interfaces:

com.ardikars.common.util.Factory<Context,com.ardikars.common.util.Builder<com.ardikars.jxnet.Pcap,java.lang.Void>>, Context

public final class ApplicationContext
extends java.lang.Object
implements Context

Since:

1.1.5

Author:

Ardika Rommy Sanjaya

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ApplicationContext(java.lang.String applicationName, java.lang.String applicationDisplayName, java.lang.String applicationVersion, com.ardikars.common.util.Builder<com.ardikars.jxnet.Pcap,java.lang.Void> builder)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getApplicationDisplayName()
java.lang.String	getApplicationName()
java.lang.String	getApplicationVersion()
Context	newInstance(com.ardikars.common.util.Builder<com.ardikars.jxnet.Pcap,java.lang.Void> builder)
void	pcapBreakLoop() Set a flag that will force PcapDispatch() or PcapLoop() to return rather than looping.
com.ardikars.jxnet.PcapCode	pcapCanSetRfMon() Checks whether monitor mode could be set on a capture handle when the handle is activated.
void	pcapClose() Close the files associated with pcap and deallocates resources.
com.ardikars.jxnet.PcapCode	pcapCompile(java.lang.String str, com.ardikars.jxnet.BpfProgram.BpfCompileMode optimize, int netmask) Compile a packet filter, converting an high level filtering expression (see Filtering expression syntax) in a program that can be interpreted by the kernel-level filtering engine.
com.ardikars.jxnet.PcapCode	pcapCompileNoPcap(int snaplen, com.ardikars.jxnet.DataLinkType dataLinkType, java.lang.String filter, com.ardikars.jxnet.BpfProgram.BpfCompileMode optimize, com.ardikars.common.net.Inet4Address mask) Compile a packet filter without the need of opening an adapter.
com.ardikars.jxnet.DataLinkType	pcapDataLink() Return the link layer of an adapter on success.
<T> com.ardikars.jxnet.PcapCode	pcapDispatch(int cnt, com.ardikars.jxnet.PcapHandler<T> callback, T user) Collect a group of packets.
<T> com.ardikars.jxnet.PcapCode	pcapDispatch(int cnt, com.ardikars.jxnet.PcapHandler<T> callback, T user, java.util.concurrent.Executor executor) Collect a group of packets.
void	pcapDump(com.ardikars.jxnet.PcapPktHdr h, java.nio.ByteBuffer sp) Save a packet to disk.
void	pcapDumpClose(com.ardikars.jxnet.PcapDumper pcapDumper) Closes a savefile.
com.ardikars.jxnet.PcapCode	pcapDumpFlush() Flushes the output buffer to the savefile, so that any packets written with PcapDump() but not yet written to the savefile will be written.
long	pcapDumpFTell() Return the file position for a savefile.
com.ardikars.jxnet.PcapCode	pcapDumpOpen(java.lang.String fname) Open a file to write packets.
void	pcapFreeCode() Free a filter.
java.lang.String	pcapGetErr() Return the error text pertaining to the last pcap library error.
com.ardikars.jxnet.PcapCode	pcapGetNonBlock(java.lang.StringBuilder errbuf) Get the "non-blocking" state of an interface.
com.ardikars.jxnet.PcapTimestampPrecision	pcapGetTStampPrecision() Get the timestamp precision returned in captures.
com.ardikars.jxnet.PcapCode	pcapInject(java.nio.ByteBuffer buf, int size) Sends a raw packet through the network interface; buf points to the data of the packet, including the link-layer header, and size is the number of bytes in the packet.
com.ardikars.jxnet.PcapCode	pcapIsSwapped() Returns true (1) if the current savefile uses a different byte order than the current system.
com.ardikars.jxnet.PcapCode	pcapListDataLinks(java.util.List<com.ardikars.jxnet.DataLinkType> dtlBuffer) Get list of datalinks.
com.ardikars.jxnet.PcapCode	pcapListTStampTypes(java.util.List<com.ardikars.jxnet.PcapTimestampType> tstampTypesp) Get link of time stamp types.
<T> com.ardikars.jxnet.PcapCode	pcapLoop(int cnt, com.ardikars.jxnet.PcapHandler<T> callback, T user) Collect a group of packets.
<T> com.ardikars.jxnet.PcapCode	pcapLoop(int cnt, com.ardikars.jxnet.PcapHandler<T> callback, T user, java.util.concurrent.Executor executor) Collect a group of packets.
int	pcapMajorVersion() Return the major version number of the pcap library used to write the savefile.
int	pcapMinorVersion() Return the minor version number of the pcap library used to write the savefile.
java.nio.ByteBuffer	pcapNext(com.ardikars.jxnet.PcapPktHdr h) Return the next available packet.
com.ardikars.jxnet.PcapCode	pcapNextEx(com.ardikars.jxnet.PcapPktHdr pktHeader, java.nio.ByteBuffer pktData) Read a packet from an interface or from an offline capture.
com.ardikars.jxnet.PcapCode	pcapOfflineFilter(com.ardikars.jxnet.BpfProgram fp, com.ardikars.jxnet.PcapPktHdr h, java.nio.ByteBuffer pkt) Given a BPF program, a PcapPktHdr structure for a packet, and the raw data for the packet, check whether the packet passes the filter.
void	pcapPError(java.lang.String prefix) Print the text of the last pcap library error on stderr, prefixed by prefix.
com.ardikars.jxnet.PcapCode	pcapSendPacket(java.nio.ByteBuffer buf, int size) Send a raw packet.
com.ardikars.jxnet.PcapCode	pcapSetDataLink(com.ardikars.jxnet.DataLinkType dataLinkType) Set the current data link type of the pcap descriptor to the type specified by dlt.
com.ardikars.jxnet.PcapCode	pcapSetDirection(com.ardikars.jxnet.PcapDirection direction) used to specify a direction that packets will be captured.
com.ardikars.jxnet.PcapCode	pcapSetFilter() Associate a filter to a capture.
com.ardikars.jxnet.PcapCode	pcapSetNonBlock(boolean nonblock, java.lang.StringBuilder errbuf) Switch between blocking and nonblocking mode.
int	pcapSnapshot() Return the dimension of the packet portion (in bytes) that is delivered to the application.
com.ardikars.jxnet.PcapCode	pcapStats(com.ardikars.jxnet.PcapStat pcapStat) Return statistics on current capture.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ApplicationContext

protected ApplicationContext(java.lang.String applicationName,
                             java.lang.String applicationDisplayName,
                             java.lang.String applicationVersion,
                             com.ardikars.common.util.Builder<com.ardikars.jxnet.Pcap,java.lang.Void> builder)

Method Detail

getApplicationName

public java.lang.String getApplicationName()

Specified by:

getApplicationName in interface Context

getApplicationDisplayName

public java.lang.String getApplicationDisplayName()

Specified by:

getApplicationDisplayName in interface Context

getApplicationVersion

public java.lang.String getApplicationVersion()

Specified by:

getApplicationVersion in interface Context

newInstance

public Context newInstance(com.ardikars.common.util.Builder<com.ardikars.jxnet.Pcap,java.lang.Void> builder)

Specified by:

newInstance in interface com.ardikars.common.util.Factory<Context,com.ardikars.common.util.Builder<com.ardikars.jxnet.Pcap,java.lang.Void>>

pcapLoop

public <T> com.ardikars.jxnet.PcapCode pcapLoop(int cnt,
                                                com.ardikars.jxnet.PcapHandler<T> callback,
                                                T user)
                                         throws com.ardikars.jxnet.exception.PcapCloseException

Description copied from interface: Context

Collect a group of packets. Callback argument already asyncronous.

Specified by:

pcapLoop in interface Context

Type Parameters:

T - args type.

Parameters:

cnt - maximum iteration, -1 is infinite iteration.

callback - callback funtion.

user - args

Returns:

PcapLoop() returns 0 if cnt is exhausted or if, when reading from a savefile, no more packets are available. It returns -1 if an error occurs or -2 if the loop terminated due to a call to PcapBreakLoop() before any packets were processed. It does not return when live packet buffer timeouts occur; instead, it attempts to read more packets.

Throws:

com.ardikars.jxnet.exception.PcapCloseException - pcap close exception.

pcapLoop

public <T> com.ardikars.jxnet.PcapCode pcapLoop(int cnt,
                                                com.ardikars.jxnet.PcapHandler<T> callback,
                                                T user,
                                                java.util.concurrent.Executor executor)
                                         throws com.ardikars.jxnet.exception.PcapCloseException

Description copied from interface: Context

Collect a group of packets.

Specified by:

pcapLoop in interface Context

Type Parameters:

T - args type.

Parameters:

cnt - maximum iteration, -1 is infinite iteration.

callback - callback funtion.

user - args

executor - executor service.

Returns:

PcapLoop() returns 0 if cnt is exhausted or if, when reading from a savefile, no more packets are available. It returns -1 if an error occurs or -2 if the loop terminated due to a call to PcapBreakLoop() before any packets were processed. It does not return when live packet buffer timeouts occur; instead, it attempts to read more packets.

Throws:

com.ardikars.jxnet.exception.PcapCloseException - pcap close exception.

pcapDispatch

public <T> com.ardikars.jxnet.PcapCode pcapDispatch(int cnt,
                                                    com.ardikars.jxnet.PcapHandler<T> callback,
                                                    T user)
                                             throws com.ardikars.jxnet.exception.PcapCloseException

Description copied from interface: Context

Collect a group of packets.

Specified by:

pcapDispatch in interface Context

Type Parameters:

T - args type.

Parameters:

cnt - maximum iteration, -1 to infinite.

callback - callback function.

user - arg.

Returns:

PcapDispatch() returns the number of packets processed on success; this can be 0 if no packets were read from a live capture (if, for example, they were discarded because they didn't pass the packet filter, or if, on platforms that support a packet buffer timeout that starts before any packets arrive, the timeout expires before any packets arrive, or if the file descriptor for the capture device is in non-blocking mode and no packets were available to be read) or if no more packets are available in a savefile. It returns -1 if an error occurs or -2 if the loop terminated due to a call to PcapBreakLoop() before any packets were processed. If your application uses PcapBreakLoop(), make sure that you explicitly check for -1 and -2, rather than just checking for a return value less then 0.

Throws:

com.ardikars.jxnet.exception.PcapCloseException - pcap close exception.

pcapDispatch

public <T> com.ardikars.jxnet.PcapCode pcapDispatch(int cnt,
                                                    com.ardikars.jxnet.PcapHandler<T> callback,
                                                    T user,
                                                    java.util.concurrent.Executor executor)
                                             throws com.ardikars.jxnet.exception.PcapCloseException

Description copied from interface: Context

Collect a group of packets.

Specified by:

pcapDispatch in interface Context

Type Parameters:

T - args type.

Parameters:

cnt - maximum iteration, -1 to infinite.

callback - callback function.

user - arg.

executor - executor.

Returns:

PcapDispatch() returns the number of packets processed on success; this can be 0 if no packets were read from a live capture (if, for example, they were discarded because they didn't pass the packet filter, or if, on platforms that support a packet buffer timeout that starts before any packets arrive, the timeout expires before any packets arrive, or if the file descriptor for the capture device is in non-blocking mode and no packets were available to be read) or if no more packets are available in a savefile. It returns -1 if an error occurs or -2 if the loop terminated due to a call to PcapBreakLoop() before any packets were processed. If your application uses PcapBreakLoop(), make sure that you explicitly check for -1 and -2, rather than just checking for a return value less then 0.

Throws:

com.ardikars.jxnet.exception.PcapCloseException - pcap close exception.

pcapDumpOpen

public com.ardikars.jxnet.PcapCode pcapDumpOpen(java.lang.String fname)
                                         throws com.ardikars.jxnet.exception.PcapCloseException

Description copied from interface: Context

Open a file to write packets.

Specified by:

pcapDumpOpen in interface Context

Parameters:

fname - fname specifies the name of the file to open. The file will have the same format as those used by tcpdump(1) and tcpslice(1). The name "-" is a synonym for stdout.

Returns:

pcap code.

Throws:

com.ardikars.jxnet.exception.PcapCloseException - pcap close exception.

pcapDump

public void pcapDump(com.ardikars.jxnet.PcapPktHdr h,
                     java.nio.ByteBuffer sp)
              throws com.ardikars.jxnet.exception.PcapDumperCloseException

Description copied from interface: Context

Save a packet to disk.

Specified by:

pcapDump in interface Context

Parameters:

h - pcap packet header.

sp - packet buffer.

Throws:

com.ardikars.jxnet.exception.PcapDumperCloseException - pcap dumper close exception.

pcapCompile

public com.ardikars.jxnet.PcapCode pcapCompile(java.lang.String str,
                                               com.ardikars.jxnet.BpfProgram.BpfCompileMode optimize,
                                               int netmask)
                                        throws com.ardikars.jxnet.exception.PcapCloseException,
                                               com.ardikars.jxnet.exception.BpfProgramCloseException

Description copied from interface: Context

Compile a packet filter, converting an high level filtering expression (see Filtering expression syntax) in a program that can be interpreted by the kernel-level filtering engine.

Specified by:

pcapCompile in interface Context

Parameters:

str - filter expression.

optimize - optimize (0/1).

netmask - netmask.

Returns:

-1 on error, 0 otherwise.

Throws:

com.ardikars.jxnet.exception.PcapCloseException - pcap close exception.

com.ardikars.jxnet.exception.BpfProgramCloseException - bpf program close exception.

pcapSetFilter

public com.ardikars.jxnet.PcapCode pcapSetFilter()
                                          throws com.ardikars.jxnet.exception.PcapCloseException,
                                                 com.ardikars.jxnet.exception.BpfProgramCloseException

Description copied from interface: Context

Associate a filter to a capture.

Specified by:

pcapSetFilter in interface Context

Returns:

-1 on error, 0 otherwise.

Throws:

com.ardikars.jxnet.exception.PcapCloseException - pcap close exception.

com.ardikars.jxnet.exception.BpfProgramCloseException - bpf program close exception.

pcapSendPacket

public com.ardikars.jxnet.PcapCode pcapSendPacket(java.nio.ByteBuffer buf,
                                                  int size)
                                           throws com.ardikars.jxnet.exception.PcapCloseException

Description copied from interface: Context

Send a raw packet.

Specified by:

pcapSendPacket in interface Context

Parameters:

buf - packet buffer.

size - size of packet buffer.

Returns:

-1 on error, 0 otherwise.

Throws:

com.ardikars.jxnet.exception.PcapCloseException - pcap close exception.

pcapNext

public java.nio.ByteBuffer pcapNext(com.ardikars.jxnet.PcapPktHdr h)
                             throws com.ardikars.jxnet.exception.PcapCloseException

Description copied from interface: Context

Return the next available packet.

Specified by:

pcapNext in interface Context

Parameters:

h - packet header.

Returns:

PcapNext() returns next available packet.

Throws:

com.ardikars.jxnet.exception.PcapCloseException - pcap close exception.

pcapNextEx

public com.ardikars.jxnet.PcapCode pcapNextEx(com.ardikars.jxnet.PcapPktHdr pktHeader,
                                              java.nio.ByteBuffer pktData)
                                       throws com.ardikars.jxnet.exception.PcapCloseException

Description copied from interface: Context

Read a packet from an interface or from an offline capture.

Specified by:

pcapNextEx in interface Context

Parameters:

pktHeader - packet header.

pktData - packet buffer.

Returns:

PcapNextEx() returns 1 if the packet was read without problems, 0 if packets are being read from a live capture and the packet buffer time- out expired, -1 if an error occurred while reading the packet, and -2 if packets are being read from a savefile and there are no more packets to read from the savefile.

Throws:

com.ardikars.jxnet.exception.PcapCloseException - pcap close exception.

pcapClose

public void pcapClose()
               throws com.ardikars.jxnet.exception.PcapCloseException

Description copied from interface: Context

Close the files associated with pcap and deallocates resources.

Specified by:

pcapClose in interface Context

Throws:

com.ardikars.jxnet.exception.PcapCloseException - pcap close exception.

pcapDumpFlush

public com.ardikars.jxnet.PcapCode pcapDumpFlush()
                                          throws com.ardikars.jxnet.exception.PcapDumperCloseException

Description copied from interface: Context

Flushes the output buffer to the savefile, so that any packets written with PcapDump() but not yet written to the savefile will be written. -1 is returned on error, 0 on success.

Specified by:

pcapDumpFlush in interface Context

Returns:

-1 on error, 0 otherwise.

Throws:

com.ardikars.jxnet.exception.PcapDumperCloseException - pcap dumper close exception.

pcapDumpClose

public void pcapDumpClose(com.ardikars.jxnet.PcapDumper pcapDumper)
                   throws com.ardikars.jxnet.exception.PcapDumperCloseException

Description copied from interface: Context

Closes a savefile.

Specified by:

pcapDumpClose in interface Context

Parameters:

pcapDumper - pcap dumper object.

Throws:

com.ardikars.jxnet.exception.PcapDumperCloseException - pcap dumper close exception.

pcapDataLink

public com.ardikars.jxnet.DataLinkType pcapDataLink()
                                             throws com.ardikars.jxnet.exception.PcapCloseException

Description copied from interface: Context

Return the link layer of an adapter on success.

Specified by:

pcapDataLink in interface Context

Returns:

link layer type of an adapter on success and PCAP_ERROR_NOT_ACTIVATED(-3) if called on a capture handle that has been created but not activated.

Throws:

com.ardikars.jxnet.exception.PcapCloseException - pcap close exception.

pcapSetDataLink

public com.ardikars.jxnet.PcapCode pcapSetDataLink(com.ardikars.jxnet.DataLinkType dataLinkType)
                                            throws com.ardikars.jxnet.exception.PcapCloseException

Description copied from interface: Context

Set the current data link type of the pcap descriptor to the type specified by dlt. -1 is returned on failure.

Specified by:

pcapSetDataLink in interface Context

Parameters:

dataLinkType - data link type.

Returns:

-1 on error, 0 otherwise.

Throws:

com.ardikars.jxnet.exception.PcapCloseException - pcap close exception.

pcapBreakLoop

public void pcapBreakLoop()
                   throws com.ardikars.jxnet.exception.PcapCloseException

Description copied from interface: Context

Set a flag that will force PcapDispatch() or PcapLoop() to return rather than looping.

Specified by:

pcapBreakLoop in interface Context

Throws:

com.ardikars.jxnet.exception.PcapCloseException - pcap close exception.

pcapGetErr

public java.lang.String pcapGetErr()
                            throws com.ardikars.jxnet.exception.PcapCloseException

Description copied from interface: Context

Return the error text pertaining to the last pcap library error.

Specified by:

pcapGetErr in interface Context

Returns:

error text pertaining to the last pcap library error.

Throws:

com.ardikars.jxnet.exception.PcapCloseException - pcap close exception.

pcapIsSwapped

public com.ardikars.jxnet.PcapCode pcapIsSwapped()
                                          throws com.ardikars.jxnet.exception.PcapCloseException

Description copied from interface: Context

Returns true (1) if the current savefile uses a different byte order than the current system.

Specified by:

pcapIsSwapped in interface Context

Returns:

PcapIsSwapped() returns true (1) or false (0) on success and PCAP_ERROR_NOT_ACTIVATED(-3) if called on a capture handle that has been created but not activated.

Throws:

com.ardikars.jxnet.exception.PcapCloseException - pcap close exception.

pcapSnapshot

public int pcapSnapshot()
                 throws com.ardikars.jxnet.exception.PcapCloseException

Description copied from interface: Context

Return the dimension of the packet portion (in bytes) that is delivered to the application.

Specified by:

pcapSnapshot in interface Context

Returns:

PcapSnapshot() returns the snapshot length on success and PCAP_ERROR_NOT_ACTIVATED(-3) if called on a capture handle that has been created but not activated.

Throws:

com.ardikars.jxnet.exception.PcapCloseException - pcap close exception.

pcapMajorVersion

public int pcapMajorVersion()
                     throws com.ardikars.jxnet.exception.PcapCloseException

Description copied from interface: Context

Return the major version number of the pcap library used to write the savefile.

Specified by:

pcapMajorVersion in interface Context

Returns:

major version number of the pcap library used to write the savefile.

Throws:

com.ardikars.jxnet.exception.PcapCloseException - pcap close exception.

pcapMinorVersion

public int pcapMinorVersion()
                     throws com.ardikars.jxnet.exception.PcapCloseException

Description copied from interface: Context

Return the minor version number of the pcap library used to write the savefile.

Specified by:

pcapMinorVersion in interface Context

Returns:

minor version number of the pcap library used to write the savefile.

Throws:

com.ardikars.jxnet.exception.PcapCloseException - pcap close exception.

pcapSetNonBlock

public com.ardikars.jxnet.PcapCode pcapSetNonBlock(boolean nonblock,
                                                   java.lang.StringBuilder errbuf)
                                            throws com.ardikars.jxnet.exception.PcapCloseException

Description copied from interface: Context

Switch between blocking and nonblocking mode.

Specified by:

pcapSetNonBlock in interface Context

Parameters:

nonblock - 1 to set non block.

errbuf - error buffer.

Returns:

returns the current non-blocking state of the capture descriptor; it always returns 0 on savefiles. If there is an error, -1 is returned and errbuf is filled in with an appropriate error message.

Throws:

com.ardikars.jxnet.exception.PcapCloseException - pcap close exception.

pcapGetNonBlock

public com.ardikars.jxnet.PcapCode pcapGetNonBlock(java.lang.StringBuilder errbuf)
                                            throws com.ardikars.jxnet.exception.PcapCloseException

Description copied from interface: Context

Get the "non-blocking" state of an interface.

Specified by:

pcapGetNonBlock in interface Context

Parameters:

errbuf - error buffer.

Returns:

PcapGetNonBlock() returns the current non-blocking state of the capture descriptor; it always returns 0 on savefiles.

Throws:

com.ardikars.jxnet.exception.PcapCloseException - pcap close exception.

pcapDumpFTell

public long pcapDumpFTell()
                   throws com.ardikars.jxnet.exception.PcapDumperCloseException

Description copied from interface: Context

Return the file position for a savefile.

Specified by:

pcapDumpFTell in interface Context

Returns:

file position for a savefile.

Throws:

com.ardikars.jxnet.exception.PcapDumperCloseException - pcap dumper close exception.

pcapFreeCode

public void pcapFreeCode()
                  throws com.ardikars.jxnet.exception.BpfProgramCloseException

Description copied from interface: Context

Free a filter.

Specified by:

pcapFreeCode in interface Context

Throws:

com.ardikars.jxnet.exception.BpfProgramCloseException - bpf program close exception.

pcapStats

public com.ardikars.jxnet.PcapCode pcapStats(com.ardikars.jxnet.PcapStat pcapStat)
                                      throws com.ardikars.jxnet.exception.PcapCloseException

Description copied from interface: Context

Return statistics on current capture.

Specified by:

pcapStats in interface Context

Parameters:

pcapStat - pcap stat object.

Returns:

PcapStats() returns 0 on success and returns -1 if there is an error or if pcap handle doesn't support packet statistics.

Throws:

com.ardikars.jxnet.exception.PcapCloseException - pcap close exception.

pcapCompileNoPcap

public com.ardikars.jxnet.PcapCode pcapCompileNoPcap(int snaplen,
                                                     com.ardikars.jxnet.DataLinkType dataLinkType,
                                                     java.lang.String filter,
                                                     com.ardikars.jxnet.BpfProgram.BpfCompileMode optimize,
                                                     com.ardikars.common.net.Inet4Address mask)
                                              throws com.ardikars.jxnet.exception.BpfProgramCloseException

Description copied from interface: Context

Compile a packet filter without the need of opening an adapter. This function converts an high level filtering expression (see Filtering expression syntax) in a program that can be interpreted by the kernel-level filtering engine.

Specified by:

pcapCompileNoPcap in interface Context

Parameters:

snaplen - snapshot length.

dataLinkType - link type.

filter - str.

optimize - optiomize.

mask - netmask.

Returns:

-1 on error.

Throws:

com.ardikars.jxnet.exception.BpfProgramCloseException - bpf program close exception.

pcapPError

public void pcapPError(java.lang.String prefix)
                throws com.ardikars.jxnet.exception.PcapCloseException

Description copied from interface: Context

Print the text of the last pcap library error on stderr, prefixed by prefix.

Specified by:

pcapPError in interface Context

Parameters:

prefix - prefix.

Throws:

com.ardikars.jxnet.exception.PcapCloseException - pcap close exception.

pcapCanSetRfMon

public com.ardikars.jxnet.PcapCode pcapCanSetRfMon()
                                            throws com.ardikars.jxnet.exception.PcapCloseException

Description copied from interface: Context

Checks whether monitor mode could be set on a capture handle when the handle is activated.

Specified by:

pcapCanSetRfMon in interface Context

Returns:

PcapCanSetRfMon() returns 0 if monitor mode could not be set, 1 if monitor mode could be set, and a negative value on error. A negative return value indicates what error condition occurred. The possible error values are: PCAP_ERROR_NO_SUCH_DEVICE(-5): The capture source specified when the handle was created doesn' exist. PCAP_ERROR_PERM_DENIED(-8): The process doesn't have permission to check whether monitor mode could be supported. PCAP_ERROR_ACTIVATED(-3): The capture handle has already been activated. PCAP_ERROR(-1): Generic error.

Throws:

com.ardikars.jxnet.exception.PcapCloseException - pcap close exception.

pcapSetDirection

public com.ardikars.jxnet.PcapCode pcapSetDirection(com.ardikars.jxnet.PcapDirection direction)
                                             throws com.ardikars.jxnet.exception.PcapCloseException,
                                                    com.ardikars.jxnet.exception.PlatformNotSupportedException

Description copied from interface: Context

used to specify a direction that packets will be captured. Direction is one of the constants PCAP_D_IN, PCAP_D_OUT or PCAP_D_INOUT. PCAP_D_IN will only capture packets received by the device, PCAP_D_OUT will only capture packets sent by the device and PCAP_D_INOUT will capture packets received by or sent by the device. PCAP_D_INOUT is the default setting if this function is not called.

PcapSetdirection() isn't necessarily fully supported on all platforms; some platforms might return an error for all values, and some other platforms might not support PCAP_D_OUT.

This operation is not supported if a savefile is being read.

Specified by:

pcapSetDirection in interface Context

Parameters:

direction - direction.

Returns:

returns 0 on success and -1 on failure (not supported by operating system).

Throws:

com.ardikars.jxnet.exception.PcapCloseException - pcap close exception.

com.ardikars.jxnet.exception.PlatformNotSupportedException - platform not supported exception.

pcapGetTStampPrecision

public com.ardikars.jxnet.PcapTimestampPrecision pcapGetTStampPrecision()
                                                                 throws com.ardikars.jxnet.exception.PcapCloseException,
                                                                        com.ardikars.jxnet.exception.PlatformNotSupportedException

Description copied from interface: Context

Get the timestamp precision returned in captures.

Specified by:

pcapGetTStampPrecision in interface Context

Returns:

the precision of the timestamp returned in packet captures on the pcap descriptor.

Throws:

com.ardikars.jxnet.exception.PcapCloseException - pcap close exception.

com.ardikars.jxnet.exception.PlatformNotSupportedException - platform not supported exception.

pcapListDataLinks

public com.ardikars.jxnet.PcapCode pcapListDataLinks(java.util.List<com.ardikars.jxnet.DataLinkType> dtlBuffer)
                                              throws com.ardikars.jxnet.exception.PcapCloseException,
                                                     com.ardikars.jxnet.exception.PlatformNotSupportedException

Description copied from interface: Context

Get list of datalinks.

Specified by:

pcapListDataLinks in interface Context

Parameters:

dtlBuffer - datalinks.

Returns:

list of datalinks.

Throws:

com.ardikars.jxnet.exception.PcapCloseException - pcap close exception.

com.ardikars.jxnet.exception.PlatformNotSupportedException - platform not supported exception.

pcapListTStampTypes

public com.ardikars.jxnet.PcapCode pcapListTStampTypes(java.util.List<com.ardikars.jxnet.PcapTimestampType> tstampTypesp)
                                                throws com.ardikars.jxnet.exception.PcapCloseException,
                                                       com.ardikars.jxnet.exception.PlatformNotSupportedException

Description copied from interface: Context

Get link of time stamp types.

Specified by:

pcapListTStampTypes in interface Context

Parameters:

tstampTypesp - timestamp types.

Returns:

time stamp types.

Throws:

com.ardikars.jxnet.exception.PcapCloseException - pcap close exception.

com.ardikars.jxnet.exception.PlatformNotSupportedException - platform not supported exception.

pcapOfflineFilter

public com.ardikars.jxnet.PcapCode pcapOfflineFilter(com.ardikars.jxnet.BpfProgram fp,
                                                     com.ardikars.jxnet.PcapPktHdr h,
                                                     java.nio.ByteBuffer pkt)

Description copied from interface: Context

Given a BPF program, a PcapPktHdr structure for a packet, and the raw data for the packet, check whether the packet passes the filter. Returns the return value of the filter program, which will be zero if the packet doesn't pass and non-zero if the packet does pass.

Specified by:

pcapOfflineFilter in interface Context

Parameters:

fp - bpfProgram

h - pktHdr

pkt - buffer.

Returns:

0 on success.

pcapInject

public com.ardikars.jxnet.PcapCode pcapInject(java.nio.ByteBuffer buf,
                                              int size)
                                       throws com.ardikars.jxnet.exception.PcapCloseException,
                                              com.ardikars.jxnet.exception.PlatformNotSupportedException

Description copied from interface: Context

Sends a raw packet through the network interface; buf points to the data of the packet, including the link-layer header, and size is the number of bytes in the packet.

Specified by:

pcapInject in interface Context

Parameters:

buf - packet buffer.

size - packet size.

Returns:

PcapInject returns the number of bytes written on success and -1 on failure.

Throws:

com.ardikars.jxnet.exception.PcapCloseException - pcap close exception.

com.ardikars.jxnet.exception.PlatformNotSupportedException - platform not supported exception.