ndn::util::DummyClientFace Class Reference

a client-side face for unit testing More...

#include <ndn-cxx/util/dummy-client-face.hpp>

+ Inheritance diagram for ndn::util::DummyClientFace:
+ Collaboration diagram for ndn::util::DummyClientFace:

Classes

class  AlreadyLinkedError
 
class  Options
 options for DummyClientFace More...
 

Public Member Functions

 DummyClientFace (const Options &options=Options())
 Create a dummy face with internal IO service. More...
 
 DummyClientFace (KeyChain &keyChain, const Options &options=Options())
 Create a dummy face with internal IO service and the specified KeyChain. More...
 
 DummyClientFace (boost::asio::io_service &ioService, const Options &options=Options())
 Create a dummy face with the provided IO service. More...
 
 DummyClientFace (boost::asio::io_service &ioService, KeyChain &keyChain, const Options &options=Options())
 Create a dummy face with the provided IO service and the specified KeyChain. More...
 
 ~DummyClientFace ()
 
PendingInterestHandle expressInterest (const Interest &interest, const DataCallback &afterSatisfied, const NackCallback &afterNacked, const TimeoutCallback &afterTimeout)
 Express Interest. More...
 
boost::asio::io_service & getIoService ()
 
size_t getNPendingInterests () const
 Get number of pending Interests. More...
 
void linkTo (DummyClientFace &other)
 link another DummyClientFace through a broadcast media More...
 
void processEvents (time::milliseconds timeout=time::milliseconds::zero(), bool keepThread=false)
 Process any data to receive or call timeout callbacks. More...
 
void put (Data data)
 Publish data packet. More...
 
void put (lp::Nack nack)
 Send a network NACK. More...
 
void receive (const Interest &interest)
 cause the Face to receive an interest More...
 
void receive (const Data &data)
 cause the Face to receive a data More...
 
void receive (const lp::Nack &nack)
 cause the Face to receive a nack More...
 
RegisteredPrefixHandle registerPrefix (const Name &prefix, const RegisterPrefixSuccessCallback &onSuccess, const RegisterPrefixFailureCallback &onFailure, const security::SigningInfo &signingInfo=security::SigningInfo(), uint64_t flags=nfd::ROUTE_FLAG_CHILD_INHERIT)
 Register prefix with the connected NDN forwarder. More...
 
void removeAllPendingInterests ()
 Cancel all previously expressed Interests. More...
 
void removePendingInterest (const PendingInterestId *pendingInterestId)
 Cancel previously expressed Interest. More...
 
RegisteredPrefixHandle setInterestFilter (const InterestFilter &interestFilter, const InterestCallback &onInterest, const RegisterPrefixFailureCallback &onFailure, const security::SigningInfo &signingInfo=security::SigningInfo(), uint64_t flags=nfd::ROUTE_FLAG_CHILD_INHERIT)
 Set InterestFilter to dispatch incoming matching interest to onInterest callback and register the filtered prefix with the connected NDN forwarder. More...
 
RegisteredPrefixHandle setInterestFilter (const InterestFilter &interestFilter, const InterestCallback &onInterest, const RegisterPrefixSuccessCallback &onSuccess, const RegisterPrefixFailureCallback &onFailure, const security::SigningInfo &signingInfo=security::SigningInfo(), uint64_t flags=nfd::ROUTE_FLAG_CHILD_INHERIT)
 Set InterestFilter to dispatch incoming matching interest to onInterest callback and register the filtered prefix with the connected NDN forwarder. More...
 
InterestFilterHandle setInterestFilter (const InterestFilter &interestFilter, const InterestCallback &onInterest)
 Set InterestFilter to dispatch incoming matching interest to onInterest callback. More...
 
void shutdown ()
 Shutdown face operations. More...
 
void unlink ()
 unlink the broadcast media if previously linked More...
 
void unregisterPrefix (const RegisteredPrefixId *registeredPrefixId, const UnregisterPrefixSuccessCallback &onSuccess, const UnregisterPrefixFailureCallback &onFailure)
 Unregister prefix from RIB. More...
 
void unsetInterestFilter (const RegisteredPrefixId *registeredPrefixId)
 Remove the registered prefix entry with the registeredPrefixId. More...
 
void unsetInterestFilter (const InterestFilterId *interestFilterId)
 Remove previously set InterestFilter from library's FIB. More...
 

Public Attributes

Signal< DummyClientFace, DataonSendData
 emits whenever a Data packet is sent More...
 
Signal< DummyClientFace, InterestonSendInterest
 emits whenever an Interest is sent More...
 
Signal< DummyClientFace, lp::NackonSendNack
 emits whenever a Nack is sent More...
 
std::vector< DatasentData
 Data sent out of this DummyClientFace. More...
 
std::vector< InterestsentInterests
 Interests sent out of this DummyClientFace. More...
 
std::vector< lp::NacksentNacks
 Nacks sent out of this DummyClientFace. More...
 

Protected Member Functions

shared_ptr< Transport > getTransport ()
 

Detailed Description

a client-side face for unit testing

Definition at line 34 of file dummy-client-face.hpp.

Constructor & Destructor Documentation

ndn::util::DummyClientFace::DummyClientFace ( const Options options = Options())
explicit

Create a dummy face with internal IO service.

Definition at line 98 of file dummy-client-face.cpp.

ndn::util::DummyClientFace::DummyClientFace ( KeyChain &  keyChain,
const Options options = Options() 
)
explicit

Create a dummy face with internal IO service and the specified KeyChain.

Definition at line 106 of file dummy-client-face.cpp.

ndn::util::DummyClientFace::DummyClientFace ( boost::asio::io_service &  ioService,
const Options options = Options() 
)
explicit

Create a dummy face with the provided IO service.

Definition at line 113 of file dummy-client-face.cpp.

ndn::util::DummyClientFace::DummyClientFace ( boost::asio::io_service &  ioService,
KeyChain &  keyChain,
const Options options = Options() 
)

Create a dummy face with the provided IO service and the specified KeyChain.

Definition at line 121 of file dummy-client-face.cpp.

ndn::util::DummyClientFace::~DummyClientFace ( )

Definition at line 128 of file dummy-client-face.cpp.

Member Function Documentation

PendingInterestHandle ndn::Face::expressInterest ( const Interest interest,
const DataCallback afterSatisfied,
const NackCallback afterNacked,
const TimeoutCallback afterTimeout 
)
inherited

Express Interest.

Parameters
interestthe Interest; a copy will be made, so that the caller is not required to maintain the argument unchanged
afterSatisfiedfunction to be invoked if Data is returned
afterNackedfunction to be invoked if Network NACK is returned
afterTimeoutfunction to be invoked if neither Data nor Network NACK is returned within InterestLifetime
Exceptions
OversizedPacketErrorencoded Interest size exceeds MAX_NDN_PACKET_SIZE
Returns
A handle for canceling the pending Interest.

Definition at line 177 of file face.cpp.

boost::asio::io_service& ndn::Face::getIoService ( )
inlineinherited
Returns
reference to io_service object

Definition at line 479 of file face.hpp.

size_t ndn::Face::getNPendingInterests ( ) const
inherited

Get number of pending Interests.

Definition at line 209 of file face.cpp.

shared_ptr< Transport > ndn::Face::getTransport ( )
protectedinherited
Returns
underlying transport

Definition at line 171 of file face.cpp.

void ndn::util::DummyClientFace::linkTo ( DummyClientFace other)

link another DummyClientFace through a broadcast media

Definition at line 290 of file dummy-client-face.cpp.

void ndn::Face::processEvents ( time::milliseconds  timeout = time::milliseconds::zero(),
bool  keepThread = false 
)
inlineinherited

Process any data to receive or call timeout callbacks.

This call will block forever (default timeout == 0) to process IO on the face. To exit cleanly on a producer, unset any Interest filters with unsetInterestFilter() and wait for processEvents() to return. To exit after an error, one can call shutdown(). In consumer applications, processEvents() will return when all expressed Interests have been satisfied, Nacked, or timed out. To terminate earlier, a consumer application should call removePendingInterests() for all previously expressed and still-pending Interests.

If a positive timeout is specified, then processEvents() will exit after this timeout, provided it is not stopped earlier with shutdown() or when all active events finish. processEvents() can be called repeatedly, if desired.

If a negative timeout is specified, then processEvents will not block and will process only pending events.

Parameters
timeoutmaximum time to block the thread
keepThreadKeep thread in a blocked state (in event processing), even when there are no outstanding events (e.g., no Interest/Data is expected). If timeout is zero and this parameter is true, the only way to stop processEvents() is to call shutdown().
Note
This may throw an exception for reading data or in the callback for processing the data. If you call this from an main event loop, you may want to catch and log/disregard all exceptions.
Exceptions
OversizedPacketErrorencoded packet size exceeds MAX_NDN_PACKET_SIZE

Definition at line 454 of file face.hpp.

void ndn::Face::put ( Data  data)
inherited

Publish data packet.

Parameters
datathe Data; a copy will be made, so that the caller is not required to maintain the argument unchanged

This method can be called to satisfy incoming Interests, or to add Data packet into the cache of the local NDN forwarder if forwarder is configured to accept unsolicited Data.

Exceptions
OversizedPacketErrorencoded Data size exceeds MAX_NDN_PACKET_SIZE

Definition at line 215 of file face.cpp.

void ndn::Face::put ( lp::Nack  nack)
inherited

Send a network NACK.

Parameters
nackthe Nack; a copy will be made, so that the caller is not required to maintain the argument unchanged
Exceptions
OversizedPacketErrorencoded Nack size exceeds MAX_NDN_PACKET_SIZE

Definition at line 223 of file face.cpp.

void ndn::util::DummyClientFace::receive ( const Interest interest)

cause the Face to receive an interest

Definition at line 253 of file dummy-client-face.cpp.

void ndn::util::DummyClientFace::receive ( const Data data)

cause the Face to receive a data

Definition at line 265 of file dummy-client-face.cpp.

void ndn::util::DummyClientFace::receive ( const lp::Nack nack)

cause the Face to receive a nack

Definition at line 276 of file dummy-client-face.cpp.

RegisteredPrefixHandle ndn::Face::registerPrefix ( const Name prefix,
const RegisterPrefixSuccessCallback onSuccess,
const RegisterPrefixFailureCallback onFailure,
const security::SigningInfo signingInfo = security::SigningInfo(),
uint64_t  flags = nfd::ROUTE_FLAG_CHILD_INHERIT 
)
inherited

Register prefix with the connected NDN forwarder.

This method only modifies forwarder's RIB and does not associate any onInterest callbacks. Use setInterestFilter method to dispatch incoming Interests to the right callbacks.

Parameters
prefixA prefix to register with the connected NDN forwarder
onSuccessA callback to be called when prefixRegister command succeeds
onFailureA callback to be called when prefixRegister command fails
signingInfo(optional) Signing parameters. When omitted, a default parameters used in the signature will be used.
flagsPrefix registration flags
Returns
A handle for unregistering the prefix.
See also
nfd::RouteFlags

Definition at line 273 of file face.cpp.

void ndn::Face::removeAllPendingInterests ( )
inherited

Cancel all previously expressed Interests.

Definition at line 201 of file face.cpp.

void ndn::Face::removePendingInterest ( const PendingInterestId *  pendingInterestId)
inherited

Cancel previously expressed Interest.

Parameters
pendingInterestIda handle returned by expressInterest.

Definition at line 193 of file face.cpp.

RegisteredPrefixHandle ndn::Face::setInterestFilter ( const InterestFilter interestFilter,
const InterestCallback onInterest,
const RegisterPrefixFailureCallback onFailure,
const security::SigningInfo signingInfo = security::SigningInfo(),
uint64_t  flags = nfd::ROUTE_FLAG_CHILD_INHERIT 
)
inherited

Set InterestFilter to dispatch incoming matching interest to onInterest callback and register the filtered prefix with the connected NDN forwarder.

This version of setInterestFilter combines setInterestFilter and registerPrefix operations and is intended to be used when only one filter for the same prefix needed to be set. When multiple names sharing the same prefix should be dispatched to different callbacks, use one registerPrefix call, followed (in onSuccess callback) by a series of setInterestFilter calls.

Parameters
interestFilterInterest filter (prefix part will be registered with the forwarder)
onInterestA callback to be called when a matching interest is received
onFailureA callback to be called when prefixRegister command fails
flags(optional) RIB flags
signingInfo(optional) Signing parameters. When omitted, a default parameters used in the signature will be used.
Returns
A handle for unregistering the prefix.

Definition at line 231 of file face.cpp.

RegisteredPrefixHandle ndn::Face::setInterestFilter ( const InterestFilter interestFilter,
const InterestCallback onInterest,
const RegisterPrefixSuccessCallback onSuccess,
const RegisterPrefixFailureCallback onFailure,
const security::SigningInfo signingInfo = security::SigningInfo(),
uint64_t  flags = nfd::ROUTE_FLAG_CHILD_INHERIT 
)
inherited

Set InterestFilter to dispatch incoming matching interest to onInterest callback and register the filtered prefix with the connected NDN forwarder.

This version of setInterestFilter combines setInterestFilter and registerPrefix operations and is intended to be used when only one filter for the same prefix needed to be set. When multiple names sharing the same prefix should be dispatched to different callbacks, use one registerPrefix call, followed (in onSuccess callback) by a series of setInterestFilter calls.

Parameters
interestFilterInterest filter (prefix part will be registered with the forwarder)
onInterestA callback to be called when a matching interest is received
onSuccessA callback to be called when prefixRegister command succeeds
onFailureA callback to be called when prefixRegister command fails
flags(optional) RIB flags
signingInfo(optional) Signing parameters. When omitted, a default parameters used in the signature will be used.
Returns
A handle for unregistering the prefix.

Definition at line 241 of file face.cpp.

InterestFilterHandle ndn::Face::setInterestFilter ( const InterestFilter interestFilter,
const InterestCallback onInterest 
)
inherited

Set InterestFilter to dispatch incoming matching interest to onInterest callback.

Parameters
interestFilterInterest
onInterestA callback to be called when a matching interest is received

This method modifies library's FIB only, and does not register the prefix with the forwarder. It will always succeed. To register prefix with the forwarder, use registerPrefix, or use the setInterestFilter overload taking two callbacks.

Returns
A handle for unsetting the Interest filter.

Definition at line 259 of file face.cpp.

void ndn::Face::shutdown ( )
inherited

Shutdown face operations.

This method cancels all pending operations and closes connection to NDN Forwarder.

Note that this method does not stop the io_service if it is shared between multiple Faces or with other IO objects (e.g., Scheduler).

Warning
Calling this method could cause outgoing packets to be lost. Producers that shut down immediately after sending a Data packet should instead use unsetInterestFilter() to shut down cleanly.

Definition at line 350 of file face.cpp.

void ndn::util::DummyClientFace::unlink ( )

unlink the broadcast media if previously linked

Definition at line 314 of file dummy-client-face.cpp.

void ndn::Face::unregisterPrefix ( const RegisteredPrefixId *  registeredPrefixId,
const UnregisterPrefixSuccessCallback onSuccess,
const UnregisterPrefixFailureCallback onFailure 
)
inherited

Unregister prefix from RIB.

unregisterPrefix will use the same credentials as original setInterestFilter/registerPrefix command

If registeredPrefixId was obtained using setInterestFilter, the corresponding InterestFilter will be unset too.

Parameters
registeredPrefixIda handle returned by registerPrefix
onSuccessCallback to be called when operation succeeds
onFailureCallback to be called when operation fails

Definition at line 303 of file face.cpp.

void ndn::Face::unsetInterestFilter ( const RegisteredPrefixId *  registeredPrefixId)
inherited

Remove the registered prefix entry with the registeredPrefixId.

This does not affect another registered prefix with a different registeredPrefixId, even it if has the same prefix name. If there is no entry with the registeredPrefixId, do nothing.

unsetInterestFilter will use the same credentials as original setInterestFilter/registerPrefix command

Parameters
registeredPrefixIda handle returned by registerPrefix

Definition at line 287 of file face.cpp.

void ndn::Face::unsetInterestFilter ( const InterestFilterId *  interestFilterId)
inherited

Remove previously set InterestFilter from library's FIB.

This method always succeeds and will NOT send any request to the connected forwarder.

Parameters
interestFilterIda handle returned by setInterestFilter.

Definition at line 295 of file face.cpp.

Member Data Documentation

Signal<DummyClientFace, Data> ndn::util::DummyClientFace::onSendData

emits whenever a Data packet is sent

After .put, .processEvents must be called before this signal would be emitted.

Definition at line 181 of file dummy-client-face.hpp.

Signal<DummyClientFace, Interest> ndn::util::DummyClientFace::onSendInterest

emits whenever an Interest is sent

After .expressInterest, .processEvents must be called before this signal would be emitted.

Definition at line 175 of file dummy-client-face.hpp.

Signal<DummyClientFace, lp::Nack> ndn::util::DummyClientFace::onSendNack

emits whenever a Nack is sent

After .put, .processEvents must be called before this signal would be emitted.

Definition at line 187 of file dummy-client-face.hpp.

std::vector<Data> ndn::util::DummyClientFace::sentData

Data sent out of this DummyClientFace.

Sent Data are appended to this container if options.enablePacketLogger is true. User of this class is responsible for cleaning up the container, if necessary. After .put, .processEvents must be called before the Data would show up here.

Definition at line 161 of file dummy-client-face.hpp.

std::vector<Interest> ndn::util::DummyClientFace::sentInterests

Interests sent out of this DummyClientFace.

Sent Interests are appended to this container if options.enablePacketLogger is true. User of this class is responsible for cleaning up the container, if necessary. After .expressInterest, .processEvents must be called before the Interest would show up here.

Definition at line 153 of file dummy-client-face.hpp.

std::vector<lp::Nack> ndn::util::DummyClientFace::sentNacks

Nacks sent out of this DummyClientFace.

Sent Nacks are appended to this container if options.enablePacketLogger is true. User of this class is responsible for cleaning up the container, if necessary. After .put, .processEvents must be called before the NACK would show up here.

Definition at line 169 of file dummy-client-face.hpp.