Module org.pcap4j.core

Package org.pcap4j.core

Class PcapNetworkInterface

java.lang.Object

org.pcap4j.core.PcapNetworkInterface

public final class PcapNetworkInterface
extends java.lang.Object

Since:

pcap4j 0.9.1

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PcapNetworkInterface.PromiscuousMode

Field Summary

Fields

Modifier and Type	Field	Description
private java.util.List<PcapAddress>	addresses
private java.lang.String	description
private java.util.List<LinkLayerAddress>	linkLayerAddresses
private boolean	local
private static org.slf4j.Logger	logger
private boolean	loopBack
private java.lang.String	name
private static int	PCAP_IF_LOOPBACK
private static int	PCAP_IF_RUNNING
private static int	PCAP_IF_UP
private boolean	running
private boolean	up

Constructor Summary

Constructors

Modifier	Constructor	Description
private	PcapNetworkInterface(NativeMappings.pcap_if pif, boolean local)

Method Summary

Modifier and Type	Method	Description
boolean	equals(java.lang.Object obj)
java.util.List<PcapAddress>	getAddresses()
java.lang.String	getDescription()
java.util.ArrayList<LinkLayerAddress>	getLinkLayerAddresses()
private MacAddress	getMacAddress(java.lang.String nifName)
java.lang.String	getName()
int	hashCode()
boolean	isLocal()
boolean	isLoopBack()	Returns if this network interface is loopback.
boolean	isRunning()	Returns if this network interface is running.
boolean	isUp()	Returns if this network interface is up.
(package private) static PcapNetworkInterface	newInstance(NativeMappings.pcap_if pif, boolean local)
PcapHandle	openLive(int snaplen, PcapNetworkInterface.PromiscuousMode mode, int timeoutMillis)
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

logger

private static final org.slf4j.Logger logger

PCAP_IF_LOOPBACK

private static final int PCAP_IF_LOOPBACK

See Also:

Constant Field Values

PCAP_IF_UP

private static final int PCAP_IF_UP

See Also:

Constant Field Values

PCAP_IF_RUNNING

private static final int PCAP_IF_RUNNING

See Also:

Constant Field Values

name

private final java.lang.String name

description

private final java.lang.String description

addresses

private final java.util.List<PcapAddress> addresses

linkLayerAddresses

private final java.util.List<LinkLayerAddress> linkLayerAddresses

loopBack

private final boolean loopBack

up

private final boolean up

running

private final boolean running

local

private final boolean local

Constructor Detail

PcapNetworkInterface

private PcapNetworkInterface(NativeMappings.pcap_if pif,
                             boolean local)

Method Detail

newInstance

static PcapNetworkInterface newInstance(NativeMappings.pcap_if pif,
                                        boolean local)

getName

public java.lang.String getName()

Returns:

name

getDescription

public java.lang.String getDescription()

Returns:

description

getAddresses

public java.util.List<PcapAddress> getAddresses()

Returns:

inet addresses

getLinkLayerAddresses

public java.util.ArrayList<LinkLayerAddress> getLinkLayerAddresses()

Returns:

link layer addresses

isLoopBack

public boolean isLoopBack()

Returns if this network interface is loopback. This method may always return false on some environments.

Returns:

true if the network interface represented by this object is a loop back interface; false otherwise.

isUp

public boolean isUp()

Returns if this network interface is up. This method may always return false on some environments.

Returns:

true if the network interface represented by this object is up; false otherwise.

isRunning

public boolean isRunning()

Returns if this network interface is running. This method may always return false on some environments.

Returns:

true if the network interface represented by this object is running; false otherwise.

isLocal

public boolean isLocal()

Returns:

true if the network interface represented by this object is a local interface; false otherwise.

openLive

public PcapHandle openLive(int snaplen,
                           PcapNetworkInterface.PromiscuousMode mode,
                           int timeoutMillis)
                    throws PcapNativeException

Parameters:

snaplen - Snapshot length, which is the number of bytes captured for each packet.

mode - mode

timeoutMillis - Read timeout. Most OSs buffer packets. The OSs pass the packets to Pcap4j after the buffer gets full or the read timeout expires. Must be non-negative. May be ignored by some OSs. 0 means disable buffering on Solaris. 0 means infinite on the other OSs. 1 through 9 means infinite on Solaris.

Returns:

a new PcapHandle object.

Throws:

PcapNativeException - if an error occurs in the pcap native library.

getMacAddress

private MacAddress getMacAddress(java.lang.String nifName)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object