nfd::face::WebSocketTransport Class Referencefinal

A Transport that communicates on a WebSocket connection. More...

#include <daemon/face/websocket-transport.hpp>

+ Inheritance diagram for nfd::face::WebSocketTransport:
+ Collaboration diagram for nfd::face::WebSocketTransport:

Public Types

using Counters = WebSocketTransportCounters
 Counters provided by WebSocketTransport. More...
 

Public Member Functions

 WebSocketTransport (websocketpp::connection_hdl hdl, websocket::Server &server, time::milliseconds pingInterval)
 
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...
 
const CountersgetCounters () const final
 
time::steady_clock::time_point getExpirationTime () const noexcept
 Returns the expiration time of the transport. More...
 
const FacegetFace () const noexcept
 Returns the Face to which this transport is attached. More...
 
const LinkServicegetLinkService () const noexcept
 Returns the LinkService to which this transport is attached. More...
 
LinkServicegetLinkService () 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...
 
virtual ssize_t getSendQueueLength ()
 Returns the current send queue length of the transport (in octets). More...
 
TransportState getState () const noexcept
 Returns the current transport state. More...
 
void handlePong ()
 
void handlePongTimeout ()
 
void receiveMessage (const std::string &msg)
 Translates a message into a Block and delivers it to the link service. 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, TransportStateafterStateChange
 Called 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 () final
 Performs Transport specific operations to close the transport. More...
 
void receive (const Block &packet, const EndpointId &endpoint={})
 Pass a received link-layer packet to the upper layer for further processing. More...
 
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

ByteCounter nInBytes
 Total bytes received. More...
 
PacketCounter nInPackets
 Count of incoming packets. More...
 
PacketCounter nInPongs
 Count of incoming pongs. More...
 
ByteCounter nOutBytes
 Total bytes sent. More...
 
PacketCounter nOutPackets
 Count of outgoing packets. More...
 
PacketCounter nOutPings
 Count of outgoing pings. More...
 

Detailed Description

A Transport that communicates on a WebSocket connection.

Definition at line 53 of file websocket-transport.hpp.

Member Typedef Documentation

◆ Counters

Constructor & Destructor Documentation

◆ WebSocketTransport()

nfd::face::WebSocketTransport::WebSocketTransport ( websocketpp::connection_hdl  hdl,
websocket::Server server,
time::milliseconds  pingInterval 
)

Definition at line 52 of file websocket-transport.cpp.

Member Function Documentation

◆ afterChangePersistency()

void nfd::face::Transport::afterChangePersistency ( ndn::nfd::FacePersistency  oldPersistency)
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.

◆ canChangePersistencyTo()

bool nfd::face::Transport::canChangePersistencyTo ( ndn::nfd::FacePersistency  newPersistency) const
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.

Returns
true if the change can be performed, false otherwise

Definition at line 130 of file transport.cpp.

◆ canChangePersistencyToImpl()

bool nfd::face::Transport::canChangePersistencyToImpl ( ndn::nfd::FacePersistency  newPersistency) const
protectedvirtualinherited

Invoked by canChangePersistencyTo to perform the check.

Base class implementation returns false.

Parameters
newPersistencythe 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.

◆ close()

void nfd::face::Transport::close ( )
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.

◆ doClose()

void nfd::face::WebSocketTransport::doClose ( )
finalprotectedvirtual

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 164 of file websocket-transport.cpp.

◆ getCounters()

const Counters& nfd::face::WebSocketTransport::getCounters ( ) const
inlinefinalvirtual

Reimplemented from nfd::face::Transport.

Definition at line 67 of file websocket-transport.hpp.

◆ getExpirationTime()

time::steady_clock::time_point nfd::face::Transport::getExpirationTime ( ) const
inlinenoexceptinherited

Returns the expiration time of the transport.

Return values
time::steady_clock::time_point::max()The transport has an indefinite lifetime.

Definition at line 315 of file transport.hpp.

◆ getFace()

const Face* nfd::face::Transport::getFace ( ) const
inlinenoexceptinherited

Returns the Face to which this transport is attached.

Definition at line 155 of file transport.hpp.

◆ getLinkService() [1/2]

const LinkService* nfd::face::Transport::getLinkService ( ) const
inlinenoexceptinherited

Returns the LinkService to which this transport is attached.

Definition at line 164 of file transport.hpp.

◆ getLinkService() [2/2]

LinkService* nfd::face::Transport::getLinkService ( )
inlinenoexceptinherited

Returns the LinkService to which this transport is attached.

Definition at line 173 of file transport.hpp.

◆ getLinkType()

ndn::nfd::LinkType nfd::face::Transport::getLinkType ( ) const
inlinenoexceptinherited

Returns the link type of the transport.

Definition at line 263 of file transport.hpp.

◆ getLocalUri()

FaceUri nfd::face::Transport::getLocalUri ( ) const
inlinenoexceptinherited

Returns a FaceUri representing the local endpoint.

Definition at line 209 of file transport.hpp.

◆ getMtu()

ssize_t nfd::face::Transport::getMtu ( ) const
inlinenoexceptinherited

Returns the maximum payload size.

Return values
MTU_UNLIMITEDThe 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 279 of file transport.hpp.

◆ getPersistency()

ndn::nfd::FacePersistency nfd::face::Transport::getPersistency ( ) const
inlinenoexceptinherited

Returns the current persistency setting of the transport.

Definition at line 236 of file transport.hpp.

◆ getRemoteUri()

FaceUri nfd::face::Transport::getRemoteUri ( ) const
inlinenoexceptinherited

Returns a FaceUri representing the remote endpoint.

Definition at line 218 of file transport.hpp.

◆ getScope()

ndn::nfd::FaceScope nfd::face::Transport::getScope ( ) const
inlinenoexceptinherited

Returns whether the transport is local or non-local for scope control purposes.

Definition at line 227 of file transport.hpp.

◆ getSendQueueCapacity()

ssize_t nfd::face::Transport::getSendQueueCapacity ( ) const
inlinenoexceptinherited

Returns the capacity of the send queue (in bytes).

Return values
QUEUE_UNSUPPORTEDThe transport does not support queue capacity retrieval.
QUEUE_ERRORThe transport was unable to retrieve the queue capacity.

Definition at line 290 of file transport.hpp.

◆ getSendQueueLength()

virtual ssize_t nfd::face::Transport::getSendQueueLength ( )
inlinevirtualinherited

Returns the current send queue length of the transport (in octets).

Return values
QUEUE_UNSUPPORTEDThe transport does not support queue length retrieval.
QUEUE_ERRORThe transport was unable to retrieve the queue length.

Reimplemented in nfd::face::StreamTransport< Protocol >, nfd::face::StreamTransport< boost::asio::ip::tcp >, nfd::face::StreamTransport< boost::asio::local::stream_protocol >, nfd::face::DatagramTransport< Protocol, Addressing >, nfd::face::DatagramTransport< boost::asio::ip::udp, Unicast >, nfd::face::DatagramTransport< boost::asio::ip::udp, Multicast >, nfd::face::TcpTransport, and nfd::face::MulticastUdpTransport.

Definition at line 326 of file transport.hpp.

◆ getState()

TransportState nfd::face::Transport::getState ( ) const
inlinenoexceptinherited

Returns the current transport state.

Definition at line 300 of file transport.hpp.

◆ handlePong()

void nfd::face::WebSocketTransport::handlePong ( )

Definition at line 132 of file websocket-transport.cpp.

◆ handlePongTimeout()

void nfd::face::WebSocketTransport::handlePongTimeout ( )

Definition at line 140 of file websocket-transport.cpp.

◆ receive()

void nfd::face::Transport::receive ( const Block &  packet,
const EndpointId endpoint = {} 
)
protectedinherited

Pass a received link-layer packet to the upper layer for further processing.

Parameters
packetThe received packet, must be a valid and well-formed TLV block
endpointThe source endpoint, optional for unicast transports
Warning
Behavior is undefined if packet size exceeds the MTU limit.

Definition at line 101 of file transport.cpp.

◆ receiveMessage()

void nfd::face::WebSocketTransport::receiveMessage ( const std::string &  msg)

Translates a message into a Block and delivers it to the link service.

Definition at line 95 of file websocket-transport.cpp.

◆ send()

void nfd::face::Transport::send ( const Block &  packet)
inherited

Send a link-layer packet.

Parameters
packetthe packet to be sent, must be a valid and well-formed TLV block
Note
This operation has no effect if getState() is neither UP nor DOWN
Warning
Behavior is undefined if packet size exceeds the MTU limit

Definition at line 80 of file transport.cpp.

◆ setExpirationTime()

void nfd::face::Transport::setExpirationTime ( const time::steady_clock::time_point &  expirationTime)
inlineprotectednoexceptinherited

Definition at line 386 of file transport.hpp.

◆ setFaceAndLinkService()

void nfd::face::Transport::setFaceAndLinkService ( Face face,
LinkService service 
)
noexceptinherited

Set Face and LinkService for this transport.

Precondition
setFaceAndLinkService() has not been called.

Definition at line 57 of file transport.cpp.

◆ setLinkType()

void nfd::face::Transport::setLinkType ( ndn::nfd::LinkType  linkType)
inlineprotectednoexceptinherited

Definition at line 361 of file transport.hpp.

◆ setLocalUri()

void nfd::face::Transport::setLocalUri ( const FaceUri &  uri)
inlineprotectednoexceptinherited

Definition at line 343 of file transport.hpp.

◆ setMtu()

void nfd::face::Transport::setMtu ( ssize_t  mtu)
protectednoexceptinherited

Definition at line 114 of file transport.cpp.

◆ setPersistency()

void nfd::face::Transport::setPersistency ( ndn::nfd::FacePersistency  newPersistency)
inherited

Changes the persistency setting of the transport.

Definition at line 152 of file transport.cpp.

◆ setRemoteUri()

void nfd::face::Transport::setRemoteUri ( const FaceUri &  uri)
inlineprotectednoexceptinherited

Definition at line 349 of file transport.hpp.

◆ setScope()

void nfd::face::Transport::setScope ( ndn::nfd::FaceScope  scope)
inlineprotectednoexceptinherited

Definition at line 355 of file transport.hpp.

◆ setSendQueueCapacity()

void nfd::face::Transport::setSendQueueCapacity ( ssize_t  sendQueueCapacity)
inlineprotectednoexceptinherited

Definition at line 370 of file transport.hpp.

◆ setState()

void nfd::face::Transport::setState ( TransportState  newState)
protectedinherited

Set transport state.

Only the following transitions are valid: UP->DOWN, DOWN->UP, UP/DOWN->CLOSING/FAILED, CLOSING/FAILED->CLOSED

Exceptions
std::runtime_errortransition is invalid.

Definition at line 175 of file transport.cpp.

Member Data Documentation

◆ afterStateChange

signal::Signal<Transport, TransportState , TransportState > nfd::face::Transport::afterStateChange
inherited

Called when the transport state changes.

Definition at line 308 of file transport.hpp.

◆ nInBytes

ByteCounter nfd::face::TransportCounters::nInBytes
inherited

Total bytes received.

This counter includes headers imposed by NFD (such as NDNLP), but excludes the overhead of the underlying protocol (such as IP header).

For a datagram-based transport, an incoming packet that cannot be parsed as TLV will not be counted.

Definition at line 85 of file transport.hpp.

◆ nInPackets

PacketCounter nfd::face::TransportCounters::nInPackets
inherited

Count of incoming packets.

A 'packet' typically means a top-level TLV element.

For a datagram-based transport, an incoming packet that cannot be parsed as TLV will not be counted.

Definition at line 65 of file transport.hpp.

◆ nInPongs

PacketCounter nfd::face::WebSocketTransportCounters::nInPongs
inherited

Count of incoming pongs.

Definition at line 47 of file websocket-transport.hpp.

◆ nOutBytes

ByteCounter nfd::face::TransportCounters::nOutBytes
inherited

Total bytes sent.

This counter includes headers imposed by NFD (such as NDNLP), but excludes the overhead of the underlying protocol (such as IP header).

This counter is increased only when the transport is UP.

Definition at line 95 of file transport.hpp.

◆ nOutPackets

PacketCounter nfd::face::TransportCounters::nOutPackets
inherited

Count of outgoing packets.

A 'packet' typically means a top-level TLV element.

This counter is incremented only when the transport is UP.

Definition at line 74 of file transport.hpp.

◆ nOutPings

PacketCounter nfd::face::WebSocketTransportCounters::nOutPings
inherited

Count of outgoing pings.

Definition at line 45 of file websocket-transport.hpp.