Package org.onosproject.net.packet

Class DefaultOutboundPacket

java.lang.Object

org.onosproject.net.packet.DefaultOutboundPacket

All Implemented Interfaces:

OutboundPacket

public final class DefaultOutboundPacket
extends Object
implements OutboundPacket

Default implementation of an immutable outbound packet.

Constructor Summary

Constructors

Constructor	Description
DefaultOutboundPacket(DeviceId sendThrough, TrafficTreatment treatment, ByteBuffer data)	Creates an immutable outbound packet.
DefaultOutboundPacket(DeviceId sendThrough, TrafficTreatment treatment, ByteBuffer data, PortNumber inPort)	Creates an immutable outbound packet.

Method Summary

Modifier and Type	Method	Description
ByteBuffer	data()	Returns immutable view of the raw data to be sent.
boolean	equals(Object obj)
int	hashCode()
PortNumber	inPort()	Returns the input port of this packet.
DeviceId	sendThrough()	Returns the identity of a device through which this packet should be sent.
String	toString()
TrafficTreatment	treatment()	Returns how the outbound packet should be treated.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultOutboundPacket

public DefaultOutboundPacket(DeviceId sendThrough,
                             TrafficTreatment treatment,
                             ByteBuffer data)

Creates an immutable outbound packet.

Parameters:

sendThrough - identifier through which to send the packet

treatment - list of packet treatments

data - raw packet data

DefaultOutboundPacket

public DefaultOutboundPacket(DeviceId sendThrough,
                             TrafficTreatment treatment,
                             ByteBuffer data,
                             PortNumber inPort)

Creates an immutable outbound packet.

Parameters:

sendThrough - identifier through which to send the packet

treatment - list of packet treatments

data - raw packet data

inPort - input port to be used for the packet

Method Detail

sendThrough

public DeviceId sendThrough()

Description copied from interface: OutboundPacket

Returns the identity of a device through which this packet should be sent.

Specified by:

sendThrough in interface OutboundPacket

Returns:

device identity

treatment

public TrafficTreatment treatment()

Description copied from interface: OutboundPacket

Returns how the outbound packet should be treated.

Specified by:

treatment in interface OutboundPacket

Returns:

output treatment

data

public ByteBuffer data()

Description copied from interface: OutboundPacket

Returns immutable view of the raw data to be sent.

Specified by:

data in interface OutboundPacket

Returns:

data to emit

inPort

public PortNumber inPort()

Description copied from interface: OutboundPacket

Returns the input port of this packet. Defaults to controller port. This is useful for actions that involve the input port such as ALL or FLOOD.

Specified by:

inPort in interface OutboundPacket

Returns:

the input port to be used for this packet.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object