java.lang.Object
- org.pcap4j.packet.AbstractPacket.AbstractHeader
- - org.pcap4j.packet.GtpV1Packet.GtpV1Header

All Implemented Interfaces:: java.io.Serializable, Packet.Header

Enclosing class:: GtpV1Packet

public static final class GtpV1Packet.GtpV1Header
extends AbstractPacket.AbstractHeader

GTPv1 Header

    8     7     6     5     4     3     2     1
 +-----+-----+-----+-----+-----+-----+-----+-----+
 |    Version      | PT  | (*) |  E  |  S  | PN  |
 +-----+-----+-----+-----+-----+-----+-----+-----+
 |                 Message Type                  |
 +-----+-----+-----+-----+-----+-----+-----+-----+
 |              Length (1st Octet)               |
 +-----+-----+-----+-----+-----+-----+-----+-----+
 |              Length (2nd Octet)               |
 +-----+-----+-----+-----+-----+-----+-----+-----+
 |    Tunnel Endpoint Identifier (1st Octet)     |
 +-----+-----+-----+-----+-----+-----+-----+-----+
 |    Tunnel Endpoint Identifier (2nd Octet)     |
 +-----+-----+-----+-----+-----+-----+-----+-----+
 |    Tunnel Endpoint Identifier (3rd Octet)     |
 +-----+-----+-----+-----+-----+-----+-----+-----+
 |    Tunnel Endpoint Identifier (4th Octet)     |
 +-----+-----+-----+-----+-----+-----+-----+-----+
 |          Sequence Number (1st Octet)          |
 +-----+-----+-----+-----+-----+-----+-----+-----+
 |          Sequence Number (2nd Octet)          |
 +-----+-----+-----+-----+-----+-----+-----+-----+
 |                 N-PDU Number                  |
 +-----+-----+-----+-----+-----+-----+-----+-----+
 |          Next Extension Header Type           |
 +-----+-----+-----+-----+-----+-----+-----+-----+

Since:: pcap4j 1.6.6
See Also:: ETSI TS 129 060 V12.6.0, Serialized Form

Field Summary

Fields
Modifier and Type	Field	Description
`private boolean`	`extensionHeaderFlag`
`private static int`	`FIRST_OCTET_OFFSET`
`private static int`	`FIRST_OCTET_SIZE`
`private static int`	`GTP_V1_HEADER_MAX_SIZE`
`private static int`	`GTP_V1_HEADER_MIM_SIZE`
`private short`	`length`
`private static int`	`LENGTH_OFFSET`
`private static int`	`LENGTH_SIZE`
`private GtpV1MessageType`	`messageType`
`private static int`	`MSG_TYPE_OFFSET`
`private static int`	`MSG_TYPE_SIZE`
`private static int`	`NEXT_HEADER_OFFSET`
`private static int`	`NEXT_HEADER_SIZE`
`private GtpV1ExtensionHeaderType`	`nextExtensionHeaderType`
`private static int`	`NPDU_OFFSET`
`private static int`	`NPDU_SIZE`
`private java.lang.Byte`	`nPduNumber`
`private boolean`	`nPduNumberFlag`
`private GtpV1Packet.ProtocolType`	`protocolType`
`private boolean`	`reserved`
`private static int`	`SEQ_OFFSET`
`private static int`	`SEQ_SIZE`
`private java.lang.Short`	`sequenceNumber`
`private boolean`	`sequenceNumberFlag`
`private static long`	`serialVersionUID`
`private int`	`teid`
`private static int`	`TUNNEL_ID_OFFSET`
`private static int`	`TUNNEL_ID_SIZE`
`private GtpVersion`	`version`

Constructor Summary

Constructors
Modifier	Constructor	Description
`private`	`GtpV1Header(byte[] rawData, int offset, int length)`
`private`	`GtpV1Header(GtpV1Packet.Builder builder, int payloadLen)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected java.lang.String`	`buildString()`	This method builds the value `toString()` will return.
`protected int`	`calcHashCode()`	This method builds the value `hashCode()` will return using the byte array `getRawData()` returns.
`protected int`	`calcLength()`	This method calculates the value `length()` will return by adding up the lengths of byte arrays in the list `getRawFields()` returns.
`boolean`	`equals(java.lang.Object obj)`	Indicates whether some other object is "equal to" this one using return values of `getRawData()`.
`short`	`getLength()`
`int`	`getLengthAsInt()`
`GtpV1MessageType`	`getMessageType()`
`GtpV1ExtensionHeaderType`	`getNextExtensionHeaderType()`
`java.lang.Byte`	`getNPduNumber()`
`java.lang.Integer`	`getNPduNumberAsInt()`
`GtpV1Packet.ProtocolType`	`getProtocolType()`
`protected java.util.List<byte[]>`	`getRawFields()`	Returns a list of byte arrays which represents this header's fields.
`boolean`	`getReserved()`
`java.lang.Short`	`getSequenceNumber()`
`java.lang.Integer`	`getSequenceNumberAsInt()`
`int`	`getTeid()`
`long`	`getTeidAsLong()`
`GtpVersion`	`getVersion()`
`boolean`	`isExtensionHeaderFieldPresent()`
`boolean`	`isNPduNumberFieldPresent()`
`boolean`	`isSequenceNumberFieldPresent()`

Methods inherited from class org.pcap4j.packet.AbstractPacket.AbstractHeader
buildHexString, buildRawData, getRawData, hashCode, length, toHexString, toString

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - serialVersionUID
```
private static final long serialVersionUID
```
    See Also:
    
    Constant Field Values
  - FIRST_OCTET_OFFSET
```
private static final int FIRST_OCTET_OFFSET
```
    See Also:
    
    Constant Field Values
  - FIRST_OCTET_SIZE
```
private static final int FIRST_OCTET_SIZE
```
    See Also:
    
    Constant Field Values
  - MSG_TYPE_OFFSET
```
private static final int MSG_TYPE_OFFSET
```
    See Also:
    
    Constant Field Values
  - MSG_TYPE_SIZE
```
private static final int MSG_TYPE_SIZE
```
    See Also:
    
    Constant Field Values
  - LENGTH_OFFSET
```
private static final int LENGTH_OFFSET
```
    See Also:
    
    Constant Field Values
  - LENGTH_SIZE
```
private static final int LENGTH_SIZE
```
    See Also:
    
    Constant Field Values
  - TUNNEL_ID_OFFSET
```
private static final int TUNNEL_ID_OFFSET
```
    See Also:
    
    Constant Field Values
  - TUNNEL_ID_SIZE
```
private static final int TUNNEL_ID_SIZE
```
    See Also:
    
    Constant Field Values
  - GTP_V1_HEADER_MIM_SIZE
```
private static final int GTP_V1_HEADER_MIM_SIZE
```
    See Also:
    
    Constant Field Values
  - SEQ_OFFSET
```
private static final int SEQ_OFFSET
```
    See Also:
    
    Constant Field Values
  - SEQ_SIZE
```
private static final int SEQ_SIZE
```
    See Also:
    
    Constant Field Values
  - NPDU_OFFSET
```
private static final int NPDU_OFFSET
```
    See Also:
    
    Constant Field Values
  - NPDU_SIZE
```
private static final int NPDU_SIZE
```
    See Also:
    
    Constant Field Values
  - NEXT_HEADER_OFFSET
```
private static final int NEXT_HEADER_OFFSET
```
    See Also:
    
    Constant Field Values
  - NEXT_HEADER_SIZE
```
private static final int NEXT_HEADER_SIZE
```
    See Also:
    
    Constant Field Values
  - GTP_V1_HEADER_MAX_SIZE
```
private static final int GTP_V1_HEADER_MAX_SIZE
```
    See Also:
    
    Constant Field Values
  - version
```
private final GtpVersion version
```
  - protocolType
```
private final GtpV1Packet.ProtocolType protocolType
```
  - reserved
```
private final boolean reserved
```
  - extensionHeaderFlag
```
private final boolean extensionHeaderFlag
```
  - sequenceNumberFlag
```
private final boolean sequenceNumberFlag
```
  - nPduNumberFlag
```
private final boolean nPduNumberFlag
```
  - messageType
```
private final GtpV1MessageType messageType
```
  - length
```
private final short length
```
  - teid
```
private final int teid
```
  - sequenceNumber
```
private final java.lang.Short sequenceNumber
```
  - nPduNumber
```
private final java.lang.Byte nPduNumber
```
  - nextExtensionHeaderType
```
private final GtpV1ExtensionHeaderType nextExtensionHeaderType
```
- Constructor Detail
  - GtpV1Header
```
private GtpV1Header(byte[] rawData,
                    int offset,
                    int length)
             throws IllegalRawDataException
```
    Throws:
    
    IllegalRawDataException
  - GtpV1Header
```
private GtpV1Header(GtpV1Packet.Builder builder,
                    int payloadLen)
```
- Method Detail
  - getVersion
```
public GtpVersion getVersion()
```
    Returns:
    
    version
  - getProtocolType
```
public GtpV1Packet.ProtocolType getProtocolType()
```
    Returns:
    
    protocolType.
  - getReserved
```
public boolean getReserved()
```
    Returns:
    
    true if the reserved field is set to 1; false otherwise.
  - isExtensionHeaderFieldPresent
```
public boolean isExtensionHeaderFieldPresent()
```
    Returns:
    
    true if the extension header flag is set to 1; false otherwise.
  - isSequenceNumberFieldPresent
```
public boolean isSequenceNumberFieldPresent()
```
    Returns:
    
    true if the sequence number flag is set to 1; false otherwise.
  - isNPduNumberFieldPresent
```
public boolean isNPduNumberFieldPresent()
```
    Returns:
    
    true if the N-PDU number flag is set to 1; false otherwise.
  - getMessageType
```
public GtpV1MessageType getMessageType()
```
    Returns:
    
    messageType
  - getLength
```
public short getLength()
```
    Returns:
    
    length
  - getLengthAsInt
```
public int getLengthAsInt()
```
    Returns:
    
    length
  - getTeid
```
public int getTeid()
```
    Returns:
    
    teid
  - getTeidAsLong
```
public long getTeidAsLong()
```
    Returns:
    
    teid
  - getSequenceNumber
```
public java.lang.Short getSequenceNumber()
```
    Returns:
    
    sequenceNumber. May be null.
  - getSequenceNumberAsInt
```
public java.lang.Integer getSequenceNumberAsInt()
```
    Returns:
    
    sequenceNumber. May be null.
  - getNPduNumber
```
public java.lang.Byte getNPduNumber()
```
    Returns:
    
    nPduNumber. May be null.
  - getNPduNumberAsInt
```
public java.lang.Integer getNPduNumberAsInt()
```
    Returns:
    
    nPduNumber. May be null.
  - getNextExtensionHeaderType
```
public GtpV1ExtensionHeaderType getNextExtensionHeaderType()
```
    Returns:
    
    nextExtensionHeaderType. May be null.
  - getRawFields
```
protected java.util.List<byte[]> getRawFields()
```
    Description copied from class: AbstractPacket.AbstractHeader
    
    Returns a list of byte arrays which represents this header's fields. This method is called by calcLength() and buildRawData().
    
    Specified by:
    
    getRawFields in class AbstractPacket.AbstractHeader
    
    Returns:
    
    a list of byte arrays which represents this header's fields
  - calcLength
```
protected int calcLength()
```
    Description copied from class: AbstractPacket.AbstractHeader
    
    This method calculates the value length() will return by adding up the lengths of byte arrays in the list getRawFields() returns.
    
    Overrides:
    
    calcLength in class AbstractPacket.AbstractHeader
    
    Returns:
    
    a calculated length
  - buildString
```
protected java.lang.String buildString()
```
    Description copied from class: AbstractPacket.AbstractHeader
    
    This method builds the value toString() will return.
    
    Overrides:
    
    buildString in class AbstractPacket.AbstractHeader
    
    Returns:
    
    a string representation of this object
  - calcHashCode
```
protected int calcHashCode()
```
    Description copied from class: AbstractPacket.AbstractHeader
    
    This method builds the value hashCode() will return using the byte array getRawData() returns. This method may be better to be overridden for performance reason.
    
    Overrides:
    
    calcHashCode in class AbstractPacket.AbstractHeader
    
    Returns:
    
    a calculated hash code value for the object
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Description copied from class: AbstractPacket.AbstractHeader
    
    Indicates whether some other object is "equal to" this one using return values of getRawData(). This method should be overridden so that it does more strict comparisons more efficiently.
    
    Overrides:
    
    equals in class AbstractPacket.AbstractHeader

Class GtpV1Packet.GtpV1Header

Field Summary

Constructor Summary

Method Summary

Methods inherited from class org.pcap4j.packet.AbstractPacket.AbstractHeader

Methods inherited from class java.lang.Object

Field Detail

serialVersionUID

FIRST_OCTET_OFFSET

FIRST_OCTET_SIZE

MSG_TYPE_OFFSET

MSG_TYPE_SIZE

LENGTH_OFFSET

LENGTH_SIZE

TUNNEL_ID_OFFSET

TUNNEL_ID_SIZE

GTP_V1_HEADER_MIM_SIZE

SEQ_OFFSET

SEQ_SIZE

NPDU_OFFSET

NPDU_SIZE

NEXT_HEADER_OFFSET

NEXT_HEADER_SIZE

GTP_V1_HEADER_MAX_SIZE

version

protocolType

reserved

extensionHeaderFlag

sequenceNumberFlag

nPduNumberFlag

messageType

length

teid

sequenceNumber

nPduNumber

nextExtensionHeaderType

Constructor Detail

GtpV1Header

GtpV1Header

Method Detail

getVersion

getProtocolType

getReserved

isExtensionHeaderFieldPresent

isSequenceNumberFieldPresent

isNPduNumberFieldPresent

getMessageType

getLength

getLengthAsInt

getTeid

getTeidAsLong

getSequenceNumber

getSequenceNumberAsInt

getNPduNumber

getNPduNumberAsInt

getNextExtensionHeaderType

getRawFields

calcLength

buildString

calcHashCode

equals