org.onosproject.net.pi.model

Interface PiHeaderModel

@Beta
public interface PiHeaderModel

Model of a header instance in a protocol-independent pipeline.

Method Summary

Modifier and Type	Method and Description
default int	index() Returns the index of this header w.r.t.
boolean	isMetadata() Returns true if this header instance is a metadata, false elsewhere.
String	name() Returns the name of this header instance.
PiHeaderTypeModel	type() Returns the type of this header instance.

Method Detail

name

String name()

Returns the name of this header instance.

Returns:

a string value

type

PiHeaderTypeModel type()

Returns the type of this header instance.

Returns:

a header type value

isMetadata

boolean isMetadata()

Returns true if this header instance is a metadata, false elsewhere.

Returns:

a boolean value

index

default int index()

Returns the index of this header w.r.t. to other headers of the same type. Index 0 points to the first instance of the header, 1 the second one, etc. Helpful when dealing with stacked headers. e.g. to match on the second MPLS label.

Returns:

a non-negative integer value