#include <TcpBaseTransport.hxx>

Inheritance diagram for resip::TcpBaseTransport:

Public Member Functions
	TcpBaseTransport (Fifo< TransactionMessage > &fifo, int portNum, IpVersion version, const Data &interfaceName, AfterSocketCreationFuncPtr socketFunc, Compression &compression, unsigned transportFlags=0, const Data &netNs=Data::Empty)

virtual	~TcpBaseTransport ()

virtual void	processPollEvent (FdPollEventMask mask)
	Called by PollGrp when activity is possible.

virtual void	process (FdSet &fdset)
	If there is work to do, this is the method that does it.

virtual void	buildFdSet (FdSet &fdset)
	Adds the Transport's socket FD to the appropriate read or write sets as applicable.

virtual bool	isReliable () const

virtual bool	isDatagram () const

virtual void	process ()
	Version of process to be invoked periodically when using callback-based IO (via FdPollGrp).

virtual void	setPollGrp (FdPollGrp *grp)

virtual void	setRcvBufLen (int buflen)

ConnectionManager &	getConnectionManager ()

const ConnectionManager &	getConnectionManager () const

virtual void	invokeAfterSocketCreationFunc () const

Public Member Functions inherited from resip::InternalTransport
	InternalTransport (Fifo< TransactionMessage > &rxFifo, int portNum, IpVersion version, const Data &interfaceObj, AfterSocketCreationFuncPtr socketFunc=0, Compression &compression=Compression::Disabled, unsigned transportFlags=0, const Data &netNs=Data::Empty)

virtual	~InternalTransport ()

virtual bool	isFinished () const

virtual bool	hasDataToSend () const
	only applies to transports that shareStackProcessAndSelect

virtual bool	shareStackProcessAndSelect () const
	Returns true if this Transport should be included in the FdSet processing loop, false if the Transport will provide its own cycles.

virtual void	startOwnProcessing ()
	transports that returned false to shareStackProcessAndSelect() shouldn't put messages into the fifo until this is called

void	bind ()

virtual unsigned int	getFifoSize () const

virtual void	send (std::unique_ptr< SendData > data)

virtual void	poke ()
	Called when a writer is done adding messages to the TxFifo; this is used to interrupt the select call if the Transport is running in its own thread.

virtual void	setCongestionManager (CongestionManager *manager)

Public Member Functions inherited from resip::Transport
void	setSipMessageLoggingHandler (std::shared_ptr< SipMessageLoggingHandler > handler)

void	addSipMessageLoggingHandler (std::shared_ptr< SipMessageLoggingHandler > handler)

void	setSipMessageLoggingHandlers (const SipMessageLoggingHandlerList &handlers)

void	unsetSipMessageLoggingHandler () noexcept

SipMessageLoggingHandlerList	getSipMessageLoggingHandlers () const noexcept

	Transport (Fifo< TransactionMessage > &rxFifo, const GenericIPAddress &address, const Data &tlsDomain=Data::Empty, AfterSocketCreationFuncPtr socketFunc=nullptr, Compression &compression=Compression::Disabled)

	Transport (Fifo< TransactionMessage > &rxFifo, int portNum, IpVersion version, const Data &interfaceObj, const Data &tlsDomain=Data::Empty, AfterSocketCreationFuncPtr socketFunc=nullptr, Compression &compression=Compression::Disabled, unsigned transportFlags=0, const Data &netNs=Data::Empty)

virtual	~Transport ()

virtual void	onReload ()

std::unique_ptr< SendData >	makeSendData (const Tuple &tuple, const Data &data, const Data &tid, const Data &sigcompId=Data::Empty)

virtual unsigned int	getTimeTillNextProcessMS ()
	Returns the maximum timeout this object is willing to tolerate on the select call that is to be made, to prevent starvation of work that is not IO-based.

void	flowTerminated (const Tuple &flow, TransportFailure::FailureReason failureReason, int failureSubCode, const Data &failureString, const std::list< Data > additionalFailureStrings)
	Posts a ConnectionTerminated message to TransactionMessage Fifo.

void	keepAlivePong (const Tuple &flow)

void	fail (const Data &tid, TransportFailure::FailureReason reason=TransportFailure::Failure, int subCode=0)
	Posts a TransportFailure to the TransactionMessage Fifo.

void	setTcpConnectState (const Data &tid, TcpConnectState::State state)
	Posts a TcpConnectState to the TransactionMessage Fifo.

const Data &	interfaceName () const

int	port () const

bool	isV4 () const

IpVersion	ipVersion () const

const Data &	tlsDomain () const

const sockaddr &	boundInterface () const

const Tuple &	getTuple () const

const TransportType	transport () const

const Data &	netNs () const

virtual bool	hasSpecificContact () const

bool	basicCheck (const SipMessage &msg)
	Perform basic sanity checks on message.

void	makeFailedResponse (const SipMessage &msg, int responseCode=400, const char *warning=nullptr)

std::unique_ptr< SendData >	make503 (SipMessage &msg, uint16_t retryAfter)

std::unique_ptr< SendData >	make100 (SipMessage &msg)

void	setRemoteSigcompId (SipMessage &msg, Data &id)

virtual void	shutdown ()
	This starts shutting-down procedures for this Transport.

virtual bool	isShuttingDown ()

bool	operator== (const Transport &rhs) const

void	callSocketFunc (Socket sock) const

bool	setDscp (int dscp)
	Sets the DSCP class this transport puts on its sockets, and returns whether it was accepted.

int	effectiveDscp () const
	The class to write to a socket right now, or -1 to leave it alone.

int	effectiveDscp (int wanted) const
	effectiveDscp() for a value the caller has already read.

void	applySocketOptions (Socket sock) const
	The one place a socket of this transport is configured.

void	applyDscpToOwnSockets ()
	Re-runs the per-socket set-up on every socket this transport holds – the listener, and each established connection.

CongestionManager::RejectionBehavior	getRejectionBehaviorForIncoming () const

void	flushStateMacFifo ()

uint32_t	getExpectedWaitForIncoming () const

virtual void	pushRxMsgUp (SipMessage *msg)

unsigned int	getKey () const

void	setKey (unsigned int pKey)

Public Member Functions inherited from resip::FdSetIOObserver
	FdSetIOObserver ()

virtual	~FdSetIOObserver ()

Public Member Functions inherited from resip::FdPollItemIf
	FdPollItemIf ()

virtual	~FdPollItemIf ()

Protected Member Functions
virtual void	init ()
	Performs constructor activities that depend on virtual functions specified by derived classes.

virtual Connection *	createConnection (const Tuple &who, Socket fd, bool server=false)=0
	Makes new Connection using provided socket.

void	processAllWriteRequests ()
	Forms a connection if one doesn't exist, moves requests to the appropriate connection's fifo.

int	processListen ()
	This doesn't exist anywhere that I can find? !kw! void sendFromRoundRobin(FdSet& fdset);.

Connection *	makeOutgoingConnection (const Tuple &dest, TransportFailure::FailureReason &failCode, int &subCode)

Protected Member Functions inherited from resip::InternalTransport
virtual Socket	getListenerSocket () const
	The transport's own listening or bound socket, or INVALID_SOCKET for a transport that holds none.

Protected Member Functions inherited from resip::Transport
void	drainDscpRefresh ()
	Serves a pending refresh and a pending report.

void	setTlsDomain (const Data &domain)

Static Protected Attributes
static const size_t	MaxWriteSize = 4096

static const size_t	MaxReadSize = 4096

Additional Inherited Members
Public Types inherited from resip::Transport
using	SipMessageLoggingHandlerList = std::vector< std::shared_ptr< SipMessageLoggingHandler > >

Static Public Member Functions inherited from resip::InternalTransport
static Socket	socket (TransportType type, IpVersion ipVer)

Static Public Member Functions inherited from resip::Transport
static void	error (int e)
	Generates a generic log for the platform specific socket error number.

static Data	errorToString (int e)

static void	stampReceived (SipMessage *request)

Protected Attributes inherited from resip::InternalTransport
Socket	mFd

SelectInterruptor	mSelectInterruptor

FdPollItemHandle	mInterruptorHandle

Fifo< SendData >	mTxFifo

ConsumerFifoBuffer< SendData >	mTxFifoOutBuffer

FdPollGrp *	mPollGrp

FdPollItemHandle	mPollItemHandle

Protected Attributes inherited from resip::Transport
Data	mInterface

Tuple	mTuple

CongestionManager *	mCongestionManager

ProducerFifoBuffer< TransactionMessage >	mStateMachineFifo

bool	mShuttingDown

AfterSocketCreationFuncPtr	mSocketFunc

Compression &	mCompression

unsigned	mTransportFlags

std::atomic< int >	mDscp { -1 }
	the class to write, -1 for "do not mark"

std::atomic< bool >	mDscpRefreshPending { false }
	Set by setDscp() when the value changes, cleared by the owning thread's refresh.

std::atomic< bool >	mDscpReportPending { false }
	Set by every setDscp() call, cleared by the owning thread's report, so a reload that changed nothing still says what the listener carries.

std::atomic< bool >	mWasMarkRequested { false }
	Whether this transport has asked a socket to carry a class that a clear would have to undo.

Detailed Description

Definition at line 13 of file TcpBaseTransport.hxx.

Constructor & Destructor Documentation

◆ TcpBaseTransport()

TcpBaseTransport::TcpBaseTransport	(	Fifo< TransactionMessage > &	fifo,
		int	portNum,
		IpVersion	version,
		const Data &	interfaceName,
		AfterSocketCreationFuncPtr	socketFunc,
		Compression &	compression,
		unsigned	transportFlags = `0`,
		const Data &	netNs = `Data::Empty`
	)

Definition at line 23 of file TcpBaseTransport.cxx.

◆ ~TcpBaseTransport()

TcpBaseTransport::~TcpBaseTransport ( )

virtual

Definition at line 44 of file TcpBaseTransport.cxx.

Member Function Documentation

◆ buildFdSet()

void TcpBaseTransport::buildFdSet ( FdSet & fdset )

virtual

Adds the Transport's socket FD to the appropriate read or write sets as applicable.

Implements resip::Transport.

Definition at line 142 of file TcpBaseTransport.cxx.

◆ createConnection()

virtual Connection * resip::TcpBaseTransport::createConnection	(	const Tuple &	who,
		Socket	fd,
		bool	server = `false`
	)

protectedpure virtual

Makes new Connection using provided socket.

Implemented in resip::TlsBaseTransport, resip::TcpTransport, resip::WssTransport, and resip::WsTransport.

◆ getConnectionManager() [1/2]

ConnectionManager & resip::TcpBaseTransport::getConnectionManager ( )

inline

Definition at line 35 of file TcpBaseTransport.hxx.

◆ getConnectionManager() [2/2]

const ConnectionManager & resip::TcpBaseTransport::getConnectionManager ( ) const

inline

Definition at line 36 of file TcpBaseTransport.hxx.

◆ init()

void TcpBaseTransport::init ( )

protectedvirtual

Performs constructor activities that depend on virtual functions specified by derived classes.

Derived classes should call this in their constructors.

Definition at line 68 of file TcpBaseTransport.cxx.

◆ invokeAfterSocketCreationFunc()

void TcpBaseTransport::invokeAfterSocketCreationFunc ( ) const

virtual

Reimplemented from resip::InternalTransport.

Definition at line 499 of file TcpBaseTransport.cxx.

◆ isDatagram()

virtual bool resip::TcpBaseTransport::isDatagram ( ) const

inlinevirtual

Implements resip::Transport.

Definition at line 30 of file TcpBaseTransport.hxx.

◆ isReliable()

virtual bool resip::TcpBaseTransport::isReliable ( ) const

inlinevirtual

Implements resip::Transport.

Definition at line 29 of file TcpBaseTransport.hxx.

◆ makeOutgoingConnection()

Connection * TcpBaseTransport::makeOutgoingConnection	(	const Tuple &	dest,
		TransportFailure::FailureReason &	failCode,
		int &	subCode
	)

protected

Definition at line 279 of file TcpBaseTransport.cxx.

◆ process() [1/2]

void TcpBaseTransport::process ( )

virtual

Version of process to be invoked periodically when using callback-based IO (via FdPollGrp).

Implements resip::Transport.

Definition at line 446 of file TcpBaseTransport.cxx.

◆ process() [2/2]

void TcpBaseTransport::process ( FdSet & fdset )

virtual

If there is work to do, this is the method that does it.

If the socket is readable, it is read. If the socket is writable and there are outgoing messages to be sent, they are sent.

Incoming messages are parsed and dispatched to the relevant entity. SIP messages will be posted to the TransactionMessage Fifo.

See also: sendData()

Parameters

fdset is the FdSet after select() has been called.

See also: FdSet::select()

Implements resip::Transport.

Definition at line 462 of file TcpBaseTransport.cxx.

◆ processAllWriteRequests()

void TcpBaseTransport::processAllWriteRequests ( )

protected

Forms a connection if one doesn't exist, moves requests to the appropriate connection's fifo.

Definition at line 371 of file TcpBaseTransport.cxx.

◆ processListen()

int TcpBaseTransport::processListen ( )

protected

This doesn't exist anywhere that I can find? !kw! void sendFromRoundRobin(FdSet& fdset);.

Returns 1 if created new connection, -1 if "bad" error, and 0 if nothing to do (EWOULDBLOCK)

Definition at line 161 of file TcpBaseTransport.cxx.

◆ processPollEvent()

void TcpBaseTransport::processPollEvent ( FdPollEventMask mask )

virtual

Called by PollGrp when activity is possible.

Implements resip::FdPollItemIf.

Definition at line 483 of file TcpBaseTransport.cxx.

◆ setPollGrp()

void TcpBaseTransport::setPollGrp ( FdPollGrp * grp )

virtual

Reimplemented from resip::InternalTransport.

Definition at line 120 of file TcpBaseTransport.cxx.

◆ setRcvBufLen()

void TcpBaseTransport::setRcvBufLen ( int buflen )

virtual

Reimplemented from resip::Transport.

Definition at line 492 of file TcpBaseTransport.cxx.

Member Data Documentation

◆ MaxReadSize

const size_t TcpBaseTransport::MaxReadSize = 4096

staticprotected

Definition at line 68 of file TcpBaseTransport.hxx.

◆ MaxWriteSize

const size_t TcpBaseTransport::MaxWriteSize = 4096

staticprotected

Definition at line 67 of file TcpBaseTransport.hxx.

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

resip/stack/TcpBaseTransport.hxx
resip/stack/TcpBaseTransport.cxx

Public Member Functions

Protected Member Functions

Static Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ TcpBaseTransport()

◆ ~TcpBaseTransport()

Member Function Documentation

◆ buildFdSet()

◆ createConnection()

◆ getConnectionManager() [1/2]

◆ getConnectionManager() [2/2]

◆ init()

◆ invokeAfterSocketCreationFunc()

◆ isDatagram()

◆ isReliable()

◆ makeOutgoingConnection()

◆ process() [1/2]

◆ process() [2/2]

◆ processAllWriteRequests()

◆ processListen()

◆ processPollEvent()

◆ setPollGrp()

◆ setRcvBufLen()

Member Data Documentation

◆ MaxReadSize

◆ MaxWriteSize