io.pkts.protocol

Enum Protocol

java.lang.Object

java.lang.Enum<Protocol>

io.pkts.protocol.Protocol

All Implemented Interfaces:

Serializable, Comparable<Protocol>

public enum Protocol
extends Enum<Protocol>

Author:

jonas@jonasborjesson.com

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Protocol.Layer

Enum Constant Summary

Enum Constants

Enum Constant and Description
ARP
ETHERNET_II
ICMP
ICMP6
IGMP
IPv4
IPv6
PCAP
RTCP
RTP
SCTP
SDP
SIP
SLL
TCP
TLS
UDP
UNKNOWN

Method Summary

Modifier and Type	Method and Description
Long	getLinkType()
String	getName() The short name of this protocol.
Protocol.Layer	getProtocolLayer() Each Protocol operates within a particular Protocol.Layer in the ISO stack.
String	toString()
static Protocol	valueOf(byte code) Get a protocol based on it's defined byte code.
static Protocol	valueOf(String name) Returns the enum constant of this type with the specified name.
static Protocol[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ICMP

public static final Protocol ICMP

ICMP6

public static final Protocol ICMP6

IGMP

public static final Protocol IGMP

TLS

public static final Protocol TLS

TCP

public static final Protocol TCP

UDP

public static final Protocol UDP

SCTP

public static final Protocol SCTP

SIP

public static final Protocol SIP

SDP

public static final Protocol SDP

ETHERNET_II

public static final Protocol ETHERNET_II

SLL

public static final Protocol SLL

IPv4

public static final Protocol IPv4

IPv6

public static final Protocol IPv6

PCAP

public static final Protocol PCAP

RTP

public static final Protocol RTP

RTCP

public static final Protocol RTCP

ARP

public static final Protocol ARP

UNKNOWN

public static final Protocol UNKNOWN

Method Detail

values

public static Protocol[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (Protocol c : Protocol.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static Protocol valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getName

public String getName()

The short name of this protocol. Similar to what Wireshark shows in its short description of all the known protocols within its "super" frame. E.g., if you "click" on the Pcap Frame it will have a field called "protocols in frame" and will display something like "eth:ip:udp:sip:sdp", this function will return a short name like that.

Returns:

toString

public String toString()

Overrides:

toString in class Enum<Protocol>

getProtocolLayer

public Protocol.Layer getProtocolLayer()

Each Protocol operates within a particular Protocol.Layer in the ISO stack. This is mainly used by the FramerManager when trying to determine which Framers it should consult when trying to figure out which framer to use.

Returns:

valueOf

public static Protocol valueOf(byte code)

Get a protocol based on it's defined byte code. This is only true for some protocols For a full list: http://en.wikipedia.org/wiki/List_of_IP_protocol_numbers

Parameters:

code -

Returns:

getLinkType

public Long getLinkType()