Package org.pcap4j.packet

Class PppPacket

java.lang.Object

org.pcap4j.packet.AbstractPacket

org.pcap4j.packet.PppPacket

All Implemented Interfaces:

java.io.Serializable, java.lang.Iterable<Packet>, Packet

public class PppPacket
extends AbstractPacket

https://tools.ietf.org/html/rfc1661

Since:

pcap4j 1.4.0

Author:

Kaito Yamada

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PppPacket.Builder
static class	PppPacket.PppHeader

Nested classes/interfaces inherited from class org.pcap4j.packet.AbstractPacket

AbstractPacket.AbstractBuilder, AbstractPacket.AbstractHeader

Nested classes/interfaces inherited from interface org.pcap4j.packet.Packet

Packet.Header

Method Summary

Modifier and Type	Method	Description
protected byte[]	buildRawData()	This method builds the value getRawData() will return by concatenating the header's raw data and the payload's raw data.
protected java.lang.String	buildString()	This method builds the value toString() will return by concatenating the header's string representation and the payload's string representation.
protected int	calcHashCode()	This method calculates the value hashCode() will return using the header's hash code and the payload's hash code.
protected int	calcLength()	This method calculates the value length() will return by adding up the header length and the payload length.
boolean	equals(java.lang.Object obj)	Indicates whether some other object is "equal to" this one.
PppPacket.Builder	getBuilder()	Returns a new Builder object populated with this object's fields' values.
PppPacket.PppHeader	getHeader()	Returns the Header object representing this packet's header.
byte[]	getPad()
Packet	getPayload()	Returns the Packet object representing this packet's payload.
static PppPacket	newPacket(byte[] rawData, int offset, int length)	A static factory method.

Methods inherited from class org.pcap4j.packet.AbstractPacket

buildHexString, getRawData, hashCode, length, toHexString, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface org.pcap4j.packet.Packet

contains, get, getOuterOf, iterator

Method Detail

newPacket

public static PppPacket newPacket(byte[] rawData,
                                  int offset,
                                  int length)
                           throws IllegalRawDataException

A static factory method. This method validates the arguments by ByteArrays.validateBounds(byte[], int, int), which may throw exceptions undocumented here.

Parameters:

rawData - rawData

offset - offset

length - length

Returns:

a new PppPacket object.

Throws:

IllegalRawDataException - if parsing the raw data fails.

getHeader

public PppPacket.PppHeader getHeader()

Description copied from class: AbstractPacket

Returns the Header object representing this packet's header. This subclass have to override this method if the packet represented by the subclass has a header.

Specified by:

getHeader in interface Packet

Returns:

the Header object representing this packet's header. May be null if the header doesn't exist

getBuilder

public PppPacket.Builder getBuilder()

Description copied from interface: Packet

Returns a new Builder object populated with this object's fields' values.

Specified by:

getBuilder in interface Packet

Specified by:

getBuilder in class AbstractPacket

Returns:

a new Builder object populated with this object's fields values

getPayload

public Packet getPayload()

Description copied from class: AbstractPacket

Returns the Packet object representing this packet's payload. This subclass have to override this method if the packet represented by the subclass has a payload.

Specified by:

getPayload in interface Packet

Overrides:

getPayload in class AbstractPacket

Returns:

the Packet object representing this packet's payload. May be null if the payload doesn't exist

getPad

public byte[] getPad()

Returns:

pad

calcLength

protected int calcLength()

Description copied from class: AbstractPacket

This method calculates the value length() will return by adding up the header length and the payload length. If you write this subclass which represents a packet with extra parts (e.g. a trailer), you need to override this method.

Overrides:

calcLength in class AbstractPacket

Returns:

a calculated length

buildRawData

protected byte[] buildRawData()

Description copied from class: AbstractPacket

This method builds the value getRawData() will return by concatenating the header's raw data and the payload's raw data. If you write this subclass which represents a packet with extra parts (e.g. a trailer), you need to override this method.

Overrides:

buildRawData in class AbstractPacket

Returns:

a raw data built

buildString

protected java.lang.String buildString()

Description copied from class: AbstractPacket

This method builds the value toString() will return by concatenating the header's string representation and the payload's string representation. If you write this subclass which represents a packet with extra parts (e.g. a trailer), you need to override this method.

Overrides:

buildString in class AbstractPacket

Returns:

a string representation of this object

equals

public boolean equals(java.lang.Object obj)

Description copied from class: AbstractPacket

Indicates whether some other object is "equal to" this one. This method firstly compares this packet's header using the header's equals(Object) method, then compares this packet's payload using the payload's equals(Object) method. If you write this subclass with fields which represent somethings other than header or payload, you need to override this method.

Overrides:

equals in class AbstractPacket

calcHashCode

protected int calcHashCode()

Description copied from class: AbstractPacket

This method calculates the value hashCode() will return using the header's hash code and the payload's hash code. If you write this subclass which represents a packet with extra parts (e.g. a trailer), you need to override this method.

Overrides:

calcHashCode in class AbstractPacket

Returns:

a calculated hash code value for the object