net.named_data.jndn.encoding

Class BinaryXmlWireFormat

java.lang.Object

net.named_data.jndn.encoding.WireFormat

net.named_data.jndn.encoding.BinaryXmlWireFormat

public class BinaryXmlWireFormat
extends WireFormat

Field Summary

Fields inherited from class net.named_data.jndn.encoding.WireFormat

ENABLE_NDNX

Constructor Summary

Constructors

Constructor and Description
BinaryXmlWireFormat()

Method Summary

Methods

Modifier and Type	Method and Description
void	decodeData(Data data, ByteBuffer input, int[] signedPortionBeginOffset, int[] signedPortionEndOffset) Decode input as a data packet in binary XML and set the fields in the data object.
void	decodeForwardingEntry(ForwardingEntry forwardingEntry, ByteBuffer input) Decode input as a forwarding entry in binary XML and set the fields of the forwardingEntry object.
void	decodeInterest(Interest interest, ByteBuffer input, int[] signedPortionBeginOffset, int[] signedPortionEndOffset) Decode input as an interest in binary XML and set the fields of the interest object.
void	decodeName(Name name, ByteBuffer input) Decode input as a name in binary XML and set the fields of the interest object.
Blob	encodeData(Data data, int[] signedPortionBeginOffset, int[] signedPortionEndOffset) Encode data and return the encoding.
Blob	encodeForwardingEntry(ForwardingEntry forwardingEntry) Encode forwardingEntry in binary XML and return the encoding.
Blob	encodeInterest(Interest interest, int[] signedPortionBeginOffset, int[] signedPortionEndOffset) Encode interest in binary XML and return the encoding.
Blob	encodeName(Name name) Encode name in binary XML and return the encoding.
static BinaryXmlWireFormat	get() Get a singleton instance of a BinaryXmlWireFormat.

Methods inherited from class net.named_data.jndn.encoding.WireFormat

decodeControlParameters, decodeData, decodeInterest, decodeLocalControlHeader, decodeSignatureInfoAndValue, encodeControlParameters, encodeData, encodeInterest, encodeLocalControlHeader, encodeSignatureInfo, encodeSignatureValue, getDefaultWireFormat, setDefaultWireFormat

Methods inherited from class java.lang.Object

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

Constructor Detail

BinaryXmlWireFormat

public BinaryXmlWireFormat()

Method Detail

encodeName

public Blob encodeName(Name name)

Encode name in binary XML and return the encoding.

Overrides:

encodeName in class WireFormat

Parameters:

name - The Name object to encode.

Returns:

A Blob containing the encoding.

decodeName

public void decodeName(Name name,
              ByteBuffer input)
                throws EncodingException

Decode input as a name in binary XML and set the fields of the interest object.

Overrides:

decodeName in class WireFormat

Parameters:

name - The Name object whose fields are updated.

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

Throws:

EncodingException - For invalid encoding.

encodeInterest

public Blob encodeInterest(Interest interest,
                  int[] signedPortionBeginOffset,
                  int[] signedPortionEndOffset)

Encode interest in binary XML and return the encoding.

Overrides:

encodeInterest in class WireFormat

Parameters:

interest - The Interest object to encode.

signedPortionBeginOffset - Return the offset in the encoding of the beginning of the signed portion. The signed portion starts from the first name component and ends just before the final name component (which is assumed to be a signature for a signed interest).

signedPortionEndOffset - Return the offset in the encoding of the end of the signed portion. The signed portion starts from the first name component and ends just before the final name component (which is assumed to be a signature for a signed interest).

Returns:

A Blob containing the encoding.

decodeInterest

public void decodeInterest(Interest interest,
                  ByteBuffer input,
                  int[] signedPortionBeginOffset,
                  int[] signedPortionEndOffset)
                    throws EncodingException

Decode input as an interest in binary XML and set the fields of the interest object.

Overrides:

decodeInterest in class WireFormat

Parameters:

interest - The Interest object whose fields are updated.

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

signedPortionBeginOffset - Return the offset in the encoding of the beginning of the signed portion. The signed portion starts from the first name component and ends just before the final name component (which is assumed to be a signature for a signed interest).

signedPortionEndOffset - Return the offset in the encoding of the end of the signed portion. The signed portion starts from the first name component and ends just before the final name component (which is assumed to be a signature for a signed interest).

Throws:

EncodingException - For invalid encoding.

encodeData

public Blob encodeData(Data data,
              int[] signedPortionBeginOffset,
              int[] signedPortionEndOffset)

Encode data and return the encoding.

Overrides:

encodeData in class WireFormat

Parameters:

data - The Data object to encode.

signedPortionBeginOffset - Return the offset in the encoding of the beginning of the signed portion by setting signedPortionBeginOffset[0]. If you are not encoding in order to sign, you can call encodeData(data) to ignore this returned value.

signedPortionEndOffset - Return the offset in the encoding of the end of the signed portion by setting signedPortionEndOffset[0]. If you are not encoding in order to sign, you can call encodeData(data) to ignore this returned value.

Returns:

A Blob containing the encoding.

decodeData

public void decodeData(Data data,
              ByteBuffer input,
              int[] signedPortionBeginOffset,
              int[] signedPortionEndOffset)
                throws EncodingException

Decode input as a data packet in binary XML and set the fields in the data object.

Overrides:

decodeData in class WireFormat

Parameters:

data - The Data object whose fields are updated.

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

signedPortionBeginOffset - Return the offset in the input buffer of the beginning of the signed portion by setting signedPortionBeginOffset[0]. If you are not decoding in order to verify, you can call decodeData(data, input) to ignore this returned value.

signedPortionEndOffset - Return the offset in the input buffer of the end of the signed portion by setting signedPortionEndOffset[0]. If you are not decoding in order to verify, you can call decodeData(data, input) to ignore this returned value.

Throws:

EncodingException - For invalid encoding.

encodeForwardingEntry

public Blob encodeForwardingEntry(ForwardingEntry forwardingEntry)

Encode forwardingEntry in binary XML and return the encoding.

Overrides:

encodeForwardingEntry in class WireFormat

Parameters:

forwardingEntry - The ForwardingEntry object to encode.

Returns:

A Blob containing the encoding.

decodeForwardingEntry

public void decodeForwardingEntry(ForwardingEntry forwardingEntry,
                         ByteBuffer input)
                           throws EncodingException

Decode input as a forwarding entry in binary XML and set the fields of the forwardingEntry object.

Overrides:

decodeForwardingEntry in class WireFormat

Parameters:

forwardingEntry - The ForwardingEntry object whose fields are updated.

input - ByteBuffer input.

Throws:

EncodingException - For invalid encoding.

get

public static BinaryXmlWireFormat get()

Get a singleton instance of a BinaryXmlWireFormat. Assuming that the default wire format was set with WireFormat.setDefaultWireFormat(BinaryXmlWireFormat.get()), you can check if this is the default wire encoding with if (WireFormat.getDefaultWireFormat() == BinaryXmlWireFormat.get()).

Returns:

The singleton instance.