resip::DtlsTransport Class Reference

#include <DtlsTransport.hxx>

Inheritance diagram for resip::DtlsTransport:

Public Member Functions
	RESIP_HeapCount (DtlsTransport)
	DtlsTransport (Fifo< TransactionMessage > &fifo, int portNum, IpVersion version, const Data &interfaceObj, Security &security, const Data &sipDomain, AfterSocketCreationFuncPtr socketFunc=0, Compression &compression=Compression::Disabled, const Data &certificateFilename="", const Data &privateKeyFilename="", const Data &privateKeyPassPhrase="")
virtual	~DtlsTransport ()
void	process (FdSet &fdset)
	If there is work to do, this is the method that does it.
bool	isReliable () const
bool	isDatagram () const
virtual void	buildFdSet (FdSet &fdset)
	Adds the Transport's socket FD to the appropriate read or write sets as applicable.
Public Member Functions inherited from resip::UdpTransport
	RESIP_HeapCount (UdpTransport)
	UdpTransport (Fifo< TransactionMessage > &fifo, int portNum, IpVersion version, StunSetting stun, const Data &interfaceObj, AfterSocketCreationFuncPtr socketFunc=nullptr, Compression &compression=Compression::Disabled, unsigned transportFlags=0)
virtual	~UdpTransport ()
virtual void	process ()
	Called after a message is added.
virtual bool	hasDataToSend () const
	If we return true, the TransactionController will set the timeout to zero so that process() is called immediately.
virtual void	setPollGrp (FdPollGrp *grp)
virtual void	setRcvBufLen (int buflen)
virtual void	processPollEvent (FdPollEventMask mask)
	Called by PollGrp when activity is possible.
bool	stunSendTest (const Tuple &dest)
	Send a STUN Binding Request to dest for public-address discovery.
StunResult	stunResult (Tuple &mappedAddress)
	Return the result of the most recent stunSendTest(); on StunResultSuccess, mappedAddress is filled with the discovered public address.
void	setExternalUnknownDatagramHandler (ExternalUnknownDatagramHandler *handler)
	Installs a handler for the unknown datagrams arriving on the udp transport.
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	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)
virtual void	invokeAfterSocketCreationFunc () const
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 ()

Static Public Attributes
static const unsigned long	DtlsReceiveTimeout = 250000
Static Public Attributes inherited from resip::UdpTransport
static constexpr int	MaxMessageSize = 65535

Additional Inherited Members
Public Types inherited from resip::UdpTransport
enum	StunResult { StunResultUnknown , StunResultSuccess , StunResultNoResponse , StunResultResponseParseFailed }
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 Member Functions inherited from resip::UdpTransport
void	processRxAll ()
	Add options RXALL (to try receive all readable data).
int	processRxRecv (Tuple &sender)
void	processRxParse (int len, const Tuple &sender)
	Parse the contents of {mRxBuffer} and do something with it.
void	processRxParseSip (char *buffer, int len, const Tuple &sender)
void	processTxAll ()
	Added support for TXNOW and TXALL.
void	processTxOne (SendData *data)
void	updateEvents ()
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)
Protected Attributes inherited from resip::UdpTransport
osc::Stack *	mSigcompStack
unsigned	mPollEventCnt
unsigned	mTxTryCnt
unsigned	mTxMsgCnt
unsigned	mTxFailCnt
unsigned	mRxTryCnt
unsigned	mRxMsgCnt
unsigned	mRxKeepaliveCnt
unsigned	mRxTransactionCnt
std::array< char, MaxMessageSize >	mRxBuffer {}
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 43 of file DtlsTransport.hxx.

Constructor & Destructor Documentation

DtlsTransport()

DtlsTransport::DtlsTransport	(	Fifo< TransactionMessage > &	fifo,
		int	portNum,
		IpVersion	version,
		const Data &	interfaceObj,
		Security &	security,
		const Data &	sipDomain,
		AfterSocketCreationFuncPtr	socketFunc = 0,
		Compression &	compression = Compression::Disabled,
		const Data &	certificateFilename = "",
		const Data &	privateKeyFilename = "",
		const Data &	privateKeyPassPhrase = ""
	)

Definition at line 79 of file DtlsTransport.cxx.

~DtlsTransport()

DtlsTransport::~DtlsTransport ( )

virtual

Definition at line 130 of file DtlsTransport.cxx.

Member Function Documentation

buildFdSet()

void DtlsTransport::buildFdSet ( FdSet &  fdset )

virtual

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

Reimplemented from resip::UdpTransport.

Definition at line 519 of file DtlsTransport.cxx.

isDatagram()

bool resip::DtlsTransport::isDatagram ( ) const

inlinevirtual

Reimplemented from resip::UdpTransport.

Definition at line 90 of file DtlsTransport.hxx.

isReliable()

bool resip::DtlsTransport::isReliable ( ) const

inlinevirtual

Reimplemented from resip::UdpTransport.

Definition at line 89 of file DtlsTransport.hxx.

process()

void DtlsTransport::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()

Reimplemented from resip::UdpTransport.

Definition at line 494 of file DtlsTransport.cxx.

RESIP_HeapCount()

resip::DtlsTransport::RESIP_HeapCount

(

DtlsTransport

)

Member Data Documentation

DtlsReceiveTimeout

const unsigned long resip::DtlsTransport::DtlsReceiveTimeout = 250000

static

Definition at line 93 of file DtlsTransport.hxx.

---

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

• resip/stack/ssl/DtlsTransport.hxx
• resip/stack/ssl/DtlsTransport.cxx