Module org.jnetpcap

Package org.jnetpcap

Class Pcap1_5

java.lang.Object

org.jnetpcap.Pcap

org.jnetpcap.Pcap0_4

org.jnetpcap.Pcap0_5

org.jnetpcap.Pcap0_6

org.jnetpcap.Pcap0_7

org.jnetpcap.Pcap0_8

org.jnetpcap.Pcap0_9

org.jnetpcap.Pcap1_0

org.jnetpcap.Pcap1_2

org.jnetpcap.Pcap1_5

All Implemented Interfaces:

AutoCloseable

Direct Known Subclasses:

Pcap1_9

public sealed class Pcap1_5
extends Pcap1_2
permits Pcap1_9

Provides Pcap API method calls for up to libpcap version 1.5

Author:

Sly Technologies Inc, repos@slytechs.com, mark

Nested Class Summary

Nested classes/interfaces inherited from class org.jnetpcap.Pcap0_9

Pcap0_9.Linux0_9

Nested classes/interfaces inherited from class org.jnetpcap.Pcap0_8

Pcap0_8.Unix0_8

Nested classes/interfaces inherited from class org.jnetpcap.Pcap0_4

Pcap0_4.PcapSupplier<T extends Pcap>

Nested classes/interfaces inherited from class org.jnetpcap.Pcap

Pcap.LibraryPolicy, Pcap.Linux, Pcap.Unix

Field Summary

Fields inherited from class org.jnetpcap.Pcap0_4

dispatcher

Fields inherited from class org.jnetpcap.Pcap

closed, pcapHeaderABI, POINTER_TO_POINTER1, POINTER_TO_POINTER2, POINTER_TO_POINTER3, VERSION

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Pcap1_5(MemorySegment pcapHandle, String name, PcapHeaderABI abi)	Instantiates a new pcap 150.

Method Summary

Modifier and Type	Method	Description
static Pcap1_5	create(String device)	Create a live capture handle.
final PcapTStampPrecision	getTstampPrecision()	Gets the tstamp precision.
static boolean	isSupported()	Checks if the Pcap subclass at a specific libpcap API version is natively supported.
static Pcap1_5	openDead(PcapDlt linktype, int snaplen)	Open a fake pcap_t for compiling filters or opening a capture for output.
static Pcap1_5	openDeadWithTstampPrecision(PcapDlt linktype, int snaplen, PcapTStampPrecision precision)	Open a fake pcap_t for compiling filters or opening a capture for output.
protected static <T extends Pcap> T	openDeadWithTstampPrecision(Pcap0_4.PcapSupplier<T> factory, PcapDlt linktype, int snaplen, PcapTStampPrecision precision)	Open a fake pcap_t for compiling filters or opening a capture for output.
static Pcap1_5	openLive(String device, int snaplen, boolean promisc, long timeout, TimeUnit unit)	Open a device for capturing.
static Pcap1_5	openOffline(String fname)	Open a saved capture file for reading.
final Pcap1_5	setImmediateMode(boolean enable)	Sets the immediate mode.
final Pcap	setTstampPrecision(PcapTStampPrecision precision)	Sets the tstamp precision.

Methods inherited from class org.jnetpcap.Pcap1_2

listTstampTypes, setTstampType

Methods inherited from class org.jnetpcap.Pcap1_0

activate, canSetRfmon, create, dataLinkExt, init, offlineFilter, setBufferSize, setPromisc, setPromisc, setRfmon, setRfmon, setSnaplen, setTimeout, statusToStr

Methods inherited from class org.jnetpcap.Pcap0_9

inject, setDirection, setProtocolLinux

Methods inherited from class org.jnetpcap.Pcap0_8

breakloop, datalinkNameToVal, dataLinkValToDescription, dataLinkValToName, getSelectableFd, libVersion, listDataLinks, nextEx, sendPacket, setDatalink

Methods inherited from class org.jnetpcap.Pcap0_7

findAllDevs, getNonBlock, setNonBlock

Methods inherited from class org.jnetpcap.Pcap0_6

openDead

Methods inherited from class org.jnetpcap.Pcap0_5

compileNoPcap

Methods inherited from class org.jnetpcap.Pcap0_4

close, compile, datalink, datalinkGetAsInt, dispatch, dispatch, dispatch, dispatch, dumpOpen, file, fileno, getDispatcher, geterr, isInitialized, isSwapped, lookupDev, lookupNet, loop, loop, loop, loop, majorVersion, minorVersion, next, openLive, openOffline, perror, setDispatcher, setFilter, setUncaughtExceptionHandler, snapshot, stats, strerror

Methods inherited from class org.jnetpcap.Pcap

checkPcapVersion, compile, create, datalinkValToDescription, datalinkValToName, findAllDevsEx, getErrorString, getName, getPcapHandle, getPcapHeaderABI, init, inject, inject, inject, listAllPcapIf, loadNativePcapLibrary, lookupErrorString, lookupNet, newArena, openLive, openLive, openOffline, order, sendPacket, sendPacket, sendPacket, setDatalink, setDatalink, setDirection, setDirection, setFilter, setUncaughtExceptionHandler, statusToStr, toString

Methods inherited from class java.lang.Object

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

Constructor Details

Pcap1_5

protected Pcap1_5(MemorySegment pcapHandle,
 String name,
 PcapHeaderABI abi)

Instantiates a new pcap 150.

Parameters:

pcapHandle - the pcap handle

name - the handle name

abi - the abi

Method Details

create

public static Pcap1_5 create(String device)
                      throws PcapException

Create a live capture handle. create is used to create a packet capture handle to look at packets on the network. source is a string that specifies the network device to open; on Linux systems with 2.2 or later kernels, a source argument of "any" or NULL can be used to capture packets from all interfaces. The returned handle must be activated with pcap_activate() before pack' ets can be captured with it; options for the capture, such as promiscu' ous mode, can be set on the handle before activating it.

Parameters:

device - a string that specifies the network device to open; on Linux systems with 2.2 or later kernels, a source argument of "any" or NULL can be used to capture packets from all interfaces.

Returns:

a new pcap object that needs to be activated using Pcap1_0.activate() call

Throws:

PcapException - the pcap exception

Since:

libpcap 1.0

isSupported

public static boolean isSupported()

Checks if the Pcap subclass at a specific libpcap API version is natively supported. This is a safe method to use anytime on any platform, weather native library is present or not.

For example, Pcap1_0.isSupported() will accurately ascertain if libpcap API version 1.0 level calls are supported by the system runtime. Also a call such as WinPcap.isSupported() will determine if WinPcap related calls, ie. native WinPcap 4.1.3 or less, are supported and by extension if this is a Microsoft Windows platform.

Due to libpcap API versioning, it is safe to assume that if Pcap1_10.isSupported() returns true, that at least libpcap API version 1.0 is installed on this platform, and that all lower version calls such as libpcap 0.8 and 0.9 are available as well. The subclass hierarchy of jNetPcap module reflects the versioning of libpcap and its derivatives and the public releases of the native libraries. For example Npcap class extends WinPcap class because Npcap project took over the support for WinPcap where it left off.

Implementation notes: The check is performed by verifying that certain, subclass specific native symbols were linked with Pcap full which was introduced at a specific libpcap or related API levels.

Returns:

true, if pcap is supported up to this specific version level, otherwise false

See Also:

• Pcap.LibraryPolicy.setDefault(LibraryPolicy)

openDead

public static Pcap1_5 openDead(PcapDlt linktype,
 int snaplen)
                        throws PcapException

Open a fake pcap_t for compiling filters or opening a capture for output.

openDead(org.jnetpcap.constant.PcapDlt, int) and pcap_open_dead_with_tstamp_precision() are used for creating a pcap_t structure to use when calling the other functions in libpcap. It is typically used when just using libpcap for compiling BPF full; it can also be used if using pcap_dump_open(3PCAP), pcap_dump(3PCAP), and pcap_dump_close(3PCAP) to write a savefile if there is no pcap_t that supplies the packets to be written.

When pcap_open_dead_with_tstamp_precision(), is used to create a pcap_t for use with pcap_dump_open(), precision specifies the time stamp precision for packets; PCAP_TSTAMP_PRECISION_MICRO should be specified if the packets to be written have time stamps in seconds and microseconds, and PCAP_TSTAMP_PRECISION_NANO should be specified if the packets to be written have time stamps in seconds and nanoseconds. Its value does not affect pcap_compile(3PCAP).

Parameters:

linktype - specifies the link-layer type for the pcap handle

snaplen - specifies the snapshot length for the pcap handle

Returns:

A dead pcap handle

Throws:

PcapException - any errors

Since:

libpcap 0.6

openDeadWithTstampPrecision

public static Pcap1_5 openDeadWithTstampPrecision(PcapDlt linktype,
 int snaplen,
 PcapTStampPrecision precision)
                                           throws PcapException

Open a fake pcap_t for compiling filters or opening a capture for output.

Pcap.openDead(PcapDlt, int) and Pcap.openDeadWithTstampPrecision(PcapDlt, int, PcapTStampPrecision) are used for creating a pcap_t structure to use when calling the other functions in libpcap. It is typically used when just using libpcap for compiling BPF full; it can also be used if using pcap_dump_open(3PCAP), pcap_dump(3PCAP), and pcap_dump_close(3PCAP) to write a savefile if there is no pcap_t that supplies the packets to be written.

When pcap_open_dead_with_tstamp_precision(), is used to create a pcap_t for use with pcap_dump_open(), precision specifies the time stamp precision for packets; PCAP_TSTAMP_PRECISION_MICRO should be specified if the packets to be written have time stamps in seconds and microseconds, and PCAP_TSTAMP_PRECISION_NANO should be specified if the packets to be written have time stamps in seconds and nanoseconds. Its value does not affect pcap_compile(3PCAP).

Parameters:

linktype - specifies the link-layer type for the pcap handle

snaplen - specifies the snapshot length for the pcap handle

precision - the timestamp precision requested

Returns:

A dead pcap handle

Throws:

PcapException - any errors

Since:

libpcap 1.5.1

openDeadWithTstampPrecision

protected static <T extends Pcap> T openDeadWithTstampPrecision(Pcap0_4.PcapSupplier<T> factory,
 PcapDlt linktype,
 int snaplen,
 PcapTStampPrecision precision)
                                                         throws PcapException

Open a fake pcap_t for compiling filters or opening a capture for output.

openDead(org.jnetpcap.constant.PcapDlt, int) and pcap_open_dead_with_tstamp_precision() are used for creating a pcap_t structure to use when calling the other functions in libpcap. It is typically used when just using libpcap for compiling BPF full; it can also be used if using pcap_dump_open(3PCAP), pcap_dump(3PCAP), and pcap_dump_close(3PCAP) to write a savefile if there is no pcap_t that supplies the packets to be written.

When pcap_open_dead_with_tstamp_precision(), is used to create a pcap_t for use with pcap_dump_open(), precision specifies the time stamp precision for packets; PCAP_TSTAMP_PRECISION_MICRO should be specified if the packets to be written have time stamps in seconds and microseconds, and PCAP_TSTAMP_PRECISION_NANO should be specified if the packets to be written have time stamps in seconds and nanoseconds. Its value does not affect pcap_compile(3PCAP).

Type Parameters:

T - the generic factory type

Parameters:

factory - the pcap instance factory

linktype - specifies the link-layer type for the pcap handle

snaplen - specifies the snapshot length for the pcap handle

precision - the precision

Returns:

A dead pcap handle

Throws:

PcapException - any errors

Since:

libpcap 1.5.1

openLive

public static Pcap1_5 openLive(String device,
 int snaplen,
 boolean promisc,
 long timeout,
 TimeUnit unit)
                        throws PcapException

Open a device for capturing.

openLive is used to obtain a packet capture handle to look at packets on the network. device is a string that specifies the network device to open; on Linux systems with 2.2 or later kernels, a device argument of "any" or NULL can be used to capture packets from all interfaces.

Parameters:

device - the device name

snaplen - specifies the snapshot length to be set on the handle

promisc - specifies whether the interface is to be put into promiscuous mode. If promisc is non-zero, promiscuous mode will be set, otherwise it will not be set

timeout - the packet buffer timeout, as a non-negative value, in units

unit - time timeout unit

Returns:

the pcap handle

Throws:

PcapException - any errors

Since:

libpcap 0.4

openOffline

public static Pcap1_5 openOffline(String fname)
                           throws PcapException

Open a saved capture file for reading.

pcap_open_offline() and pcap_open_offline_with_tstamp_precision() are called to open a ``savefile'' for reading.

Parameters:

fname - specifies the name of the file to open. The file can have the pcap file format as described in pcap-savefile(5), which is the file format used by, among other programs, tcpdump(1) and tcpslice(1), or can have the pcapng file format, although not all pcapng files can be read

Returns:

the pcap handle

Throws:

PcapException - any errors

Since:

libpcap 0.4

getTstampPrecision

public final PcapTStampPrecision getTstampPrecision()
                                             throws PcapException

Gets the tstamp precision.

Overrides:

getTstampPrecision in class Pcap

Returns:

the tstamp precision

Throws:

PcapException - the pcap exception

See Also:

• Pcap.getTstampPrecision()

setImmediateMode

public final Pcap1_5 setImmediateMode(boolean enable)
                               throws PcapException

Sets the immediate mode.

Overrides:

setImmediateMode in class Pcap

Parameters:

enable - the enable

Returns:

the pcap 1 5

Throws:

PcapException - the pcap exception

See Also:

• Pcap.setImmediateMode(boolean)

setTstampPrecision

public final Pcap setTstampPrecision(PcapTStampPrecision precision)
                              throws PcapException

Sets the tstamp precision.

Overrides:

setTstampPrecision in class Pcap

Parameters:

precision - the precision

Returns:

the pcap

Throws:

PcapException - the pcap exception

See Also:

• Pcap.setTstampPrecision(org.jnetpcap.constant.PcapTStampPrecision)