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

#include <SipStack.hxx>

Collaboration diagram for resip::SipStackOptions:

Public Member Functions
	SipStackOptions ()
Public Attributes
Security *	mSecurity
const DnsStub::NameserverList *	mExtraNameserverList
AsyncProcessHandler *	mAsyncProcessHandler
bool	mStateless
AfterSocketCreationFuncPtr	mSocketFunc
Compression *	mCompression
FdPollGrp *	mPollGrp

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();

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.

Definition at line 96 of file SipStack.hxx.

Constructor & Destructor Documentation

resip::SipStackOptions::SipStackOptions ( ) [inline]

Definition at line 99 of file SipStack.hxx.

         : mSecurity(0), mExtraNameserverList(0),
           mAsyncProcessHandler(0), mStateless(false),
           mSocketFunc(0), mCompression(0), mPollGrp(0)
      {
      }