org.pcap4j.core

Class PcapNetworkInterface

java.lang.Object

org.pcap4j.core.PcapNetworkInterface

public final class PcapNetworkInterface
extends Object

Since:

pcap4j 0.9.1

Author:

Kaito Yamada

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PcapNetworkInterface.PromiscuousMode

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
List<PcapAddress>	getAddresses()
String	getDescription()
ArrayList<LinkLayerAddress>	getLinkLayerAddresses()
String	getName()
int	hashCode()
boolean	isLocal()
boolean	isLoopBack()
PcapHandle	openLive(int snaplen, PcapNetworkInterface.PromiscuousMode mode, int timeoutMillis)
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

getName

public String getName()

Returns:

name

getDescription

public String getDescription()

Returns:

description

getAddresses

public List<PcapAddress> getAddresses()

Returns:

inet addresses

getLinkLayerAddresses

public ArrayList<LinkLayerAddress> getLinkLayerAddresses()

Returns:

link layer addresses

isLoopBack

public boolean isLoopBack()

Returns:

true if the network interface represented by this object is a loop back interface; 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.

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object