ndn::PendingInterestHandle Class Reference

A handle of pending Interest. More...

#include <ndn-cxx/face.hpp>

+ Inheritance diagram for ndn::PendingInterestHandle:
+ Collaboration diagram for ndn::PendingInterestHandle:

Public Member Functions

 PendingInterestHandle () noexcept=default
 
 PendingInterestHandle (Face &face, const PendingInterestId *id)
 
void cancel () const
 Cancel the operation. More...
 
 operator const PendingInterestId * () const noexcept
 

Detailed Description

A handle of pending Interest.

PendingInterestHandle hdl = face.expressInterest(interest, satisfyCb, nackCb, timeoutCb);
hdl.cancel(); // cancel the pending Interest
Warning
Canceling the same pending Interest more than once, using same or different PendingInterestHandle or ScopedPendingInterestHandle, may trigger undefined behavior.
Canceling a pending Interest after the face has been destructed may trigger undefined behavior.

Definition at line 550 of file face.hpp.

Constructor & Destructor Documentation

ndn::PendingInterestHandle::PendingInterestHandle ( )
defaultnoexcept
ndn::PendingInterestHandle::PendingInterestHandle ( Face face,
const PendingInterestId *  id 
)

Definition at line 416 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::PendingInterestHandle::operator const PendingInterestId * ( ) const
inlinenoexcept

Definition at line 557 of file face.hpp.