org.onosproject.net.pi.runtime

Class PiPacketMetadata

java.lang.Object

org.onosproject.net.pi.runtime.PiPacketMetadata

@Beta
public final class PiPacketMetadata
extends Object

Instance of a metadata field for a controller packet-in/out for a protocol-independent pipeline. Metadata are used to carry information other than the packet-in/out payload, such as the original ingress port of a packet-in, or the egress port of packet-out.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PiPacketMetadata.Builder Builder of protocol-independent packet metadatas.

Method Summary

Modifier and Type	Method and Description
static PiPacketMetadata.Builder	builder() Returns a packet metadata builder.
boolean	equals(Object o)
int	hashCode()
PiPacketMetadataId	id() Return the identifier of this packet metadata.
String	toString()
ImmutableByteSequence	value() Returns the value for the field in this metadata.

Methods inherited from class java.lang.Object

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

Method Detail

id

public PiPacketMetadataId id()

Return the identifier of this packet metadata.

Returns:

packet metadata identifier

value

public ImmutableByteSequence value()

Returns the value for the field in this metadata.

Returns:

value

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

builder

public static PiPacketMetadata.Builder builder()

Returns a packet metadata builder.

Returns:

a new builder