blob: ebb741241e7dfc8b20731a09be35cbbcaca2692a [file] [log] [blame]
/**
* Copyright (C) 2013 Regents of the University of California.
* @author: Jeff Thompson <jefft0@remap.ucla.edu>
* See COPYING for copyright and distribution information.
*/
#ifndef NDN_BINARYXMLWIREFORMAT_HPP
#define NDN_BINARYXMLWIREFORMAT_HPP
#include "wire-format.hpp"
namespace ndn {
/**
* A BinaryXmlWireFormat extends WireFormat to override its virtual methods to implement encoding and decoding
* using binary XML.
*/
class BinaryXmlWireFormat : public WireFormat {
public:
/**
* Encode interest in binary XML and return the encoding.
* @param interest The Interest object to encode.
* @return A Blob containing the encoding.
*/
virtual Blob encodeInterest(const Interest& interest);
/**
* Decode input as an interest in binary XML and set the fields of the interest object.
* @param interest The Interest object whose fields are updated.
* @param input A pointer to the input buffer to decode.
* @param inputLength The number of bytes in input.
*/
virtual void decodeInterest(Interest& interest, const unsigned char *input, unsigned int inputLength);
/**
* Encode data with binary XML and return the encoding.
* @param data The Data object to encode.
* @param signedPortionBeginOffset Return the offset in the encoding of the beginning of the signed portion.
* If you are not encoding in order to sign, you can call encodeData(const Data& data) to ignore this returned value.
* @param signedPortionEndOffset Return the offset in the encoding of the end of the signed portion.
* If you are not encoding in order to sign, you can call encodeData(const Data& data) to ignore this returned value.
* @return A Blob containing the encoding.
*/
virtual Blob encodeData
(const Data& data, unsigned int *signedPortionBeginOffset, unsigned int *signedPortionEndOffset);
/**
* Decode input as a data packet in binary XML and set the fields in the data object.
* @param data The Data object whose fields are updated.
* @param input A pointer to the input buffer to decode.
* @param inputLength The number of bytes in input.
* @param signedPortionBeginOffset Return the offset in the input buffer of the beginning of the signed portion.
* If you are not decoding in order to verify, you can call
* decodeData(Data& data, const unsigned char *input, unsigned int inputLength) to ignore this returned value.
* @param signedPortionEndOffset Return the offset in the input buffer of the end of the signed portion.
* If you are not decoding in order to verify, you can call
* decodeData(Data& data, const unsigned char *input, unsigned int inputLength) to ignore this returned value.
*/
virtual void decodeData
(Data& data, const unsigned char *input, unsigned int inputLength, unsigned int *signedPortionBeginOffset, unsigned int *signedPortionEndOffset);
/**
* Encode forwardingEntry in binary XML and return the encoding.
* @param forwardingEntry The ForwardingEntry object to encode.
* @return A Blob containing the encoding.
*/
virtual Blob encodeForwardingEntry(const ForwardingEntry& forwardingEntry);
/**
* Decode input as a forwarding entry in binary XML and set the fields of the forwardingEntry object.
* @param forwardingEntry The ForwardingEntry object whose fields are updated.
* @param input A pointer to the input buffer to decode.
* @param inputLength The number of bytes in input.
*/
virtual void decodeForwardingEntry(ForwardingEntry& forwardingEntry, const unsigned char *input, unsigned int inputLength);
};
}
#endif