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

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)

virtual const Counters &	getCounters () 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 ()

void	setFaceAndLinkService (Face &face, LinkService &service)
	set Face and LinkService for Transport More...

const Face *	getFace () const

const LinkService *	getLinkService () const

LinkService *	getLinkService ()

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

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)

Protected Attributes
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...

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

typedef WebSocketTransportCounters nfd::face::WebSocketTransport::Counters

counters provided by WebSocketTransport

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

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::WebSocketTransport::beforeChangePersistency ( ndn::nfd::FacePersistency newPersistency )

finalprotectedvirtual

invoked before persistency is changed

Exceptions

std::invalid_argument	new persistency is not supported
std::runtime_error	transition is disallowed

Implements nfd::face::Transport.

Definition at line 80 of file websocket-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 86 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 173 of file websocket-transport.cpp.

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

inlineoverridevirtual

Reimplemented from nfd::face::Transport.

Definition at line 109 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 429 of file transport.hpp.

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

inlineinherited

Returns: Face to which this Transport is attached

Definition at line 332 of file transport.hpp.

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

inlineinherited

Returns: LinkService to which this Transport is attached

Definition at line 338 of file transport.hpp.

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

inlineinherited

Returns: LinkService to which this Transport is attached

Definition at line 344 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 398 of file transport.hpp.

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

inlineinherited

Returns: a FaceUri representing local endpoint

Definition at line 356 of file transport.hpp.

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

inlineinherited

Returns: maximum payload size

Return values

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.

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

inlineinherited

Returns: face persistency setting

Definition at line 392 of file transport.hpp.

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

inlineinherited

Returns: a FaceUri representing remote endpoint

Definition at line 368 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 380 of file transport.hpp.

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

inlineinherited

Returns: transport state

Definition at line 423 of file transport.hpp.

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

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

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

Definition at line 148 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 119 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 103 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 99 of file transport.cpp.

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

inlineprotectedinherited

Definition at line 435 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 76 of file transport.cpp.

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

inlineprotectedinherited

Definition at line 404 of file transport.hpp.

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

inlineprotectedinherited

Definition at line 362 of file transport.hpp.

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

inlineprotectedinherited

Definition at line 416 of file transport.hpp.

void nfd::face::Transport::setPersistency ( ndn::nfd::FacePersistency persistency )

inherited

changes face persistency setting

Definition at line 131 of file transport.cpp.

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

inlineprotectedinherited

Definition at line 374 of file transport.hpp.

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

inlineprotectedinherited

Definition at line 386 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_error transition is invalid.

Definition at line 150 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 254 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.

NFD - Named Data Networking Forwarding Daemon 0.5.0 documentation

Public Types

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation