Implements Transport for datagram-based protocols. More...
#include <datagram-transport.hpp>
Public Types | |
typedef Protocol | protocol |
typedef uint64_t | EndpointId |
identifies an endpoint on the link More... | |
typedef TransportCounters | Counters |
counters provided by Transport More... | |
Public Member Functions | |
DatagramTransport (typename protocol::socket &&socket) | |
Construct datagram transport. More... | |
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 | setFaceAndLinkService (Face &face, LinkService &service) |
set Face and LinkService for Transport More... | |
const Face * | getFace () const |
const LinkService * | getLinkService () const |
LinkService * | getLinkService () |
virtual const Counters & | getCounters () const |
void | close () |
request the transport to be closed More... | |
void | send (Packet &&packet) |
send a link-layer packet More... | |
FaceUri | getLocalUri () const |
FaceUri | getRemoteUri () const |
ndn::nfd::FaceScope | getScope () const |
ndn::nfd::FacePersistency | getPersistency () const |
void | setPersistency (ndn::nfd::FacePersistency persistency) |
changes face persistency setting More... | |
ndn::nfd::LinkType | getLinkType () const |
ssize_t | getMtu () const |
TransportState | getState () const |
time::steady_clock::TimePoint | getExpirationTime () const |
Public Attributes | |
signal::Signal< Transport, TransportState, TransportState > | afterStateChange |
signals when transport state changes More... | |
Protected Member Functions | |
virtual void | doClose () override |
performs Transport specific operations to close the transport More... | |
virtual void | doSend (Transport::Packet &&packet) override |
performs Transport specific operations to send a packet More... | |
void | handleSend (const boost::system::error_code &error, size_t nBytesSent, const Block &payload) |
void | handleReceive (const boost::system::error_code &error, size_t nBytesReceived) |
void | processErrorCode (const boost::system::error_code &error) |
bool | hasBeenUsedRecently () const |
void | resetRecentUsage () |
NFD_LOG_INCLASS_DECLARE () | |
template<> | |
Transport::EndpointId | makeEndpointId (const protocol::endpoint &ep) |
template<> | |
Transport::EndpointId | makeEndpointId (const protocol::endpoint &ep) |
void | receive (Packet &&packet) |
receive a link-layer packet More... | |
void | setLocalUri (const FaceUri &uri) |
void | setRemoteUri (const FaceUri &uri) |
void | setScope (ndn::nfd::FaceScope scope) |
void | setLinkType (ndn::nfd::LinkType linkType) |
void | setMtu (ssize_t mtu) |
void | setState (TransportState newState) |
set transport state More... | |
void | setExpirationTime (const time::steady_clock::TimePoint &expirationTime) |
virtual void | beforeChangePersistency (ndn::nfd::FacePersistency newPersistency)=0 |
invoked before persistency is changed More... | |
Static Protected Member Functions | |
static EndpointId | makeEndpointId (const typename protocol::endpoint &ep) |
Protected Attributes | |
protocol::socket | m_socket |
protocol::endpoint | m_sender |
PacketCounter | nInPackets |
count of incoming packets More... | |
PacketCounter | nOutPackets |
count of outgoing packets More... | |
ByteCounter | nInBytes |
total incoming bytes More... | |
ByteCounter | nOutBytes |
total outgoing bytes More... | |
Implements Transport for datagram-based protocols.
Protocol | a datagram-based protocol in Boost.Asio |
Definition at line 45 of file datagram-transport.hpp.
|
inherited |
counters provided by Transport
Definition at line 137 of file transport.hpp.
|
inherited |
identifies an endpoint on the link
Definition at line 109 of file transport.hpp.
typedef Protocol nfd::face::DatagramTransport< Protocol, Addressing >::protocol |
Definition at line 48 of file datagram-transport.hpp.
|
explicit |
Construct datagram transport.
socket | Protocol-specific socket for the created transport |
Definition at line 103 of file datagram-transport.hpp.
|
protectedpure virtualinherited |
invoked before persistency is changed
std::invalid_argument | new persistency is not supported |
std::runtime_error | transition is disallowed |
Implemented in nfd::face::WebSocketTransport, nfd::face::EthernetTransport, nfd::face::InternalForwarderTransport, nfd::face::MulticastUdpTransport, nfd::face::UnixStreamTransport, nfd::face::UnicastUdpTransport, and nfd::face::TcpTransport.
|
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 86 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 115 of file datagram-transport.hpp.
|
overrideprotectedvirtual |
performs Transport specific operations to send a packet
packet | the packet, which must be a well-formed TLV block |
Implements nfd::face::Transport.
Definition at line 136 of file datagram-transport.hpp.
|
inlinevirtualinherited |
Reimplemented in nfd::face::WebSocketTransport.
Definition at line 350 of file transport.hpp.
|
inlineinherited |
time::steady_clock::TimePoint::max() | the transport has indefinite lifetime |
Definition at line 429 of file transport.hpp.
|
inlineinherited |
Definition at line 332 of file transport.hpp.
|
inlineinherited |
Definition at line 338 of file transport.hpp.
|
inlineinherited |
Definition at line 344 of file transport.hpp.
|
inlineinherited |
Definition at line 398 of file transport.hpp.
|
inlineinherited |
Definition at line 356 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 410 of file transport.hpp.
|
inlineinherited |
Definition at line 392 of file transport.hpp.
|
inlineinherited |
Definition at line 368 of file transport.hpp.
|
inlineinherited |
Definition at line 380 of file transport.hpp.
|
inlineinherited |
Definition at line 423 of file transport.hpp.
|
protected |
Definition at line 179 of file datagram-transport.hpp.
|
protected |
Definition at line 193 of file datagram-transport.hpp.
|
inlineprotected |
Definition at line 230 of file datagram-transport.hpp.
|
protected |
|
inlinestaticprotected |
Definition at line 244 of file datagram-transport.hpp.
|
protected |
Definition at line 92 of file multicast-udp-transport.cpp.
|
protected |
|
protected |
Definition at line 205 of file datagram-transport.hpp.
|
protectedinherited |
receive a link-layer packet
Definition at line 119 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 149 of file datagram-transport.hpp.
|
inlineprotected |
Definition at line 237 of file datagram-transport.hpp.
|
inherited |
send a link-layer packet
getState()
is neither UP nor DOWN Definition at line 99 of file transport.cpp.
|
inlineprotectedinherited |
Definition at line 435 of file transport.hpp.
|
inherited |
set Face and LinkService for Transport
Definition at line 76 of file transport.cpp.
|
inlineprotectedinherited |
Definition at line 404 of file transport.hpp.
|
inlineprotectedinherited |
Definition at line 362 of file transport.hpp.
|
inlineprotectedinherited |
Definition at line 416 of file transport.hpp.
|
inherited |
changes face persistency setting
Definition at line 131 of file transport.cpp.
|
inlineprotectedinherited |
Definition at line 374 of file transport.hpp.
|
inlineprotectedinherited |
Definition at line 386 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 150 of file transport.cpp.
|
inherited |
signals when transport state changes
Definition at line 254 of file transport.hpp.
|
protected |
Definition at line 92 of file datagram-transport.hpp.
|
protected |
Definition at line 91 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 82 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 66 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 90 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 73 of file transport.hpp.