com.h3c.of.ctl.pkt

Interface Hint

All Known Implementing Classes:

AbstractHint, ExperimenterHint, HandlerHint, TypeOnlyHint

public interface Hint

A piece of information about a Packet-In message that may help in deciding what to do with it.

Each hint has a type; the standard types are defined by HintType. For each standard type there is a corresponding concrete class that holds the payload of the hint.

To allow experimenters to define their own hint types, each type is encoded as an integer. Note that positive integers are reserved; experimenters should express their custom hint types using negative integers.

Method Summary

Methods

Modifier and Type	Method and Description
int	getEncodedType() Returns the hint type encoded as an integer.
HintType	getType() Returns the hint type, if it is a standard type.

Method Detail

getEncodedType

int getEncodedType()

Returns the hint type encoded as an integer.

Returns:

the encoded type

getType

HintType getType()

Returns the hint type, if it is a standard type. Non-standard types will return null, and will need to be differentiated via getEncodedType().

Returns:

the hint type