Implements Transport for datagram-based protocols. More...
#include <daemon/face/datagram-transport.hpp>
Public Types | |
using | addressing = Addressing |
using | Counters = TransportCounters |
Counters provided by a transport. More... | |
using | protocol = Protocol |
Public Member Functions | |
DatagramTransport (typename protocol::socket &&socket) | |
Construct datagram transport. More... | |
bool | canChangePersistencyTo (ndn::nfd::FacePersistency newPersistency) const |
Check whether the persistency can be changed to newPersistency . More... | |
void | close () |
Request the transport to be closed. More... | |
virtual const Counters & | getCounters () const |
time::steady_clock::time_point | getExpirationTime () const noexcept |
Returns the expiration time of the transport. More... | |
const Face * | getFace () const noexcept |
Returns the Face to which this transport is attached. More... | |
const LinkService * | getLinkService () const noexcept |
Returns the LinkService to which this transport is attached. More... | |
LinkService * | getLinkService () noexcept |
Returns the LinkService to which this transport is attached. More... | |
ndn::nfd::LinkType | getLinkType () const noexcept |
Returns the link type of the transport. More... | |
FaceUri | getLocalUri () const noexcept |
Returns a FaceUri representing the local endpoint. More... | |
ssize_t | getMtu () const noexcept |
Returns the maximum payload size. More... | |
ndn::nfd::FacePersistency | getPersistency () const noexcept |
Returns the current persistency setting of the transport. More... | |
FaceUri | getRemoteUri () const noexcept |
Returns a FaceUri representing the remote endpoint. More... | |
ndn::nfd::FaceScope | getScope () const noexcept |
Returns whether the transport is local or non-local for scope control purposes. More... | |
ssize_t | getSendQueueCapacity () const noexcept |
Returns the capacity of the send queue (in bytes). More... | |
ssize_t | getSendQueueLength () override |
Returns the current send queue length of the transport (in octets). More... | |
TransportState | getState () const noexcept |
Returns the current transport state. More... | |
void | receiveDatagram (span< const uint8_t > buffer, 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) noexcept |
Set Face and LinkService for this transport. More... | |
void | setPersistency (ndn::nfd::FacePersistency newPersistency) |
Changes the persistency setting of the transport. More... | |
Public Attributes | |
signal::Signal< Transport, TransportState, TransportState > | afterStateChange |
Signals when the 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 |
void | processErrorCode (const boost::system::error_code &error) |
void | receive (const Block &packet, const EndpointId &endpoint={}) |
Pass a received link-layer packet to the upper layer for further processing. More... | |
void | resetRecentlyReceived () |
void | setExpirationTime (const time::steady_clock::time_point &expirationTime) noexcept |
void | setLinkType (ndn::nfd::LinkType linkType) noexcept |
void | setLocalUri (const FaceUri &uri) noexcept |
void | setMtu (ssize_t mtu) noexcept |
void | setRemoteUri (const FaceUri &uri) noexcept |
void | setScope (ndn::nfd::FaceScope scope) noexcept |
void | setSendQueueCapacity (ssize_t sendQueueCapacity) noexcept |
void | setState (TransportState newState) |
Set transport state. More... | |
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 |
Addressing | The addressing mode, either Unicast or Multicast |
Definition at line 47 of file datagram-transport.hpp.
using nfd::face::DatagramTransport< Protocol, Addressing >::addressing = Addressing |
Definition at line 51 of file datagram-transport.hpp.
|
inherited |
Counters provided by a transport.
Definition at line 119 of file transport.hpp.
using nfd::face::DatagramTransport< Protocol, Addressing >::protocol = Protocol |
Definition at line 50 of file datagram-transport.hpp.
|
explicit |
Construct datagram transport.
socket | Protocol-specific socket for the created transport |
Definition at line 104 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::UnicastUdpTransport, nfd::face::UnicastEthernetTransport, and nfd::face::TcpTransport.
Definition at line 170 of file transport.cpp.
|
inherited |
Check whether the 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 130 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::UnicastUdpTransport, nfd::face::UnicastEthernetTransport, and nfd::face::TcpTransport.
Definition at line 146 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 67 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 138 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 159 of file datagram-transport.hpp.
|
inlinevirtualinherited |
Reimplemented in nfd::face::WebSocketTransport.
Definition at line 170 of file transport.hpp.
|
inlinenoexceptinherited |
Returns the expiration time of the transport.
time::steady_clock::time_point::max() | The transport has an indefinite lifetime. |
Definition at line 306 of file transport.hpp.
|
inlinenoexceptinherited |
Returns the Face to which this transport is attached.
Definition at line 146 of file transport.hpp.
|
inlinenoexceptinherited |
Returns the LinkService to which this transport is attached.
Definition at line 155 of file transport.hpp.
|
inlinenoexceptinherited |
Returns the LinkService to which this transport is attached.
Definition at line 164 of file transport.hpp.
|
inlinenoexceptinherited |
Returns the link type of the transport.
Definition at line 254 of file transport.hpp.
|
inlinenoexceptinherited |
Returns a FaceUri representing the local endpoint.
Definition at line 200 of file transport.hpp.
|
inlinenoexceptinherited |
Returns the maximum payload size.
MTU_UNLIMITED | The 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 270 of file transport.hpp.
|
inlinenoexceptinherited |
Returns the current persistency setting of the transport.
Definition at line 227 of file transport.hpp.
|
inlinenoexceptinherited |
Returns a FaceUri representing the remote endpoint.
Definition at line 209 of file transport.hpp.
|
inlinenoexceptinherited |
Returns whether the transport is local or non-local for scope control purposes.
Definition at line 218 of file transport.hpp.
|
inlinenoexceptinherited |
Returns the capacity of the send queue (in bytes).
QUEUE_UNSUPPORTED | The transport does not support queue capacity retrieval. |
QUEUE_ERROR | The transport was unable to retrieve the queue capacity. |
Definition at line 281 of file transport.hpp.
|
overridevirtual |
Returns the current send queue length of the transport (in octets).
QUEUE_UNSUPPORTED | The transport does not support queue length retrieval. |
QUEUE_ERROR | The transport was unable to retrieve the queue length. |
Reimplemented from nfd::face::Transport.
Definition at line 127 of file datagram-transport.hpp.
|
inlinenoexceptinherited |
Returns the current transport state.
Definition at line 291 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 |
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, optional for unicast transports |
Definition at line 101 of file transport.cpp.
void nfd::face::DatagramTransport< T, U >::receiveDatagram | ( | span< const uint8_t > | buffer, |
const boost::system::error_code & | error | ||
) |
Receive datagram, translate buffer into packet, deliver to parent class.
Definition at line 172 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 80 of file transport.cpp.
|
inlineprotectednoexceptinherited |
Definition at line 377 of file transport.hpp.
|
noexceptinherited |
Set Face and LinkService for this transport.
Definition at line 57 of file transport.cpp.
|
inlineprotectednoexceptinherited |
Definition at line 352 of file transport.hpp.
|
inlineprotectednoexceptinherited |
Definition at line 334 of file transport.hpp.
|
protectednoexceptinherited |
Definition at line 114 of file transport.cpp.
|
inherited |
Changes the persistency setting of the transport.
Definition at line 152 of file transport.cpp.
|
inlineprotectednoexceptinherited |
Definition at line 340 of file transport.hpp.
|
inlineprotectednoexceptinherited |
Definition at line 346 of file transport.hpp.
|
inlineprotectednoexceptinherited |
Definition at line 361 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 175 of file transport.cpp.
|
inherited |
Signals when the transport state changes.
Definition at line 299 of file transport.hpp.
|
protected |
Definition at line 93 of file datagram-transport.hpp.
|
protected |
Definition at line 92 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.