NS-3 based Named Data Networking (NDN) simulator
ndnSIM 2.3: NDN, CCN, CCNx, content centric networks
API Documentation
nfd::face::WebSocketTransport Class Referencefinal

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

#include <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...
- Public Types inherited from nfd::face::Transport
typedef uint64_t EndpointId
 identifies an endpoint on the link More...
typedef TransportCounters Counters
 counters provided by Transport More...

Public Member Functions

 WebSocketTransport (websocketpp::connection_hdl hdl, websocket::Server &server, time::milliseconds pingInterval)
virtual const CountersgetCounters () const override
void receiveMessage (const std::string &msg)
 Translates a message into a Block and delivers it to the link service. More...
void handlePong ()
void handlePongTimeout ()
- Public Member Functions inherited from nfd::face::Transport
 Transport ()
 constructor More...
virtual ~Transport ()
void setFaceAndLinkService (Face &face, LinkService &service)
 set Face and LinkService for Transport More...
const FacegetFace () const
const LinkServicegetLinkService () const
LinkServicegetLinkService ()
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

Protected Member Functions

virtual void beforeChangePersistency (ndn::nfd::FacePersistency newPersistency) final
 invoked before persistency is changed More...
virtual void doClose () final
 performs Transport specific operations to close the transport More...
- Protected Member Functions inherited from nfd::face::Transport
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)

Additional Inherited Members

- Public Attributes inherited from nfd::face::Transport
signal::Signal< Transport, TransportState, TransportStateafterStateChange
 signals when transport state changes More...
- Protected Attributes inherited from nfd::face::TransportCounters
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...
- Protected Attributes inherited from nfd::face::WebSocketTransportCounters
PacketCounter nOutPings
 count of outgoing Pings More...
PacketCounter nInPongs
 count of incoming Pongs More...

Detailed Description

A Transport that communicates on a WebSocket connection.

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

Member Typedef Documentation

◆ Counters

Constructor & Destructor Documentation

◆ WebSocketTransport()

Member Function Documentation

◆ getCounters()

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

Reimplemented from nfd::face::Transport.

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

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

References ndn::Block::fromBuffer(), NFD_LOG_FACE_TRACE, NFD_LOG_FACE_WARN, nfd::face::WebSocketTransportCounters::nOutPings, nfd::face::Transport::receive(), and nfd::scheduler::schedule().

◆ handlePong()

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

◆ handlePongTimeout()

◆ beforeChangePersistency()

void nfd::face::WebSocketTransport::beforeChangePersistency ( ndn::nfd::FacePersistency  newPersistency)

invoked before persistency is changed

std::invalid_argumentnew persistency is not supported
std::runtime_errortransition is disallowed

Implements nfd::face::Transport.

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


◆ doClose()

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

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

References nfd::scheduler::ScopedEventId::cancel(), nfd::face::CLOSED, NFD_LOG_FACE_TRACE, and nfd::face::Transport::setState().

Referenced by handlePongTimeout().

The documentation for this class was generated from the following files: