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...
 
void unregister (const UnregisterPrefixSuccessCallback &onSuccess=nullptr, const UnregisterPrefixFailureCallback &onFailure=nullptr)
 Unregister the prefix. More...
 

Detailed Description

A handle of registered prefix.

Definition at line 572 of file face.hpp.

Constructor & Destructor Documentation

◆ RegisteredPrefixHandle() [1/2]

ndn::RegisteredPrefixHandle::RegisteredPrefixHandle ( )
inlinenoexcept

Definition at line 575 of file face.hpp.

◆ RegisteredPrefixHandle() [2/2]

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

Definition at line 384 of file face.cpp.

Member Function Documentation

◆ cancel()

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

Cancel the operation.

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

◆ unregister()

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

Unregister the prefix.

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

Definition at line 394 of file face.cpp.