NS-3 based Named Data Networking (NDN) simulator
ndnSIM 2.5: NDN, CCN, CCNx, content centric networks 		API Documentation
Public Member Functions | List of all members
ndn::RegisteredPrefixHandle Class Reference

A handle of registered prefix. More...

#include <face.hpp>

Inheritance diagram for ndn::RegisteredPrefixHandle:
Inheritance graph
[legend]
Collaboration diagram for ndn::RegisteredPrefixHandle:
Collaboration graph
[legend]

Public Member Functions

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

Detailed Description

A handle of registered prefix.

Definition at line 534 of file face.hpp.

Constructor & Destructor Documentation

◆ RegisteredPrefixHandle() [1/2]

ndn::RegisteredPrefixHandle::RegisteredPrefixHandle ( )
inlinenoexcept

Definition at line 537 of file face.hpp.

◆ RegisteredPrefixHandle() [2/2]

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

Definition at line 346 of file face.cpp.

References ndn::Face::unregisterPrefix().

Member Function Documentation

◆ operator const RegisteredPrefixId *()

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

Definition at line 545 of file face.hpp.

◆ unregister()

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

References ndn::Face::unregisterPrefix().

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