Implements Transport for datagram-based protocols. More...
#include <daemon/face/datagram-transport.hpp>
Public Types | |
using | Counters = TransportCounters |
Counters provided by a transport. More... | |
typedef Protocol | protocol |
Public Member Functions | |
DatagramTransport (typename protocol::socket &&socket) | |
Construct datagram transport. More... | |
bool | canChangePersistencyTo (ndn::nfd::FacePersistency newPersistency) const |
check whether the face persistency can be changed to newPersistency More... | |
void | close () |
Request the transport to be closed. More... | |
virtual const Counters & | getCounters () const |
time::steady_clock::TimePoint | getExpirationTime () const |
const Face * | getFace () const |
const LinkService * | getLinkService () const |
LinkService * | getLinkService () |
ndn::nfd::LinkType | getLinkType () const |
FaceUri | getLocalUri () const |
ssize_t | getMtu () const |
ndn::nfd::FacePersistency | getPersistency () const |
FaceUri | getRemoteUri () const |
ndn::nfd::FaceScope | getScope () const |
ssize_t | getSendQueueCapacity () const |
ssize_t | getSendQueueLength () override |
TransportState | getState () const |
void | receiveDatagram (const uint8_t *buffer, size_t nBytesReceived, const boost::system::error_code &error) |
Receive datagram, translate buffer into packet, deliver to parent class. More... | |
void | send (const Block &packet) |
Send a link-layer packet. More... | |
void | setFaceAndLinkService (Face &face, LinkService &service) |
set Face and LinkService for Transport More... | |
void | setPersistency (ndn::nfd::FacePersistency newPersistency) |
changes face persistency setting More... | |
Public Attributes | |
signal::Signal< Transport, TransportState, TransportState > | afterStateChange |
signals when transport state changes More... | |
Protected Member Functions | |
virtual void | afterChangePersistency (ndn::nfd::FacePersistency oldPersistency) |
invoked after the persistency has been changed More... | |
virtual bool | canChangePersistencyToImpl (ndn::nfd::FacePersistency newPersistency) const |
invoked by canChangePersistencyTo to perform the check More... | |
void | doClose () override |
performs Transport specific operations to close the transport More... | |
void | doSend (const Block &packet) override |
performs Transport specific operations to send a packet More... | |
void | handleReceive (const boost::system::error_code &error, size_t nBytesReceived) |
void | handleSend (const boost::system::error_code &error, size_t nBytesSent) |
bool | hasRecentlyReceived () const |
template<> | |
EndpointId | makeEndpointId (const protocol::endpoint &ep) |
template<> | |
EndpointId | makeEndpointId (const protocol::endpoint &ep) |
void | processErrorCode (const boost::system::error_code &error) |
void | receive (const Block &packet, const EndpointId &endpoint=0) |
Pass a received link-layer packet to the upper layer for further processing. More... | |
void | resetRecentlyReceived () |
void | setExpirationTime (const time::steady_clock::TimePoint &expirationTime) |
void | setLinkType (ndn::nfd::LinkType linkType) |
void | setLocalUri (const FaceUri &uri) |
void | setMtu (ssize_t mtu) |
void | setRemoteUri (const FaceUri &uri) |
void | setScope (ndn::nfd::FaceScope scope) |
void | setSendQueueCapacity (ssize_t sendQueueCapacity) |
void | setState (TransportState newState) |
set transport state More... | |
Static Protected Member Functions | |
static EndpointId | makeEndpointId (const typename protocol::endpoint &ep) |
Protected Attributes | |
protocol::endpoint | m_sender |
protocol::socket | m_socket |
ByteCounter | nInBytes |
total incoming bytes More... | |
PacketCounter | nInPackets |
count of incoming packets More... | |
ByteCounter | nOutBytes |
total outgoing bytes More... | |
PacketCounter | nOutPackets |
count of outgoing packets More... | |
Implements Transport for datagram-based protocols.
Protocol | a datagram-based protocol in Boost.Asio |
Definition at line 46 of file datagram-transport.hpp.
|
inherited |
Counters provided by a transport.
Definition at line 114 of file transport.hpp.
typedef Protocol nfd::face::DatagramTransport< Protocol, Addressing >::protocol |
Definition at line 49 of file datagram-transport.hpp.
|
explicit |
Construct datagram transport.
socket | Protocol-specific socket for the created transport |
Definition at line 105 of file datagram-transport.hpp.
|
protectedvirtualinherited |
invoked after the persistency has been changed
The base class implementation does nothing. When overridden in a subclass, the function should update internal states after persistency setting has been changed.
Reimplemented in nfd::face::TcpTransport, nfd::face::UnicastEthernetTransport, and nfd::face::UnicastUdpTransport.
Definition at line 182 of file transport.cpp.
|
inherited |
check whether the face persistency can be changed to newPersistency
This function serves as the external API, and invokes the protected function canChangePersistencyToImpl to perform further checks if newPersistency
differs from the current persistency.
Definition at line 142 of file transport.cpp.
|
protectedvirtualinherited |
invoked by canChangePersistencyTo to perform the check
Base class implementation returns false.
newPersistency | the new persistency, guaranteed to be different from current persistency |
Reimplemented in nfd::face::TcpTransport, nfd::face::UnicastEthernetTransport, and nfd::face::UnicastUdpTransport.
Definition at line 158 of file transport.cpp.
|
inherited |
Request the transport to be closed.
This operation is effective only if transport is in UP or DOWN state, otherwise it has no effect. The transport changes state to CLOSING, and performs cleanup procedure. The state will be changed to CLOSED when cleanup is complete, which may happen synchronously or asynchronously.
Definition at line 79 of file transport.cpp.
|
overrideprotectedvirtual |
performs Transport specific operations to close the transport
This is invoked once by close()
after changing state to CLOSING. It will not be invoked by Transport class if the transport is already CLOSING or CLOSED.
When the cleanup procedure is complete, this method should change state to CLOSED. This transition can happen synchronously or asynchronously.
Implements nfd::face::Transport.
Definition at line 139 of file datagram-transport.hpp.
|
overrideprotectedvirtual |
performs Transport specific operations to send a packet
packet | the packet to be sent, can be assumed to be valid and well-formed |
Implements nfd::face::Transport.
Definition at line 160 of file datagram-transport.hpp.
|
inlinevirtualinherited |
Reimplemented in nfd::face::WebSocketTransport.
Definition at line 373 of file transport.hpp.
|
inlineinherited |
time::steady_clock::TimePoint::max() | the transport has indefinite lifetime |
Definition at line 457 of file transport.hpp.
|
inlineinherited |
Definition at line 355 of file transport.hpp.
|
inlineinherited |
Definition at line 361 of file transport.hpp.
|
inlineinherited |
Definition at line 367 of file transport.hpp.
|
inlineinherited |
Definition at line 421 of file transport.hpp.
|
inlineinherited |
Definition at line 379 of file transport.hpp.
|
inlineinherited |
MTU_UNLIMITED | transport has no limit on payload size |
This size is the maximum packet size that can be sent or received through this transport.
For a datagram-based transport, this is typically the Maximum Transmission Unit (MTU), after the overhead of headers introduced by the transport has been accounted for. For a stream-based transport, this is typically unlimited (MTU_UNLIMITED).
Definition at line 433 of file transport.hpp.
|
inlineinherited |
Definition at line 415 of file transport.hpp.
|
inlineinherited |
Definition at line 391 of file transport.hpp.
|
inlineinherited |
Definition at line 403 of file transport.hpp.
|
inlineinherited |
QUEUE_UNSUPPORTED | transport does not support queue capacity retrieval |
QUEUE_ERROR | transport was unable to retrieve the queue capacity |
Definition at line 439 of file transport.hpp.
|
overridevirtual |
QUEUE_UNSUPPORTED | transport does not support queue length retrieval |
QUEUE_ERROR | transport was unable to retrieve the queue length |
Reimplemented from nfd::face::Transport.
Definition at line 128 of file datagram-transport.hpp.
|
inlineinherited |
Definition at line 451 of file transport.hpp.
|
protected |
Definition at line 201 of file datagram-transport.hpp.
|
protected |
Definition at line 214 of file datagram-transport.hpp.
|
protected |
Definition at line 248 of file datagram-transport.hpp.
|
protected |
|
staticprotected |
Definition at line 262 of file datagram-transport.hpp.
|
protected |
Definition at line 195 of file multicast-udp-transport.cpp.
|
protected |
Definition at line 224 of file datagram-transport.hpp.
|
protectedinherited |
Pass a received link-layer packet to the upper layer for further processing.
packet | the received packet, must be a valid and well-formed TLV block |
endpoint | the source endpoint |
Definition at line 113 of file transport.cpp.
void nfd::face::DatagramTransport< T, U >::receiveDatagram | ( | const uint8_t * | buffer, |
size_t | nBytesReceived, | ||
const boost::system::error_code & | error | ||
) |
Receive datagram, translate buffer into packet, deliver to parent class.
Definition at line 173 of file datagram-transport.hpp.
|
protected |
Definition at line 255 of file datagram-transport.hpp.
|
inherited |
Send a link-layer packet.
packet | the packet to be sent, must be a valid and well-formed TLV block |
Definition at line 92 of file transport.cpp.
|
inlineprotectedinherited |
Definition at line 463 of file transport.hpp.
|
inherited |
set Face and LinkService for Transport
Definition at line 69 of file transport.cpp.
|
inlineprotectedinherited |
Definition at line 427 of file transport.hpp.
|
inlineprotectedinherited |
Definition at line 385 of file transport.hpp.
|
protectedinherited |
Definition at line 126 of file transport.cpp.
|
inherited |
changes face persistency setting
Definition at line 164 of file transport.cpp.
|
inlineprotectedinherited |
Definition at line 397 of file transport.hpp.
|
inlineprotectedinherited |
Definition at line 409 of file transport.hpp.
|
inlineprotectedinherited |
Definition at line 445 of file transport.hpp.
|
protectedinherited |
set transport state
Only the following transitions are valid: UP->DOWN, DOWN->UP, UP/DOWN->CLOSING/FAILED, CLOSING/FAILED->CLOSED
std::runtime_error | transition is invalid. |
Definition at line 187 of file transport.cpp.
|
inherited |
signals when transport state changes
Definition at line 243 of file transport.hpp.
|
protected |
Definition at line 94 of file datagram-transport.hpp.
|
protected |
Definition at line 93 of file datagram-transport.hpp.
|
inherited |
total incoming bytes
This counter includes headers imposed by NFD (such as NDNLP), but excludes overhead of underlying protocol (such as IP header). For a datagram-based transport, an incoming packet that cannot be parsed as TLV would not be counted.
Definition at line 78 of file transport.hpp.
|
inherited |
count of incoming packets
A 'packet' typically means a top-level TLV block. For a datagram-based transport, an incoming packet that cannot be parsed as TLV would not be counted.
Definition at line 62 of file transport.hpp.
|
inherited |
total outgoing bytes
This counter includes headers imposed by NFD (such as NDNLP), but excludes overhead of underlying protocol (such as IP header). This counter is increased only if transport is UP.
Definition at line 86 of file transport.hpp.
|
inherited |
count of outgoing packets
A 'packet' typically means a top-level TLV block. This counter is incremented only if transport is UP.
Definition at line 69 of file transport.hpp.