com.ardikars.jxnet

Interface Context

All Known Implementing Classes:

ApplicationContext

public interface Context

Method Summary

Modifier and Type	Method and Description
void	addLibrary(com.ardikars.common.util.Loader libraryLoader)
java.lang.String	getApplicationName()
java.lang.String	getApplicationVersion()
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, int 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, boolean 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.
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.
int	pcapGetTStampPrecision() Get the time stamp 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<java.lang.Integer> dtlBuffer) Get list of datalinks.
com.ardikars.jxnet.PcapCode	pcapListTStampTypes(java.util.List<java.lang.Integer> 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.
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.

Method Detail

getApplicationName

java.lang.String getApplicationName()

getApplicationVersion

java.lang.String getApplicationVersion()

addLibrary

void addLibrary(com.ardikars.common.util.Loader libraryLoader)

pcapLoop

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

Collect a group of packets. Callback argument already asyncronous.

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

Throws:

com.ardikars.jxnet.exception.PcapCloseException - pcap close exception. 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.

Since:

1.1.4

pcapDispatch

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

Collect a group of packets.

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;

Throws:

com.ardikars.jxnet.exception.PcapCloseException - pcap close exception. 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.

Since:

1.1.4

pcapDumpOpen

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

Open a file to write packets.

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.

Since:

1.1.4

pcapDump

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

Save a packet to disk.

Parameters:

h - pcap packet header.

sp - packet buffer.

Throws:

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

Since:

1.1.4

pcapCompile

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

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.

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.

Since:

1.1.4

pcapSetFilter

com.ardikars.jxnet.PcapCode pcapSetFilter()
                                   throws com.ardikars.jxnet.exception.PcapCloseException

Associate a filter to a capture.

Returns:

-1 on error, 0 otherwise.

Throws:

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

Since:

1.1.4

pcapSendPacket

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

Send a raw packet.

Parameters:

buf - packet buffer.

size - size of packet buffer.

Returns:

-1 on error, 0 otherwise.

Throws:

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

Since:

1.1.4

pcapNext

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

Return the next available packet.

Parameters:

h - packet header.

Returns:

PcapNext() returns next available packet.

Throws:

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

Since:

1.1.4

pcapNextEx

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

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

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.

Since:

1.1.4

pcapClose

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

Close the files associated with pcap and deallocates resources.

Throws:

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

Since:

1.1.4

pcapDumpFlush

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

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.

Returns:

-1 on error, 0 otherwise.

Throws:

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

Since:

1.1.4

pcapDumpClose

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

Closes a savefile.

Parameters:

pcapDumper - pcap dumper object.

Throws:

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

Since:

1.1.4

pcapDataLink

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

Return the link layer of an adapter on success.

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.

Since:

1.1.4

pcapSetDataLink

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

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

Parameters:

dataLinkType - data link type.

Returns:

-1 on error, 0 otherwise.

Throws:

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

Since:

1.1.4

pcapBreakLoop

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

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

Throws:

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

Since:

1.1.4

pcapGetErr

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

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

Returns:

error text pertaining to the last pcap library error.

Throws:

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

Since:

1.1.4

pcapIsSwapped

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

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

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.

Since:

1.1.4

pcapSnapshot

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

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

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.

Since:

1.1.4

pcapMajorVersion

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

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

Returns:

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

Throws:

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

Since:

1.1.4

pcapMinorVersion

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

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

Returns:

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

Throws:

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

Since:

1.1.4

pcapSetNonBlock

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

Switch between blocking and nonblocking mode.

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.

Since:

1.1.4

pcapGetNonBlock

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

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

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.

Since:

1.1.4

pcapDumpFTell

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

Return the file position for a savefile.

Returns:

file position for a savefile.

Throws:

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

Since:

1.1.4

pcapFreeCode

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

Free a filter.

Throws:

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

Since:

1.1.4

pcapStats

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

Return statistics on current capture.

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.

Since:

1.1.4

pcapCompileNoPcap

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

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.

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.

Since:

1.1.4

pcapPError

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

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

Parameters:

prefix - prefix.

Throws:

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

Since:

1.1.4

pcapCanSetRfMon

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

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

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.

Since:

1.1.4

pcapSetDirection

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

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.

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.

Since:

1.1.4

pcapGetTStampPrecision

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

Get the time stamp precision returned in captures.

Returns:

the precision of the time stamp 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

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

Get list of datalinks.

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

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

Get link of time stamp types.

Parameters:

tstampTypesp - time stamp types.

Returns:

time stamp types.

Throws:

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

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

pcapOfflineFilter

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. 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.

Parameters:

fp - bpfProgram

h - pktHdr

pkt - buffer.

Returns:

0 on success.

pcapInject

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

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.

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.