NS-3 based Named Data Networking (NDN) simulator
ndnSIM 2.5: NDN, CCN, CCNx, content centric networks
API Documentation
ndn::RegisteredPrefixHandle Class Reference

A handle of registered prefix. More...

#include <face.hpp>

Inheritance diagram for ndn::RegisteredPrefixHandle:
Collaboration diagram for ndn::RegisteredPrefixHandle:

Public Member Functions

 RegisteredPrefixHandle () noexcept
 
 RegisteredPrefixHandle (Face &face, const RegisteredPrefixId *id)
 
void unregister (const UnregisterPrefixSuccessCallback &onSuccess=nullptr, const UnregisterPrefixFailureCallback &onFailure=nullptr)
 Unregister the prefix. More...
 
- Public Member Functions inherited from ndn::detail::CancelHandle
 CancelHandle () noexcept
 
 CancelHandle (std::function< void()> cancel) noexcept
 
void cancel () const
 Cancel the operation. More...
 

Detailed Description

A handle of registered prefix.

Definition at line 519 of file face.hpp.

Constructor & Destructor Documentation

◆ RegisteredPrefixHandle() [1/2]

ndn::RegisteredPrefixHandle::RegisteredPrefixHandle ( )
inlinenoexcept

Definition at line 522 of file face.hpp.

◆ RegisteredPrefixHandle() [2/2]

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

Definition at line 314 of file face.cpp.

Member Function Documentation

◆ 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 324 of file face.cpp.


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