Module org.jnetpcap

Package org.jnetpcap.internal

Record Class PcapStatRecord

java.lang.Object

java.lang.Record

org.jnetpcap.internal.PcapStatRecord

All Implemented Interfaces:

PcapStat

public record PcapStatRecord(long recv, long drop, long ifdrop, long capt, long sent, long netdrop)
extends Record
implements PcapStat

Packet statistics from the start of the pcap run to the time of the call.

A struct pcap_stat has the following members:

ps_recv

number of packets received;

ps_drop

number of packets dropped because there was no room in the operating system's buffer when they arrived, because packets weren't being read fast enough;

ps_ifdrop

number of packets dropped by the network interface or its driver.

The statistics do not behave the same way on all platforms. ps_recv might count packets whether they passed any filter set with pcap_setfilter(3PCAP) or not, or it might count only packets that pass the filter. It also might, or might not, count packets dropped because there was no room in the operating system's buffer when they arrived. ps_drop is not available on all platforms; it is zero on platforms where it's not available. If packet filtering is done in libpcap, rather than in the operating system, it would count packets that don't pass the filter. Both ps_recv and ps_drop might, or might not, count packets not yet read from the operating system and thus not yet seen by the application. ps_ifdrop might, or might not, be implemented; if it's zero, that might mean that no packets were dropped by the interface, or it might mean that the statistic is unavailable, so it should not be treated as an indication that the interface did not drop any packets.

Author:

Sly Technologies Inc, repos@slytechs.com, mark

Constructor Summary

Constructors

Constructor	Description
PcapStatRecord(long recv, long drop, long ifdrop, long capt, long sent, long netdrop)	Creates an instance of a PcapStatRecord record class.

Method Summary

Modifier and Type	Method	Description
long	capt()	Returns the value of the capt record component.
long	drop()	Returns the value of the drop record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
long	ifdrop()	Returns the value of the ifdrop record component.
long	netdrop()	Returns the value of the netdrop record component.
static PcapStat	ofMemoryPlatformDependent(MemorySegment mseg)	Of memory platform dependent.
long	recv()	Returns the value of the recv record component.
long	sent()	Returns the value of the sent record component.
static long	sizeOf()
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

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

Constructor Details

PcapStatRecord

public PcapStatRecord(long recv,
 long drop,
 long ifdrop,
 long capt,
 long sent,
 long netdrop)

Creates an instance of a PcapStatRecord record class.

Parameters:

recv - the value for the recv record component

drop - the value for the drop record component

ifdrop - the value for the ifdrop record component

capt - the value for the capt record component

sent - the value for the sent record component

netdrop - the value for the netdrop record component

Method Details

sizeOf

public static long sizeOf()

ofMemoryPlatformDependent

public static PcapStat ofMemoryPlatformDependent(MemorySegment mseg)

Of memory platform dependent.

Parameters:

mseg - the mseg

Returns:

the pcap stat

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with '=='.

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

recv

public long recv()

Returns the value of the recv record component.

Specified by:

recv in interface PcapStat

Returns:

the value of the recv record component

drop

public long drop()

Returns the value of the drop record component.

Specified by:

drop in interface PcapStat

Returns:

the value of the drop record component

ifdrop

public long ifdrop()

Returns the value of the ifdrop record component.

Specified by:

ifdrop in interface PcapStat

Returns:

the value of the ifdrop record component

capt

public long capt()

Returns the value of the capt record component.

Specified by:

capt in interface PcapStat

Returns:

the value of the capt record component

sent

public long sent()

Returns the value of the sent record component.

Specified by:

sent in interface PcapStat

Returns:

the value of the sent record component

netdrop

public long netdrop()

Returns the value of the netdrop record component.

Specified by:

netdrop in interface PcapStat

Returns:

the value of the netdrop record component