org.opendaylight.vtn.manager.packet

Class ARP

java.lang.Object

org.opendaylight.vtn.manager.packet.Packet

org.opendaylight.vtn.manager.packet.ARP

All Implemented Interfaces:

Cloneable

public final class ARP
extends Packet

ARP describes an ARP packet.

This class is provided only for VTN internal use. This class may be changed without any notice.

Since:

Beryllium

Nested Class Summary

Nested classes/interfaces inherited from class org.opendaylight.vtn.manager.packet.Packet

Packet.HeaderField

Field Summary

Fields

Modifier and Type	Field and Description
static short	HW_TYPE_ETHERNET The hardware tyep value that indicates Ethernet.
static short	REPLY The ARP operation code that indicates ARP reply.
static short	REQUEST The ARP operation code that indicates ARP request.

Constructor Summary

Constructors

Constructor and Description
ARP()

Method Summary

Methods

Modifier and Type	Method and Description
ARP	clone() Return a deep copy of this packet.
byte	getHardwareAddressLength() Gets the hardware address length from the stored ARP header.
short	getHardwareType() Gets the hardware type from the stored ARP header.
protected Map<String,Packet.HeaderField>	getHeaderFormat() Return a map that determines the format of the packet.
int	getHeaderSize() Gets the header size in bits.
short	getOpCode() Gets the opCode from stored ARP header.
byte	getProtocolAddressLength() Get the protocol address length from Protocol header.
short	getProtocolType() Gets the protocol type from the stored ARP header.
byte[]	getSenderHardwareAddress() Gets the sender hardware address from the stored ARP header.
byte[]	getSenderProtocolAddress() Gets the IP address from the stored ARP header.
byte[]	getTargetHardwareAddress() Gets the hardware address from the stored ARP header.
byte[]	getTargetProtocolAddress() Gets the target protocol address.
ARP	setHardwareAddressLength(byte len) Sets the hardware address length for the current ARP object instance.
ARP	setHardwareType(short hwtype) Sets the hardware Type for the current ARP object instance.
ARP	setOpCode(short op) Sets the opCode for the current ARP object instance.
ARP	setProtocolAddressLength(byte len) Sets the Protocol address for the current ARP object instance.
ARP	setProtocolType(short ptype) Sets the protocol Type for the current ARP object instance.
ARP	setSenderHardwareAddress(byte[] addr) Sets the sender hardware address for the current ARP object instance.
ARP	setSenderProtocolAddress(byte[] addr) Sets the sender protocol address for the current ARP object instance.
ARP	setTargetHardwareAddress(byte[] addr) Sets the target hardware address for the current ARP object instance.
ARP	setTargetProtocolAddress(byte[] addr) Sets the target protocol address for the current ARP object instance.

Methods inherited from class org.opendaylight.vtn.manager.packet.Packet

deserialize, equals, equalsField, getByte, getBytes, getFieldNumBits, getFieldNumBits, getFieldOffset, getFieldOffset, getHeaderFieldMap, getInt, getIp4Network, getPayload, getRawPayload, getRawPayloadSize, getShort, hashCode, isCorrupted, isZeroShort, postDeserializeCustomOperation, postSerializeCustomOperation, serialize, setCorrupted, setHeaderField, setPayload, setPayloadClass, setRawPayload, toString

Methods inherited from class java.lang.Object

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

Field Detail

HW_TYPE_ETHERNET

public static final short HW_TYPE_ETHERNET

The hardware tyep value that indicates Ethernet.

See Also:

Constant Field Values

REQUEST

public static final short REQUEST

The ARP operation code that indicates ARP request.

See Also:

Constant Field Values

REPLY

public static final short REPLY

The ARP operation code that indicates ARP reply.

See Also:

Constant Field Values

Constructor Detail

ARP

public ARP()

Method Detail

getHardwareType

public short getHardwareType()

Gets the hardware type from the stored ARP header.

Returns:

The hardware type.

getProtocolType

public short getProtocolType()

Gets the protocol type from the stored ARP header.

Returns:

The protocol type.

getHardwareAddressLength

public byte getHardwareAddressLength()

Gets the hardware address length from the stored ARP header.

Returns:

The length of the hardware address.

getProtocolAddressLength

public byte getProtocolAddressLength()

Get the protocol address length from Protocol header.

Returns:

The length of the protocol address.

getOpCode

public short getOpCode()

Gets the opCode from stored ARP header.

Returns:

The operation code.

getSenderHardwareAddress

public byte[] getSenderHardwareAddress()

Gets the sender hardware address from the stored ARP header.

Returns:

The sender hardware address. null if not configured.

getSenderProtocolAddress

public byte[] getSenderProtocolAddress()

Gets the IP address from the stored ARP header.

Returns:

The sender protocol address. null if not configured.

getTargetHardwareAddress

public byte[] getTargetHardwareAddress()

Gets the hardware address from the stored ARP header.

Returns:

The target hardware address. null if not configured.

getTargetProtocolAddress

public byte[] getTargetProtocolAddress()

Gets the target protocol address.

Returns:

The target protocol address. null if not configured.

setHardwareType

public ARP setHardwareType(short hwtype)

Sets the hardware Type for the current ARP object instance.

Parameters:

hwtype - The hardwareType to set.

Returns:

This instance.

setProtocolType

public ARP setProtocolType(short ptype)

Sets the protocol Type for the current ARP object instance.

Parameters:

ptype - The protocol type to set.

Returns:

This instance.

setHardwareAddressLength

public ARP setHardwareAddressLength(byte len)

Sets the hardware address length for the current ARP object instance.

Parameters:

len - The length of the hardware address.

Returns:

This instance.

setProtocolAddressLength

public ARP setProtocolAddressLength(byte len)

Sets the Protocol address for the current ARP object instance.

Parameters:

len - The length of the protocol address.

Returns:

This instance.

setOpCode

public ARP setOpCode(short op)

Sets the opCode for the current ARP object instance.

Parameters:

op - The operation code.

Returns:

This instance.

setSenderHardwareAddress

public ARP setSenderHardwareAddress(byte[] addr)

Sets the sender hardware address for the current ARP object instance.

Parameters:

addr - The sender hardware address.

Returns:

This instance.

setTargetHardwareAddress

public ARP setTargetHardwareAddress(byte[] addr)

Sets the target hardware address for the current ARP object instance.

Parameters:

addr - The target hardware address.

Returns:

This instance.

setSenderProtocolAddress

public ARP setSenderProtocolAddress(byte[] addr)

Sets the sender protocol address for the current ARP object instance.

Parameters:

addr - The sender protocol address.

Returns:

This instance.

setTargetProtocolAddress

public ARP setTargetProtocolAddress(byte[] addr)

Sets the target protocol address for the current ARP object instance.

Parameters:

addr - The target protocol address.

Returns:

This instance.

getHeaderSize

public int getHeaderSize()

Gets the header size in bits.

Overrides:

getHeaderSize in class Packet

Returns:

The ARP header size in bits.

getHeaderFormat

protected Map<String,Packet.HeaderField> getHeaderFormat()

Return a map that determines the format of the packet.

Specified by:

getHeaderFormat in class Packet

Returns:

A map that determines the format of the packet.

clone

public ARP clone()

Return a deep copy of this packet.

Overrides:

clone in class Packet

Returns:

A deep copy of this packet.