This class holds constructor-time initialization arguments for SipStack. More...

#include <SipStack.hxx>

Public Member Functions
	SipStackOptions ()

Public Attributes
Security *	mSecurity

const DnsStub::NameserverList *	mExtraNameserverList

AsyncProcessHandler *	mAsyncProcessHandler

bool	mStateless

AfterSocketCreationFuncPtr	mSocketFunc

Compression *	mCompression

FdPollGrp *	mPollGrp

bool	mUseDnsVip

Detailed Description

This class holds constructor-time initialization arguments for SipStack.

Most values are pointers, and default to zero unless otherwise indicated.

It has public members: mSecurity Security Object required by the stack for TLS, DTLS, SMIME and Identity-draft compliance. If empty the stack will not support these advanced security features. The compile flag USE_SSL is also required. The security object will be owned by the SipStack and deleted in the SipStack destructor.

mAsyncProcessHandler AsyncProcessHandler that will be invoked when Messages are posted to the stack. Posted messages are added to thread-safe queue, and then processed later within event loop. For example: SelectInterruptor.

mStateless This parameter does not appear to be used. Default false.

mSocketFunc A pointer to a function that will be called after a socket in the DNS or SIP transport layers of the stack has been created. This callback can be used to control low level socket options, such as Quality-of-Service/DSCP. Note: For SIP TCP sockets there is one call for the listen socket, and one (or two) calls for each connection created afterwards. For each inbound TCP connection the first callback is called immediately before the socket is connected, and if configured it is called again after the connect call has completed and before the first data is sent out. On some OS's you cannot set QOS until the socket is successfully connected. To enable this behavior call: Connection::setEnablePostConnectSocketFuncCall(); DNS sockets get one call each. With c-ares it comes before the socket connects, and the setting above adds a second call once it is connected; the bundled ares makes its one call after connecting.

mCompression Compression configuration object required for SigComp. If set to 0, then SigComp compression will be disabled. The SipStack takes ownership of this object, and will be deleted in the destructor.

mPollGrp Polling group to support file-io callbacks. See EventStackThread. The SipStack does NOT take ownership; the application (or a helper such as EventStackSimpleMgr) must release this object after the SipStack is destructed.

mUseDnsVip Set to true to enable Whitelisting of DNS entries. A feature that usually desired by UA's that want to stick to a known good server / dns result.

Definition at line 111 of file SipStack.hxx.

Constructor & Destructor Documentation

◆ SipStackOptions()

resip::SipStackOptions::SipStackOptions ( )

inline

Definition at line 114 of file SipStack.hxx.

Member Data Documentation

◆ mAsyncProcessHandler

AsyncProcessHandler* resip::SipStackOptions::mAsyncProcessHandler

Definition at line 124 of file SipStack.hxx.

◆ mCompression

Compression* resip::SipStackOptions::mCompression

Definition at line 127 of file SipStack.hxx.

◆ mExtraNameserverList

const DnsStub::NameserverList* resip::SipStackOptions::mExtraNameserverList

Definition at line 123 of file SipStack.hxx.

◆ mPollGrp

FdPollGrp* resip::SipStackOptions::mPollGrp

Definition at line 128 of file SipStack.hxx.

◆ mSecurity

Security* resip::SipStackOptions::mSecurity

Definition at line 122 of file SipStack.hxx.

◆ mSocketFunc

AfterSocketCreationFuncPtr resip::SipStackOptions::mSocketFunc

Definition at line 126 of file SipStack.hxx.

◆ mStateless

bool resip::SipStackOptions::mStateless

Definition at line 125 of file SipStack.hxx.

◆ mUseDnsVip

bool resip::SipStackOptions::mUseDnsVip

Definition at line 129 of file SipStack.hxx.

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

resip/stack/SipStack.hxx

Public Member Functions

Public Attributes