ndn::RegisteredPrefixHandle Class Reference

A handle of registered prefix. More...

#include <ndn-cxx/face.hpp>

Inheritance diagram for ndn::RegisteredPrefixHandle:

Collaboration diagram for ndn::RegisteredPrefixHandle:

Public Member Functions
	RegisteredPrefixHandle () noexcept
	RegisteredPrefixHandle (Face &face, const RegisteredPrefixId *id)
void	cancel () const
	Cancel the operation. More...
	operator const RegisteredPrefixId * () const noexcept
void	unregister (const UnregisterPrefixSuccessCallback &onSuccess=nullptr, const UnregisterPrefixFailureCallback &onFailure=nullptr)
	Unregister the prefix. More...

Detailed Description

A handle of registered prefix.

Definition at line 587 of file face.hpp.

Constructor & Destructor Documentation

ndn::RegisteredPrefixHandle::RegisteredPrefixHandle ( )

inlinenoexcept

Definition at line 590 of file face.hpp.

ndn::RegisteredPrefixHandle::RegisteredPrefixHandle	(	Face &	face,
		const RegisteredPrefixId *	id
	)

Definition at line 422 of file face.cpp.

Member Function Documentation

void ndn::detail::CancelHandle::cancel ( ) const

inherited

Cancel the operation.

Definition at line 33 of file cancel-handle.cpp.

ndn::RegisteredPrefixHandle::operator const RegisteredPrefixId * ( ) const

inlinenoexcept

Definition at line 598 of file face.hpp.

void ndn::RegisteredPrefixHandle::unregister	(	const UnregisterPrefixSuccessCallback &	onSuccess = nullptr,
		const UnregisterPrefixFailureCallback &	onFailure = nullptr
	)

Unregister the prefix.

Warning

Unregistering the same prefix more than once, using same or different RegisteredPrefixHandle or ScopedRegisteredPrefixHandle, may trigger undefined behavior.

Unregistering a prefix after the face has been destructed may trigger undefined behavior.

Definition at line 432 of file face.cpp.