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

typedef WebSocketTransportCounters Counters
 counters provided by WebSocketTransport More...
 
typedef uint64_t EndpointId
 identifies an endpoint on the link 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 face persistency can be changed to newPersistency More...
 
void close ()
 request the transport to be closed More...
 
const CountersgetCounters () const final
 
time::steady_clock::TimePoint getExpirationTime () const
 
const FacegetFace () const
 
const LinkServicegetLinkService () const
 
LinkServicegetLinkService ()
 
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
 
TransportState getState () const
 
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 (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, TransportStateafterStateChange
 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 () final
 performs Transport specific operations to close the transport More...
 
void receive (Packet &&packet)
 receive a link-layer packet More...
 
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 setState (TransportState newState)
 set transport state More...
 

Protected Attributes

ByteCounter nInBytes
 total incoming bytes More...
 
PacketCounter nInPackets
 count of incoming packets More...
 
PacketCounter nInPongs
 count of incoming Pongs More...
 
ByteCounter nOutBytes
 total outgoing bytes 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 54 of file websocket-transport.hpp.

Member Typedef Documentation

typedef uint64_t nfd::face::Transport::EndpointId
inherited

identifies an endpoint on the link

Definition at line 109 of file transport.hpp.

Constructor & Destructor Documentation

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

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

Member Function Documentation

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::UnicastEthernetTransport, nfd::face::TcpTransport, and nfd::face::UnicastUdpTransport.

Definition at line 169 of file transport.cpp.

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

Returns
true if the change can be performed, false otherwise

Definition at line 129 of file transport.cpp.

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::UnicastEthernetTransport, nfd::face::TcpTransport, and nfd::face::UnicastUdpTransport.

Definition at line 145 of file transport.cpp.

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

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

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

Reimplemented from nfd::face::Transport.

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

time::steady_clock::TimePoint nfd::face::Transport::getExpirationTime ( ) const
inlineinherited
Returns
expiration time of the transport
Return values
time::steady_clock::TimePoint::max()the transport has indefinite lifetime

Definition at line 451 of file transport.hpp.

const Face * nfd::face::Transport::getFace ( ) const
inlineinherited
Returns
Face to which this Transport is attached

Definition at line 354 of file transport.hpp.

const LinkService * nfd::face::Transport::getLinkService ( ) const
inlineinherited
Returns
LinkService to which this Transport is attached

Definition at line 360 of file transport.hpp.

LinkService * nfd::face::Transport::getLinkService ( )
inlineinherited
Returns
LinkService to which this Transport is attached

Definition at line 366 of file transport.hpp.

ndn::nfd::LinkType nfd::face::Transport::getLinkType ( ) const
inlineinherited
Returns
whether face is point-to-point or multi-access

Definition at line 420 of file transport.hpp.

FaceUri nfd::face::Transport::getLocalUri ( ) const
inlineinherited
Returns
a FaceUri representing local endpoint

Definition at line 378 of file transport.hpp.

ssize_t nfd::face::Transport::getMtu ( ) const
inlineinherited
Returns
maximum payload size
Return values
MTU_UNLIMITEDtransport 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 432 of file transport.hpp.

ndn::nfd::FacePersistency nfd::face::Transport::getPersistency ( ) const
inlineinherited
Returns
face persistency setting

Definition at line 414 of file transport.hpp.

FaceUri nfd::face::Transport::getRemoteUri ( ) const
inlineinherited
Returns
a FaceUri representing remote endpoint

Definition at line 390 of file transport.hpp.

ndn::nfd::FaceScope nfd::face::Transport::getScope ( ) const
inlineinherited
Returns
whether face is local or non-local for scope control purpose

Definition at line 402 of file transport.hpp.

TransportState nfd::face::Transport::getState ( ) const
inlineinherited
Returns
transport state

Definition at line 445 of file transport.hpp.

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

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

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

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

void nfd::face::Transport::receive ( Packet &&  packet)
protectedinherited

receive a link-layer packet

Warning
undefined behavior if packet size exceeds MTU limit

Definition at line 117 of file transport.cpp.

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

void nfd::face::Transport::send ( Packet &&  packet)
inherited

send a link-layer packet

Note
This operation has no effect if getState() is neither UP nor DOWN
Warning
undefined behavior if packet size exceeds MTU limit

Definition at line 97 of file transport.cpp.

void nfd::face::Transport::setExpirationTime ( const time::steady_clock::TimePoint &  expirationTime)
inlineprotectedinherited

Definition at line 457 of file transport.hpp.

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

set Face and LinkService for Transport

Precondition
setFaceAndLinkService has not been called

Definition at line 74 of file transport.cpp.

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

Definition at line 426 of file transport.hpp.

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

Definition at line 384 of file transport.hpp.

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

Definition at line 438 of file transport.hpp.

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

changes face persistency setting

Definition at line 151 of file transport.cpp.

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

Definition at line 396 of file transport.hpp.

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

Definition at line 408 of file transport.hpp.

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

Member Data Documentation

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

signals when transport state changes

Definition at line 265 of file transport.hpp.

ByteCounter nfd::face::TransportCounters::nInBytes
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.

PacketCounter nfd::face::TransportCounters::nInPackets
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.

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

count of incoming Pongs

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

ByteCounter nfd::face::TransportCounters::nOutBytes
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.

PacketCounter nfd::face::TransportCounters::nOutPackets
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.

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

count of outgoing Pings

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