25 #include "interest.hpp"
27 #include "forwarding-flags.hpp"
28 #include "encoding/wire-format.hpp"
29 #include "interest-filter.hpp"
30 #include "transport/transport.hpp"
39 typedef func_lib::function<void(const ptr_lib::shared_ptr<const Interest>&,
const ptr_lib::shared_ptr<Data>&)>
OnData;
44 typedef func_lib::function<void(const ptr_lib::shared_ptr<const Interest>&)>
OnTimeout;
49 typedef func_lib::function<void
50 (
const ptr_lib::shared_ptr<const Name>&,
const ptr_lib::shared_ptr<const Interest>&,
Transport&, uint64_t)>
OnInterest;
56 typedef func_lib::function<void
57 (
const ptr_lib::shared_ptr<const Name>&,
58 const ptr_lib::shared_ptr<const Interest>&,
Face&, uint64_t,
64 typedef func_lib::function<void(const ptr_lib::shared_ptr<const Name>&)>
OnRegisterFailed;
79 Face(
const ptr_lib::shared_ptr<Transport>& transport,
const ptr_lib::shared_ptr<const Transport::ConnectionInfo>& connectionInfo);
87 Face(
const char *host,
unsigned short port = 6363);
178 commandKeyChain_ = &keyChain;
179 commandCertificateName_ = certificateName;
191 commandCertificateName_ = certificateName;
234 (
const Name& prefix,
const OnInterestCallback& onInterest,
277 (
const InterestFilter& filter,
const OnInterestCallback& onInterest);
339 send(
const uint8_t *encoding,
size_t encodingLength);
389 (
const ptr_lib::shared_ptr<const Name>& prefix,
390 const ptr_lib::shared_ptr<const Interest>& interest,
Face& face,
391 uint64_t interestFilterId,
392 const ptr_lib::shared_ptr<const InterestFilter>& filter,
397 Name commandCertificateName_;
func_lib::function< void(const ptr_lib::shared_ptr< const Interest > &)> OnTimeout
An OnTimeout function object is used to pass a callback to expressInterest.
Definition: face.hpp:44
Definition: transport.hpp:32
void setCommandCertificateName(const Name &certificateName)
Set the certificate name used to sign command interest (e.g.
Definition: face.hpp:189
Copyright (C) 2013-2015 Regents of the University of California.
Definition: common.hpp:35
func_lib::function< void(const ptr_lib::shared_ptr< const Name > &, const ptr_lib::shared_ptr< const Interest > &, Transport &, uint64_t)> OnInterest
Definition: face.hpp:50
The Face class provides the main methods for NDN communication.
Definition: face.hpp:72
void removeRegisteredPrefix(uint64_t registeredPrefixId)
Remove the registered prefix entry with the registeredPrefixId from the registered prefix table...
Definition: face.cpp:169
uint64_t expressInterest(const Interest &interest, const OnData &onData, const OnTimeout &onTimeout=OnTimeout(), WireFormat &wireFormat=*WireFormat::getDefaultWireFormat())
Send the Interest through the transport, read the entire response and call onData(interest, data).
Definition: face.cpp:97
A ForwardingFlags object holds the flags which specify how the forwarding daemon should forward an in...
Definition: forwarding-flags.hpp:34
void removePendingInterest(uint64_t pendingInterestId)
Remove the pending interest entry with the pendingInterestId from the pending interest table...
Definition: face.cpp:118
KeyChain is the main class of the security library.
Definition: key-chain.hpp:45
void putData(const Data &data, WireFormat &wireFormat=*WireFormat::getDefaultWireFormat())
The OnInterestCallback calls this to put a Data packet which satisfies an Interest.
Definition: face.cpp:194
void unsetInterestFilter(uint64_t interestFilterId)
Remove the interest filter entry which has the interestFilterId from the interest filter table...
Definition: face.cpp:188
A Name holds an array of Name::Component and represents an NDN name.
Definition: name.hpp:42
A Blob holds a pointer to an immutable byte array implemented as const std::vector.
Definition: blob.hpp:42
An Interest holds a Name and other fields for an interest.
Definition: interest.hpp:41
const uint8_t * buf() const
Return a const pointer to the first byte of the immutable byte array, or 0 if the pointer is null...
Definition: blob.hpp:138
static size_t getMaxNdnPacketSize()
Get the practical limit of the size of a network-layer packet.
Definition: face.hpp:379
Face()
Create a new Face for communication with an NDN hub using a default connection as follows...
Definition: face.cpp:84
void makeCommandInterest(Interest &interest, WireFormat &wireFormat=*WireFormat::getDefaultWireFormat())
Append a timestamp component and a random value component to interest's name.
Definition: face.cpp:124
size_t size() const
Return the length of the immutable byte array.
Definition: blob.hpp:126
uint64_t setInterestFilter(const InterestFilter &filter, const OnInterestCallback &onInterest)
Add an entry to the local interest filter table to call the onInterest callback for a matching incomi...
Definition: face.cpp:176
func_lib::function< void(const ptr_lib::shared_ptr< const Name > &, const ptr_lib::shared_ptr< const Interest > &, Face &, uint64_t, const ptr_lib::shared_ptr< const InterestFilter > &)> OnInterestCallback
An OnInterestCallback function object is used to pass a callback to setInterestFilter and optionally ...
Definition: face.hpp:59
uint64_t registerPrefix(const Name &prefix, const OnInterestCallback &onInterest, const OnRegisterFailed &onRegisterFailed, const ForwardingFlags &flags=ForwardingFlags(), WireFormat &wireFormat=*WireFormat::getDefaultWireFormat())
Register prefix with the connected NDN hub and call onInterest when a matching interest is received...
Definition: face.cpp:132
bool isLocal()
Check if the face is local based on the current connection through the Transport; some Transport may ...
Definition: face.cpp:213
void shutdown()
Shut down and disconnect this Face.
Definition: face.cpp:219
void processEvents()
Process any packets to receive and call callbacks such as onData, onInterest or onTimeout.
Definition: face.cpp:206
func_lib::function< void(const ptr_lib::shared_ptr< const Name > &)> OnRegisterFailed
An OnRegisterFailed function object is used to report when registerPrefix fails.
Definition: face.hpp:64
An InterestFilter holds a Name prefix and optional regex match expression for use in Face::setInteres...
Definition: interest-filter.hpp:33
void send(const Blob &encoding)
Send the encoded packet out through the face.
Definition: face.hpp:326
void setCommandSigningInfo(KeyChain &keyChain, const Name &certificateName)
Set the KeyChain and certificate name used to sign command interests (e.g.
Definition: face.hpp:176
func_lib::function< void(const ptr_lib::shared_ptr< const Interest > &, const ptr_lib::shared_ptr< Data > &)> OnData
An OnData function object is used to pass a callback to expressInterest.
Definition: face.hpp:34