Implements Transport for stream-based protocols. More...
#include <daemon/face/stream-transport.hpp>
Public Types | |
typedef TransportCounters | Counters |
counters provided by Transport More... | |
typedef uint64_t | EndpointId |
identifies an endpoint on the link More... | |
typedef Protocol | protocol |
Public Member Functions | |
StreamTransport (typename protocol::socket &&socket) | |
Construct stream 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 | send (Packet &&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... | |
Static Public Attributes | |
static constexpr ssize_t | MIN_MTU = 64 |
minimum MTU that may be set on a transport 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 | deferredClose () |
void | doClose () override |
performs Transport specific operations to close the transport More... | |
void | doSend (Transport::Packet &&packet) override |
performs Transport specific operations to send a packet More... | |
size_t | getSendQueueBytes () const |
virtual void | handleError (const boost::system::error_code &error) |
void | handleReceive (const boost::system::error_code &error, size_t nBytesReceived) |
void | handleSend (const boost::system::error_code &error, size_t nBytesSent) |
void | processErrorCode (const boost::system::error_code &error) |
void | receive (Packet &&packet) |
receive a link-layer packet More... | |
void | resetReceiveBuffer () |
void | resetSendQueue () |
void | sendFromQueue () |
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... | |
void | startReceive () |
Protected Attributes | |
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 stream-based protocols.
Protocol | a stream-based protocol in Boost.Asio |
Definition at line 43 of file stream-transport.hpp.
|
inherited |
counters provided by Transport
Definition at line 146 of file transport.hpp.
|
inherited |
identifies an endpoint on the link
Definition at line 118 of file transport.hpp.
typedef Protocol nfd::face::StreamTransport< Protocol >::protocol |
Definition at line 46 of file stream-transport.hpp.
|
explicit |
Construct stream transport.
socket | Protocol-specific socket for the created transport |
Definition at line 111 of file stream-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 172 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 132 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 148 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 87 of file transport.cpp.
|
protected |
Definition at line 168 of file stream-transport.hpp.
|
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 136 of file stream-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 183 of file stream-transport.hpp.
|
inlinevirtualinherited |
Reimplemented in nfd::face::WebSocketTransport.
Definition at line 409 of file transport.hpp.
|
inlineinherited |
time::steady_clock::TimePoint::max() | the transport has indefinite lifetime |
Definition at line 500 of file transport.hpp.
|
inlineinherited |
Definition at line 391 of file transport.hpp.
|
inlineinherited |
Definition at line 397 of file transport.hpp.
|
inlineinherited |
Definition at line 403 of file transport.hpp.
|
inlineinherited |
Definition at line 457 of file transport.hpp.
|
inlineinherited |
Definition at line 415 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 469 of file transport.hpp.
|
inlineinherited |
Definition at line 451 of file transport.hpp.
|
inlineinherited |
Definition at line 427 of file transport.hpp.
|
inlineinherited |
Definition at line 439 of file transport.hpp.
|
protected |
Definition at line 330 of file stream-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 482 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 125 of file stream-transport.hpp.
|
inlineinherited |
Definition at line 494 of file transport.hpp.
|
protectedvirtual |
Reimplemented in nfd::face::TcpTransport.
Definition at line 300 of file stream-transport.hpp.
|
protected |
Definition at line 238 of file stream-transport.hpp.
|
protected |
Definition at line 208 of file stream-transport.hpp.
|
protected |
Definition at line 283 of file stream-transport.hpp.
|
protectedinherited |
receive a link-layer packet
Definition at line 120 of file transport.cpp.
|
protected |
Definition at line 314 of file stream-transport.hpp.
|
protected |
Definition at line 321 of file stream-transport.hpp.
|
inherited |
send a link-layer packet
getState()
is neither UP nor DOWN Definition at line 100 of file transport.cpp.
|
protected |
Definition at line 200 of file stream-transport.hpp.
|
inlineprotectedinherited |
Definition at line 506 of file transport.hpp.
|
inherited |
set Face and LinkService for Transport
Definition at line 77 of file transport.cpp.
|
inlineprotectedinherited |
Definition at line 463 of file transport.hpp.
|
inlineprotectedinherited |
Definition at line 421 of file transport.hpp.
|
inlineprotectedinherited |
Definition at line 475 of file transport.hpp.
|
inherited |
changes face persistency setting
Definition at line 154 of file transport.cpp.
|
inlineprotectedinherited |
Definition at line 433 of file transport.hpp.
|
inlineprotectedinherited |
Definition at line 445 of file transport.hpp.
|
inlineprotectedinherited |
Definition at line 488 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 177 of file transport.cpp.
|
protected |
Definition at line 227 of file stream-transport.hpp.
|
inherited |
signals when transport state changes
Definition at line 274 of file transport.hpp.
|
protected |
Definition at line 98 of file stream-transport.hpp.
|
staticinherited |
minimum MTU that may be set on a transport
This is done to ensure the NDNLPv2 fragmentation feature functions properly.
Definition at line 374 of file 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 83 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 67 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 91 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 74 of file transport.hpp.