Module org.pcap4j.core

Package org.pcap4j.core

Class BpfProgram

java.lang.Object

org.pcap4j.core.BpfProgram

public final class BpfProgram
extends Object

Since:

pcap4j 0.9.16

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	BpfProgram.BpfCompileMode

Field Summary

Fields

Modifier and Type	Field	Description
private final String	expression
private boolean	freed
private final Object	lock
private final NativeMappings.bpf_program	program

Constructor Summary

Constructors

Constructor	Description
BpfProgram(NativeMappings.bpf_program program, String expression)

Method Summary

Modifier and Type	Method	Description
boolean	applyFilter(byte[] packet)	Apply the filter on a given packet.
boolean	applyFilter(byte[] packet, int orgPacketLen, int packetLen)	Apply the filter on a given packet.
boolean	applyFilter(Packet packet)	Apply the filter on a given packet.
void	free()
String	getExpression()
(package private) NativeMappings.bpf_program	getProgram()
boolean	isFreed()

Methods inherited from class java.lang.Object

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

Field Details

program

private final NativeMappings.bpf_program program

expression

private final String expression

freed

private volatile boolean freed

lock

private final Object lock

Constructor Details

BpfProgram

BpfProgram(NativeMappings.bpf_program program,
 String expression)

Method Details

getProgram

NativeMappings.bpf_program getProgram()

getExpression

public String getExpression()

Returns:

expression

applyFilter

public boolean applyFilter(Packet packet)

Apply the filter on a given packet. Return true if the packet given passes the filter that is built from this program.

Parameters:

packet - the packet to apply the filter on

Returns:

true if this program is not freed and the packet passes the filter; false otherwise.

applyFilter

public boolean applyFilter(byte[] packet)

Apply the filter on a given packet. Return true if the packet given passes the filter that is built from this program.

Parameters:

packet - the packet to apply the filter on

Returns:

true if this program is not freed and the packet passes the filter; false otherwise.

applyFilter

public boolean applyFilter(byte[] packet,
 int orgPacketLen,
 int packetLen)

Apply the filter on a given packet. Return true if the packet given passes the filter that is built from this program.

Parameters:

packet - a byte array including the packet to apply the filter on

orgPacketLen - the length of the original packet

packetLen - the length of the packet present

Returns:

true if this program is not freed and the packet passes the filter; false otherwise.

isFreed

public boolean isFreed()

Returns:

true if the bpf_program represented by this object is freed; false otherwise.

free

public void free()