net.named_data.jndn

Class LocalControlHeader

java.lang.Object

net.named_data.jndn.LocalControlHeader

public class LocalControlHeader
extends Object

A LocalControlHeader represents an NFD LocalControlHeader which holds fields like face ID. A LocalControlHeader object is optional in an Interest or Data object.

Constructor Summary

Constructors

Constructor and Description
LocalControlHeader() Create a LocalControlHeader where all fields are not specified.
LocalControlHeader(LocalControlHeader localControlHeader) Create a LocalControlHeader with a copy of the fields in localControlHeader.

Method Summary

Methods

Modifier and Type	Method and Description
long	getIncomingFaceId() Get the incoming face ID.
long	getNextHopFaceId() Get the next hop face ID.
Blob	getPayloadWireEncoding()
void	setIncomingFaceId(long incomingFaceId) Set the incoming face ID.
void	setNextHopFaceId(long nextHopFaceId) Set the next hop face ID.
void	setPayloadWireEncoding(Blob payloadWireEncoding)
void	wireDecode(Blob input) Decode the input using the default wire format WireFormat.getDefaultWireFormat() and update this LocalControlHeader.
void	wireDecode(Blob input, WireFormat wireFormat) Decode the input using a particular wire format and update this LocalControlHeader.
void	wireDecode(ByteBuffer input) Decode the input using the default wire format WireFormat.getDefaultWireFormat() and update this LocalControlHeader.
void	wireDecode(ByteBuffer input, WireFormat wireFormat) Decode the input using a particular wire format and update this LocalControlHeader.
Blob	wireEncode() Encode this LocalControlHeader for the default wire format WireFormat.getDefaultWireFormat().
Blob	wireEncode(WireFormat wireFormat) Encode this LocalControlHeader for a particular wire format.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

LocalControlHeader

public LocalControlHeader()

Create a LocalControlHeader where all fields are not specified.

LocalControlHeader

public LocalControlHeader(LocalControlHeader localControlHeader)

Create a LocalControlHeader with a copy of the fields in localControlHeader.

Parameters:

localControlHeader - The LocalControlHeader to copy.

Method Detail

getIncomingFaceId

public long getIncomingFaceId()

Get the incoming face ID.

Returns:

The incoming face ID. If not specified, return -1.

getNextHopFaceId

public long getNextHopFaceId()

Get the next hop face ID.

Returns:

The next hop face ID. If not specified, return -1.

getPayloadWireEncoding

public Blob getPayloadWireEncoding()

setIncomingFaceId

public void setIncomingFaceId(long incomingFaceId)

Set the incoming face ID.

Parameters:

incomingFaceId - The incoming face ID. If not specified, set to -1.

setNextHopFaceId

public void setNextHopFaceId(long nextHopFaceId)

Set the next hop face ID.

Parameters:

nextHopFaceId - The next hop face ID. If not specified, set to -1.

setPayloadWireEncoding

public void setPayloadWireEncoding(Blob payloadWireEncoding)

wireEncode

public final Blob wireEncode(WireFormat wireFormat)

Encode this LocalControlHeader for a particular wire format.

Parameters:

wireFormat - A WireFormat object used to encode this LocalControlHeader.

Returns:

The encoded buffer.

wireEncode

public final Blob wireEncode()

Encode this LocalControlHeader for the default wire format WireFormat.getDefaultWireFormat().

Returns:

The encoded buffer.

wireDecode

public final void wireDecode(ByteBuffer input,
              WireFormat wireFormat)
                      throws EncodingException

Decode the input using a particular wire format and update this LocalControlHeader.

Parameters:

input - The input buffer to decode. This reads from position() to limit(), but does not change the position.

wireFormat - A WireFormat object used to decode the input.

Throws:

EncodingException - For invalid encoding.

wireDecode

public final void wireDecode(ByteBuffer input)
                      throws EncodingException

Decode the input using the default wire format WireFormat.getDefaultWireFormat() and update this LocalControlHeader.

Parameters:

input - The input buffer to decode. This reads from position() to limit(), but does not change the position.

Throws:

EncodingException - For invalid encoding.

wireDecode

public final void wireDecode(Blob input,
              WireFormat wireFormat)
                      throws EncodingException

Decode the input using a particular wire format and update this LocalControlHeader.

Parameters:

input - The input blob to decode.

wireFormat - A WireFormat object used to decode the input.

Throws:

EncodingException - For invalid encoding.

wireDecode

public final void wireDecode(Blob input)
                      throws EncodingException

Decode the input using the default wire format WireFormat.getDefaultWireFormat() and update this LocalControlHeader.

Parameters:

input - The input blob to decode.

Throws:

EncodingException - For invalid encoding.