net.named_data.jndn.encoding

Class ProtobufTlv

java.lang.Object

net.named_data.jndn.encoding.ProtobufTlv

public class ProtobufTlv
extends Object

ProtobufTlv has static methods to encode and decode an Protobuf Message object as NDN-TLV. The Protobuf tag value is used as the TLV type code. A Protobuf message is encoded/decoded as a nested TLV encoding. Protobuf types uint32, uint64 and enum are encoded/decoded as TLV nonNegativeInteger. (It is an error if an enum value is negative.) Protobuf types bytes and string are encoded/decoded as TLV bytes. The Protobuf type bool is encoded/decoded as a TLV boolean (a zero length value for True, omitted for False). Other Protobuf types are an error. Protobuf has no "outer" message type, so you need to put your TLV message inside an outer "typeless" message.

Constructor Summary

Constructors

Constructor and Description
ProtobufTlv()

Method Summary

Methods

Modifier and Type	Method and Description
static void	decode(com.google.protobuf.Message.Builder message, Blob input)
static void	decode(com.google.protobuf.Message.Builder message, ByteBuffer input) Decode the input as NDN-TLV and update the fields of the Protobuf message object.
static Blob	encode(com.google.protobuf.Message message) Encode the Protobuf message object as NDN-TLV.
static Name	toName(com.google.protobuf.Message nameMessage) Return a Name made from the component array in a Protobuf message object, assuming that it was defined with "repeated bytes".

Methods inherited from class java.lang.Object

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

Constructor Detail

ProtobufTlv

public ProtobufTlv()

Method Detail

encode

public static Blob encode(com.google.protobuf.Message message)

Encode the Protobuf message object as NDN-TLV.

Parameters:

message - The Protobuf message object. This calls message.IsInitialized() to ensure that all required fields are present and throws an exception if not.

Returns:

The encoded buffer in a Blob object.

decode

public static void decode(com.google.protobuf.Message.Builder message,
          ByteBuffer input)
                   throws EncodingException

Decode the input as NDN-TLV and update the fields of the Protobuf message object.

Parameters:

message - The Protobuf Message builder object. This does not first clear the object.

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

Throws:

EncodingException - For invalid encoding.

decode

public static void decode(com.google.protobuf.Message.Builder message,
          Blob input)
                   throws EncodingException

Throws:

EncodingException

toName

public static Name toName(com.google.protobuf.Message nameMessage)

Return a Name made from the component array in a Protobuf message object, assuming that it was defined with "repeated bytes". For example: message Name { repeated bytes component = 8; } (See the TestEncodeDecodeFibEntry example.)

Parameters:

nameMessage - The Protobuf message object containing the "repeated bytes" component array.

Returns:

A new name.