A DelegationSet holds a list of DelegationSet::Delegation entries which is used as the content of a Link instance. More...

#include <delegation-set.hpp>

Classes
class	Delegation
	A DelegationSet::Delegation holds a preference number and delegation name. More...

Public Member Functions
	DelegationSet ()
	Create a DelegationSet with an empty list of delegations.

	DelegationSet (const DelegationSet &delegationSet)
	Create a DelegationSet, copying values from the other DelegationSet. More...

DelegationSet &	operator= (const DelegationSet &delegationSet)

void	add (int preference, const Name &name)
	Add a new DelegationSet::Delegation to the list of delegations, sorted by preference number then by name. More...

void	addUnsorted (const ptr_lib::shared_ptr< Delegation > &delegation)
	Add the DelegationSet::Delegation to the end of the list of delegations, without sorting or updating any existing entries. More...

bool	remove (const Name &name)
	Remove every DelegationSet::Delegation with the given name. More...

void	clear ()
	Clear the list of delegations.

size_t	size () const
	Get the number of delegation entries. More...

const Delegation &	get (size_t i) const
	Get the delegation at the given index, according to the ordering described in add(). More...

int	find (const Name &name) const
	Find the first delegation with the given name and return its index. More...

Blob	wireEncode (WireFormat &wireFormat=*WireFormat::getDefaultWireFormat()) const
	Encode this DelegationSet for a particular wire format. More...

void	wireDecode (const uint8_t input, size_t inputLength, WireFormat &wireFormat=WireFormat::getDefaultWireFormat())
	Decode the input using a particular wire format and update this DelegationSet. More...

void	wireDecode (const std::vector< uint8_t > &input, WireFormat &wireFormat=*WireFormat::getDefaultWireFormat())
	Decode the input using a particular wire format and update this DelegationSet. More...

void	wireDecode (const Blob &input, WireFormat &wireFormat=*WireFormat::getDefaultWireFormat())
	Decode the input using a particular wire format and update this DelegationSet. More...

const Blob &	getDefaultWireEncoding () const
	Return a reference to the defaultWireEncoding, which was encoded with getDefaultWireEncodingFormat(). More...

WireFormat *	getDefaultWireEncodingFormat () const
	Get the WireFormat which is used by getDefaultWireEncoding(). More...

uint64_t	getChangeCount () const
	Get the change count, which is incremented each time this object is changed. More...

Detailed Description

A DelegationSet holds a list of DelegationSet::Delegation entries which is used as the content of a Link instance.

If you add elements with add(), then the list is a set sorted by preference number then by name. But wireDecode will add the elements from the wire encoding, preserving the given order and possible duplicates (in which case a DelegationSet really holds a "list" and not necessarily a "set").

Constructor & Destructor Documentation

ndn::DelegationSet::DelegationSet ( const DelegationSet & delegationSet )

inline

Create a DelegationSet, copying values from the other DelegationSet.

Parameters

delegationSet The DelegationSet to copy values from.

Member Function Documentation

void ndn::DelegationSet::add	(	int	preference,
		const Name &	name
	)

Add a new DelegationSet::Delegation to the list of delegations, sorted by preference number then by name.

If there is already a delegation with the same name, update its preference, and remove any extra delegations with the same name.

Parameters

preference	The preference number.
name	The delegation name. This makes a copy of the name.

void ndn::DelegationSet::addUnsorted ( const ptr_lib::shared_ptr< Delegation > & delegation )

inline

Add the DelegationSet::Delegation to the end of the list of delegations, without sorting or updating any existing entries.

This is useful for adding preferences from a wire encoding, preserving the supplied ordering and possible duplicates.

Parameters

preference	The preference number.
name	The delegation name. This makes a copy of the name.

int ndn::DelegationSet::find ( const Name & name ) const

Find the first delegation with the given name and return its index.

Parameters

name	Then name of the delegation to find.

Returns: The index of the delegation, or -1 if not found.

const DelegationSet::Delegation & ndn::DelegationSet::get ( size_t i ) const

Get the delegation at the given index, according to the ordering described in add().

Parameters

i	The index of the component, starting from 0.

Returns: The delegation at the index.

Exceptions

runtime_error If index is out of range.

uint64_t ndn::DelegationSet::getChangeCount ( ) const

inline

Get the change count, which is incremented each time this object is changed.

Returns: The change count.

const Blob& ndn::DelegationSet::getDefaultWireEncoding ( ) const

inline

Return a reference to the defaultWireEncoding, which was encoded with getDefaultWireEncodingFormat().

The Blob may have a null pointer.

WireFormat* ndn::DelegationSet::getDefaultWireEncodingFormat ( ) const

inline

Get the WireFormat which is used by getDefaultWireEncoding().

Returns: The WireFormat, which is only meaningful if the getDefaultWireEncoding() does not have a null pointer.

bool ndn::DelegationSet::remove ( const Name & name )

Remove every DelegationSet::Delegation with the given name.

Parameters

name	The name to match the name of the delegation(s) to be removed.

Returns: True if a DelegationSet::Delegation was removed, otherwise false.

size_t ndn::DelegationSet::size ( ) const

inline

Get the number of delegation entries.

Returns: The number of delegation entries.

void ndn::DelegationSet::wireDecode	(	const uint8_t *	input,
		size_t	inputLength,
		WireFormat &	wireFormat = `*WireFormat::getDefaultWireFormat()`
	)

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

If wireFormat is the default wire format, also set the defaultWireEncoding field to a copy of the input. (To not copy the input, see wireDecode(Blob).)

Parameters

input	The input byte array to be decoded.
inputLength	The length of input.
wireFormat	(optional) A WireFormat object used to decode the input. If omitted, use WireFormat::getDefaultWireFormat().

void ndn::DelegationSet::wireDecode	(	const std::vector< uint8_t > &	input,
		WireFormat &	wireFormat = `*WireFormat::getDefaultWireFormat()`
	)

inline

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

If wireFormat is the default wire format, also set the defaultWireEncoding field to a copy of the input. (To not copy the input, see wireDecode(Blob).)

Parameters

input	The input byte array to be decoded.
wireFormat	(optional) A WireFormat object used to decode the input. If omitted, use WireFormat::getDefaultWireFormat().

void ndn::DelegationSet::wireDecode	(	const Blob &	input,
		WireFormat &	wireFormat = `*WireFormat::getDefaultWireFormat()`
	)

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

If wireFormat is the default wire format, also set the defaultWireEncoding to another pointer to the input Blob.

Parameters

input	The input byte array to be decoded as an immutable Blob.
wireFormat	(optional) A WireFormat object used to decode the input. If omitted, use WireFormat::getDefaultWireFormat().

Blob ndn::DelegationSet::wireEncode ( WireFormat & wireFormat = *WireFormat::getDefaultWireFormat() ) const

Encode this DelegationSet for a particular wire format.

If wireFormat is the default wire format, also set the defaultWireEncoding field to the encoded result. Even though this is const, if wireFormat is the default wire format we update the defaultWireEncoding.

Parameters

wireFormat (optional) A WireFormat object used to encode this DelegationSet. If omitted, use WireFormat::getDefaultWireFormat().

Returns: The encoded byte array.

The documentation for this class was generated from the following files:

include/ndn-cpp/delegation-set.hpp
src/delegation-set.cpp

Classes

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation