Package pcap.api.internal

Class Pcap

java.lang.Object

pcap.api.internal.Pcap

All Implemented Interfaces:

java.lang.AutoCloseable, Pcap

@Inclubating
public class Pcap
extends java.lang.Object
implements Pcap

Pcap handle.

Author:

Ardika Rommy Sanjaya

Nested Class Summary

Nested classes/interfaces inherited from interface pcap.spi.Pcap

Pcap.Direction

Constructor Summary

Constructors

Constructor	Description
Pcap(java.foreign.memory.Pointer<pcap_mapping.pcap> pcap)
Pcap(java.foreign.memory.Pointer<pcap_mapping.pcap> pcap, int netmask)

Method Summary

Modifier and Type	Method	Description
void	breakLoop()	Force a loop(int, PacketHandler, Object) call to return And throw BreakException on loop(int, PacketHandler, Object).
void	close()	Close PcapLive or PcapOffline.
<T> void	dispatch(int count, PacketHandler<T> handler, T args)
Dumper	dumpOpen(java.lang.String file)	Open Dumper handler.
Dumper	dumpOpenAppend(java.lang.String file)	Append packet buffer on existing pcap file.
<T> void	loop(int count, PacketHandler<T> handler, T args)	Process packets from a live PcapLive or PcapOffline.
void	send(java.nio.ByteBuffer buffer)	Sends a raw packet through the network interface.
void	send(java.nio.ByteBuffer buffer, int size)	Sends a raw packet through the network interface.
void	setDirection(Pcap.Direction direction)
void	setFilter(java.lang.String filter, boolean optimize)	BPF packet filter.
Status	status()	Represent packet statistics from the start of the run to the time of the call.

Methods inherited from class java.lang.Object

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

Constructor Details

Pcap

public Pcap(java.foreign.memory.Pointer<pcap_mapping.pcap> pcap)

Pcap

public Pcap(java.foreign.memory.Pointer<pcap_mapping.pcap> pcap, int netmask)

Method Details

dumpOpen

public Dumper dumpOpen(java.lang.String file) throws ErrorException

Open Dumper handler.

Specified by:

dumpOpen in interface Pcap

Parameters:

file - location of capture file will saved.

Returns:

returns Pcap Dumper handle.

Throws:

ErrorException

dumpOpenAppend

public Dumper dumpOpenAppend(java.lang.String file) throws ErrorException

Append packet buffer on existing pcap file.

Specified by:

dumpOpenAppend in interface Pcap

Parameters:

file - location of saved file.

Returns:

returns Pcap Dumper handle.

Throws:

ErrorException - generic error.

setFilter

public void setFilter(java.lang.String filter, boolean optimize) throws ErrorException

BPF packet filter.

Specified by:

setFilter in interface Pcap

Parameters:

filter - filter expression.

optimize - true for optimized filter, false otherwise.

Throws:

ErrorException - generic error.

loop

public <T> void loop(int count, PacketHandler<T> handler, T args) throws BreakException, ErrorException

Process packets from a live PcapLive or PcapOffline.

Specified by:

loop in interface Pcap

Type Parameters:

T - args type.

Parameters:

count - maximum number of packets to process before returning. A value of -1 or 0 for cnt is equivalent to infinity, so that packets are processed until another ending condition occurs.

handler - PacketHandler callback function.

args - user args.

Throws:

BreakException - breakLoop() is called.

ErrorException - Generic error.

dispatch

public <T> void dispatch(int count, PacketHandler<T> handler, T args) throws BreakException, ErrorException

Specified by:

dispatch in interface Pcap

Throws:

BreakException

ErrorException

status

public Status status() throws ErrorException

Represent packet statistics from the start of the run to the time of the call.

Supported only on live captures, not on PcapOffline; no statistics are stored in PcapOffline so no statistics are available when reading from a PcapOffline

Specified by:

status in interface Pcap

Returns:

returns Status on success.

Throws:

ErrorException - There is an error or if this Pcap doesn't support packet statistics.

breakLoop

public void breakLoop()

Force a loop(int, PacketHandler, Object) call to return And throw BreakException on loop(int, PacketHandler, Object).

Specified by:

breakLoop in interface Pcap

send

public void send(java.nio.ByteBuffer buffer) throws ErrorException

Sends a raw packet through the network interface.

Parameters:

buffer - the data of the packet, including the link-layer header.

Throws:

ErrorException - generic error.

send

public void send(java.nio.ByteBuffer buffer, int size) throws ErrorException

Sends a raw packet through the network interface.

Specified by:

send in interface Pcap

Parameters:

buffer - the data of the packet, including the link-layer header.

size - the number of bytes in the packet.

Throws:

ErrorException - generic error.

setDirection

public void setDirection(Pcap.Direction direction) throws ErrorException

Specified by:

setDirection in interface Pcap

Throws:

ErrorException

close

public void close()

Close PcapLive or PcapOffline. Note: BPF handle will closed automaticly.

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in interface Pcap