sipXtapiInternal.h File Reference

#include "tapi/sipXtapi.h"
#include "tapi/SipXMessageObserver.h"
#include "net/SipSession.h"
#include "net/SipUserAgent.h"
#include "net/SipSubscribeClient.h"
#include "utl/UtlDefs.h"
#include "utl/UtlContainable.h"
#include "os/OsRWMutex.h"
#include "os/OsReadLock.h"
#include "os/OsWriteLock.h"
#include "os/OsSysLog.h"
#include "os/OsMutex.h"
#include "os/OsMsgQ.h"
#include "os/OsNatKeepaliveListener.h"

Include dependency graph for sipXtapiInternal.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	MIC_SETTING
struct	SPEAKER_SETTING
struct	AEC_SETTING
struct	AGC_SETTING
struct	NOISE_REDUCTION_SETTING
struct	AUDIO_CODEC_PREFERENCES
struct	VIDEO_CODEC_PREFERENCES
struct	TONE_STATES
struct	SIPX_INSTANCE_DATA
struct	SIPX_CALL_DATA
struct	SIPX_CONF_DATA
struct	SIPX_LINE_DATA
struct	SIPX_INFO_DATA
struct	SIPX_PUBLISH_DATA
struct	SIPX_SUBSCRIPTION_DATA
class	SIPX_TRANSPORT_DATA
struct	EVENT_LISTENER_DATA
	internal sipXtapi structure that binds a an event callback proc with an instance pointer and user data More...
class	SecurityHelper
class	KeepaliveEventDispatcher

Macros
#define	MAX_TRANSPORT_NAME   32

Typedefs
typedef struct MIC_SETTING	MIC_SETTING
typedef struct SPEAKER_SETTING	SPEAKER_SETTING
typedef struct AEC_SETTING	AEC_SETTING
typedef struct AGC_SETTING	AGC_SETTING
typedef struct NOISE_REDUCTION_SETTING	NOISE_REDUCTION_SETTING
typedef struct AUDIO_CODEC_PREFERENCES	AUDIO_CODEC_PREFERENCES
typedef struct VIDEO_CODEC_PREFERENCES	VIDEO_CODEC_PREFERENCES
typedef struct TONE_STATES	TONE_STATES
typedef struct SIPX_INSTANCE_DATA	SIPX_INSTANCE_DATA
typedef enum SIPX_INTERNAL_CALLSTATE	SIPX_INTERNAL_CALLSTATE
typedef struct SIPX_CALL_DATA	SIPX_CALL_DATA
typedef enum CONF_HOLD_STATE	CONF_HOLD_STATE
typedef enum SIPX_LOCK_TYPE	SIPX_LOCK_TYPE
typedef void(*	sipxCallEventCallbackFn) (const void *pSrc, const char *szCallId, SipSession *pSession, const char *szRemoteAddress, SIPX_CALLSTATE_EVENT event, SIPX_CALLSTATE_CAUSE cause, void *pEventData, const char *assertedIdentity)
typedef void(*	sipxMediaCallbackFn) (const void *pSrc, const char *szCallId, const char *szRemoteAddress, SIPX_MEDIA_EVENT event, SIPX_MEDIA_CAUSE cause, SIPX_MEDIA_TYPE type, void *pEventData)
typedef void(*	sipxLineEventCallbackFn) (const void *pSrc, const char *szLineIdentifier, SIPX_LINESTATE_EVENT event, SIPX_LINESTATE_CAUSE cause, const char *bodyBytes)
typedef bool(*	sipxEventCallbackFn) (const void *pSrc, SIPX_EVENT_CATEGORY category, void *pInfo)

Enumerations
enum	SIPX_INTERNAL_CALLSTATE {   SIPX_INTERNAL_CALLSTATE_UNKNOWN = 0,   SIPX_INTERNAL_CALLSTATE_OUTBOUND_ATTEMPT,   SIPX_INTERNAL_CALLSTATE_INBOUND_ATEMPT,   SIPX_INTERNAL_CALLSTATE_CONNECTED,   SIPX_INTERNAL_CALLSTATE_HELD,   SIPX_INTERNAL_CALLSTATE_REMOTE_HELD,   SIPX_INTERNAL_CALLSTATE_BRIDGED,   SIPX_INTERNAL_CALLSTATE_DISCONNECTED,   SIPX_INTERNAL_CALLSTATE_DESTROYING }
enum	CONF_HOLD_STATE {   CONF_STATE_UNHELD = 0,   CONF_STATE_BRIDGING_HOLD,   CONF_STATE_NON_BRIDGING_HOLD }
enum	SIPX_LOCK_TYPE {   SIPX_LOCK_NONE,   SIPX_LOCK_READ,   SIPX_LOCK_WRITE }

Functions
void	sipxDisableListeners ()
	Disable all listener callbacks – events will be dropped. More...
void	sipxEnableListeners ()
	Enable all listener callbacks (default setting) More...
void	sipxCallDestroyAll (const SIPX_INST hInst)
	Destroy all calls and send simulated DESTROY events. More...
void	sipxConferenceDestroyAll (const SIPX_INST hInst)
	Remove/Destroy all Conferences. More...
void	sipxLineRemoveAll (const SIPX_INST hInst)
	Remove/Destroy all Lines. More...
void	sipxPublisherDestroyAll (const SIPX_INST hInst)
	Remove/Destroy all Publishers. More...
void	sipxSubscribeDestroyAll (const SIPX_INST hInst)
	Remove/Destroy all subscriptions. More...
void	sipxFireCallEvent (const void *pSrc, const char *szCallId, SipSession *pSession, const char *szRemoteAddress, SIPX_CALLSTATE_EVENT event, SIPX_CALLSTATE_CAUSE cause, void *pEventData=NULL, const char *szRemoteAssertedIdentity=NULL)
	Fire events to interested listeners (call events only). More...
void	sipxFireMediaEvent (const void *pSrc, const char *szCallId, const char *szRemoteAddress, SIPX_MEDIA_EVENT event, SIPX_MEDIA_CAUSE cause, SIPX_MEDIA_TYPE type, void *pEventData=NULL)
	Fires events to interested listener (media events only) More...
void	sipxFireKeepaliveEvent (const void *pSrc, SIPX_KEEPALIVE_EVENT event, SIPX_KEEPALIVE_CAUSE cause, SIPX_KEEPALIVE_TYPE type, const char *szRemoteAddress, int remotePort, int keepAliveSecs, const char *szMappedAddress, int mappedPort)
	Fires events to interested listener (keepalive events only) More...
void	sipxFireLineEvent (const void *pSrc, const char *szLineIdentifier, SIPX_LINESTATE_EVENT event, SIPX_LINESTATE_CAUSE cause, const char *bodyBytes=NULL)
	Fires a Line Event to the listeners. More...
bool	sipxFireEvent (const void *pSrc, SIPX_EVENT_CATEGORY category, void *pInfo)
	Bubbles up all non-line and non-call events to the application layer. More...
SIPX_INSTANCE_DATA *	findSessionByCallManager (const void *pCallManager)
SIPX_CALL_DATA *	sipxCallLookup (const SIPX_CALL hCall, SIPX_LOCK_TYPE type, const OsStackTraceLogger &oneBackInStack)
void	sipxCallReleaseLock (SIPX_CALL_DATA *, SIPX_LOCK_TYPE type, const OsStackTraceLogger &oneBackInStack)
void	sipxCallObjectFree (const SIPX_CALL hCall, const OsStackTraceLogger &oneBackInStack)
SIPX_CALL	sipxCallLookupHandle (const UtlString &callID, const void *pSrc)
void	destroyCallData (SIPX_CALL_DATA *pData)
UtlBoolean	validCallData (SIPX_CALL_DATA *pData)
UtlBoolean	sipxCallGetCommonData (SIPX_CALL hCall, SIPX_INSTANCE_DATA **pInst, UtlString *pStrCallId, UtlString *pStrRemoteAddress, UtlString *pLineId, UtlString *pGhostCallId=NULL, UtlString *pContactAddress=NULL)
SIPX_CONF	sipxCallGetConf (SIPX_CALL hCall)
SIPXTAPI_API UtlBoolean	sipxCallGetState (SIPX_CALL hCall, SIPX_CALLSTATE_EVENT &lastEvent, SIPX_CALLSTATE_CAUSE &lastCause, SIPX_INTERNAL_CALLSTATE &state)
UtlBoolean	sipxCallGetMediaState (SIPX_CALL hCall, SIPX_MEDIA_EVENT &lastLocalMediaAudioEvent, SIPX_MEDIA_EVENT &lastLocalMediaVideoEvent, SIPX_MEDIA_EVENT &lastRemoteMediaAudioEvent, SIPX_MEDIA_EVENT &lastRemoteMediaVideoEvent)
UtlBoolean	sipxCallSetMediaState (SIPX_CALL hCall, SIPX_MEDIA_EVENT event, SIPX_MEDIA_TYPE type)
UtlBoolean	sipxCallSetState (SIPX_CALL hCall, SIPX_CALLSTATE_EVENT event, SIPX_CALLSTATE_CAUSE cause)
SIPX_CONTACT_TYPE	sipxCallGetLineContactType (SIPX_CALL hCall)
SIPX_LINE_DATA *	sipxLineLookup (const SIPX_LINE hLine, SIPX_LOCK_TYPE type, const OsStackTraceLogger &oneBackInStack)
void	sipxLineReleaseLock (SIPX_LINE_DATA *pData, SIPX_LOCK_TYPE type, const OsStackTraceLogger &oneBackInStack)
void	sipxLineObjectFree (const SIPX_LINE hLine)
SIPX_LINE	sipxLineLookupHandle (const char *szLineURI, const char *requestUri)
SIPX_LINE	sipxLineLookupHandleByURI (const char *szURI)
UtlBoolean	validLineData (const SIPX_LINE_DATA *)
UtlBoolean	sipxAddCallHandleToConf (const SIPX_CALL hCall, const SIPX_CONF hConf)
UtlBoolean	sipxRemoveCallHandleFromConf (const SIPX_CONF hConf, const SIPX_CALL hCall)
SIPX_CONF_DATA *	sipxConfLookup (const SIPX_CONF hConf, SIPX_LOCK_TYPE type, const OsStackTraceLogger &oneBackInStack)
void	sipxConfReleaseLock (SIPX_CONF_DATA *pData, SIPX_LOCK_TYPE type, const OsStackTraceLogger &oneBackInStack)
void	sipxConfFree (const SIPX_CONF hConf)
UtlBoolean	validConfData (const SIPX_CONF_DATA *pData)
void	sipxIncSessionCount ()
void	sipxDecSessionCount ()
int	sipxGetSessionCount ()
UtlBoolean	sipxIsCallInFocus ()
SIPXTAPI_API SIPX_RESULT	sipxStructureIntegrityCheck ()
const char *	sipxContactTypeToString (SIPX_CONTACT_TYPE type)
const char *	sipxTransportTypeToString (SIPX_TRANSPORT_TYPE type)
void	sipxInfoFree (SIPX_INFO_DATA *pData)
	Frees the INFO structure allocated by a call to sipxCallSendInfo. More...
void	sipxInfoObjectFree (SIPX_INFO hInfo)
	Releases the INFO handle created by a call to sipxCallSendInfo. More...
void	sipxTransportFree (SIPX_TRANSPORT_DATA *pData)
	Frees the TRANSPORT structure allocated by a call to sipxConfigExternalTransportAdd. More...
void	sipxTransportObjectFree (SIPX_TRANSPORT hTransport)
	Releases the TRANSPORT handle created sipxConfigExternalTransportAdd Also cals sipxTransportFree. More...
void	sipxGetContactHostPort (SIPX_INSTANCE_DATA *pData, SIPX_CONTACT_TYPE contactType, Url &uri, SIPX_TRANSPORT_TYPE protocol)
SIPX_INFO_DATA *	sipxInfoLookup (const SIPX_INFO hInfo, SIPX_LOCK_TYPE type, const OsStackTraceLogger &oneBackInStack)
	Looks up the SIPX_INFO_DATA structure pointer, given the SIPX_INFO handle. More...
void	sipxInfoReleaseLock (SIPX_INFO_DATA *pData, SIPX_LOCK_TYPE type, const OsStackTraceLogger &oneBackInStack)
	Unlocks the mutex associated with the INFO DATA. More...
SIPX_PUBLISH_DATA *	sipxPublishLookup (const SIPX_PUB hPub, SIPX_LOCK_TYPE type, const OsStackTraceLogger &oneBackInStack)
void	sipxPublishReleaseLock (SIPX_PUBLISH_DATA *pData, SIPX_LOCK_TYPE type, const OsStackTraceLogger &oneBackInStack)
SIPX_SUBSCRIPTION_DATA *	sipxSubscribeLookup (const SIPX_SUB hSub, SIPX_LOCK_TYPE type, const OsStackTraceLogger &oneBackInStack)
void	sipxSubscribeReleaseLock (SIPX_SUBSCRIPTION_DATA *pData, SIPX_LOCK_TYPE type, const OsStackTraceLogger &oneBackInStack)
SIPX_TRANSPORT_DATA *	sipxTransportLookup (const SIPX_TRANSPORT hTransport, SIPX_LOCK_TYPE type)
	Looks up the SIPX_TRANSPORT_DATA structure pointer, given the SIPX_TRANSPORT handle. More...
void	sipxTransportReleaseLock (SIPX_TRANSPORT_DATA *pData, SIPX_LOCK_TYPE type)
	Unlocks the mutex associated with the TRANSPORT DATA. More...
void	sipxTransportDestroyAll (const SIPX_INST hInst)
	Destroy all external transports for a given instance. More...
SIPXTAPI_API void	sipxLogEntryAdd (OsSysLogPriority logLevel, const char *format,...)
	Adds a log entry to the system log - made necessary to add logging capability on the API level. More...
SIPXTAPI_API SIPX_RESULT	sipxConfigAllowMethod (const SIPX_INST hInst, const char *method, const bool bAllow=true)
	Utility function for setting allowed methods on a instance's user-agent. More...
SIPXTAPI_API SIPX_RESULT	sipxGetActiveCallIds (SIPX_INST hInst, int maxCalls, int &actualCalls, UtlString callIds[])
	Get the list of active calls for the specified call manager instance. More...
void	sipxSubscribeClientSubCallback (enum SipSubscribeClient::SubscriptionState newState, const char *earlyDialogHandle, const char *dialogHandle, void *applicationData, int responseCode, const char *responseText, long expiration, const SipMessage *subscribeResponse)
	Callback for subscription client state. More...
void	sipxSubscribeClientNotifyCallback (const char *earlyDialogHandle, const char *dialogHandle, void *applicationData, const SipMessage *notifyRequest)
	Callback for subscription client NOTIFY content. More...
SIPXTAPI_API SIPX_RESULT	sipxCheckForHandleLeaks ()
	Look for leaks in internal handles. More...
SIPXTAPI_API SIPX_RESULT	sipxFlushHandles ()
	Flush handles to remove peaks between test cases – this WILL leak memory. More...
SIPXTAPI_API SIPX_RESULT	sipxTranslateToneId (const SIPX_TONE_ID toneId, SIPX_TONE_ID &xlateId)
	Translate tone ids to implementation specific codes. More...
SIPXTAPI_API SIPX_RESULT	sipxCallGetConnectionMediaInterface (const SIPX_CALL hCall, void **ppInstData)
	Gets an CpMediaInterface pointer, associated with the call connection. More...
SIPXTAPI_API SIPX_RESULT	sipxConfigGetLocalAudioConnectionId (const SIPX_INST hInst, int &connectionId)
	Returns the 'local' connection id. More...
SIPXTAPI_API CpMediaInterface *	sipxCallGetCpMediaInterface (const SIPX_CALL hCall)
	Get pointer to Sipx media interface for call. More...
SIPXTAPI_API OsMsgQ *	sipxCallGetMediaConrolQueue (const SIPX_CALL hCall)
	Get pointer to Sipx media control message queue for call. More...
UtlBoolean	sipxCallSetRemoveInsteadofDrop (SIPX_CALL hCall)
UtlBoolean	sipxCallIsRemoveInsteadOfDropSet (SIPX_CALL hCall)
SIPX_RESULT	__sipxEventListenerAdd (const SIPX_INST hInst, SIPX_EVENT_CALLBACK_PROC pCallbackProc, void *pUserData)
SIPX_RESULT	__sipxEventListenerRemove (const SIPX_INST hInst, SIPX_EVENT_CALLBACK_PROC pCallbackProc, void *pUserData)
void	sipxUpdateListeners (SIPX_INST hOldInst, SIPX_INST hNewInst)
SIPXTAPI_API SIPX_RESULT	sipxConfigLoadSecurityRuntime ()
	Dynamically loads the following NSS runtime libraries, if they can be found: smime3.dll;nss3.dll;nspr4.dll;plc4.dll. More...
void	sipxCreateExternalTransportContacts (const SIPX_TRANSPORT_DATA *pData)
	Called from sipxConfigExternalTransportAdd, this function creates LOCAL, STUN, and RELAY contact records for the newly added transport mechanism. More...

Macro Definition Documentation

#define MAX_TRANSPORT_NAME   32

Typedef Documentation

typedef struct MIC_SETTING MIC_SETTING

typedef struct SPEAKER_SETTING SPEAKER_SETTING

typedef struct AEC_SETTING AEC_SETTING

typedef struct AGC_SETTING AGC_SETTING

typedef struct NOISE_REDUCTION_SETTING NOISE_REDUCTION_SETTING

typedef struct AUDIO_CODEC_PREFERENCES AUDIO_CODEC_PREFERENCES

typedef struct VIDEO_CODEC_PREFERENCES VIDEO_CODEC_PREFERENCES

typedef struct TONE_STATES TONE_STATES

typedef struct SIPX_INSTANCE_DATA SIPX_INSTANCE_DATA

typedef enum SIPX_INTERNAL_CALLSTATE SIPX_INTERNAL_CALLSTATE

typedef struct SIPX_CALL_DATA SIPX_CALL_DATA

typedef enum CONF_HOLD_STATE CONF_HOLD_STATE

typedef enum SIPX_LOCK_TYPE SIPX_LOCK_TYPE

typedef void(* sipxCallEventCallbackFn) (const void *pSrc, const char *szCallId, SipSession *pSession, const char *szRemoteAddress, SIPX_CALLSTATE_EVENT event, SIPX_CALLSTATE_CAUSE cause, void *pEventData, const char *assertedIdentity)

typedef void(* sipxMediaCallbackFn) (const void *pSrc, const char *szCallId, const char *szRemoteAddress, SIPX_MEDIA_EVENT event, SIPX_MEDIA_CAUSE cause, SIPX_MEDIA_TYPE type, void *pEventData)

typedef void(* sipxLineEventCallbackFn) (const void *pSrc, const char *szLineIdentifier, SIPX_LINESTATE_EVENT event, SIPX_LINESTATE_CAUSE cause, const char *bodyBytes)

typedef bool(* sipxEventCallbackFn) (const void *pSrc, SIPX_EVENT_CATEGORY category, void *pInfo)

Enumeration Type Documentation

enum SIPX_INTERNAL_CALLSTATE

Enumerator
SIPX_INTERNAL_CALLSTATE_UNKNOWN
SIPX_INTERNAL_CALLSTATE_OUTBOUND_ATTEMPT	Unknown call state.
SIPX_INTERNAL_CALLSTATE_INBOUND_ATEMPT	Early dialog: outbound.
SIPX_INTERNAL_CALLSTATE_CONNECTED	Early dialog: inbound.
SIPX_INTERNAL_CALLSTATE_HELD	Active call - remote audio.
SIPX_INTERNAL_CALLSTATE_REMOTE_HELD	both on hold due to a local hold
SIPX_INTERNAL_CALLSTATE_BRIDGED	Remotely held call.
SIPX_INTERNAL_CALLSTATE_DISCONNECTED	Locally held call, bridging.
SIPX_INTERNAL_CALLSTATE_DESTROYING	Disconnected or failed.

enum CONF_HOLD_STATE

Enumerator
CONF_STATE_UNHELD
CONF_STATE_BRIDGING_HOLD
CONF_STATE_NON_BRIDGING_HOLD

enum SIPX_LOCK_TYPE

Enumerator
SIPX_LOCK_NONE
SIPX_LOCK_READ
SIPX_LOCK_WRITE

Function Documentation

void sipxDisableListeners

(

)

Disable all listener callbacks – events will be dropped.

void sipxEnableListeners

(

)

Enable all listener callbacks (default setting)

void sipxCallDestroyAll

(

const SIPX_INST

hInst

)

Destroy all calls and send simulated DESTROY events.

void sipxConferenceDestroyAll

(

const SIPX_INST

hInst

)

Remove/Destroy all Conferences.

void sipxLineRemoveAll

(

const SIPX_INST

hInst

)

Remove/Destroy all Lines.

void sipxPublisherDestroyAll

(

const SIPX_INST

hInst

)

Remove/Destroy all Publishers.

void sipxSubscribeDestroyAll

(

const SIPX_INST

hInst

)

Remove/Destroy all subscriptions.

void sipxFireCallEvent	(	const void *	pSrc,
		const char *	szCallId,
		SipSession *	pSession,
		const char *	szRemoteAddress,
		SIPX_CALLSTATE_EVENT	event,
		SIPX_CALLSTATE_CAUSE	cause,
		void *	pEventData = NULL,
		const char *	szRemoteAssertedIdentity = NULL
	)

Fire events to interested listeners (call events only).

void sipxFireMediaEvent	(	const void *	pSrc,
		const char *	szCallId,
		const char *	szRemoteAddress,
		SIPX_MEDIA_EVENT	event,
		SIPX_MEDIA_CAUSE	cause,
		SIPX_MEDIA_TYPE	type,
		void *	pEventData = NULL
	)

Fires events to interested listener (media events only)

void sipxFireKeepaliveEvent	(	const void *	pSrc,
		SIPX_KEEPALIVE_EVENT	event,
		SIPX_KEEPALIVE_CAUSE	cause,
		SIPX_KEEPALIVE_TYPE	type,
		const char *	szRemoteAddress,
		int	remotePort,
		int	keepAliveSecs,
		const char *	szMappedAddress,
		int	mappedPort
	)

Fires events to interested listener (keepalive events only)

void sipxFireLineEvent	(	const void *	pSrc,
		const char *	szLineIdentifier,
		SIPX_LINESTATE_EVENT	event,
		SIPX_LINESTATE_CAUSE	cause,
		const char *	bodyBytes = NULL
	)

Fires a Line Event to the listeners.

bool sipxFireEvent	(	const void *	pSrc,
		SIPX_EVENT_CATEGORY	category,
		void *	pInfo
	)

Bubbles up all non-line and non-call events to the application layer.

SIPX_INSTANCE_DATA* findSessionByCallManager

(

const void *

pCallManager

)

SIPX_CALL_DATA* sipxCallLookup	(	const SIPX_CALL	hCall,
		SIPX_LOCK_TYPE	type,
		const OsStackTraceLogger &	oneBackInStack
	)

void sipxCallReleaseLock	(	SIPX_CALL_DATA *	,
		SIPX_LOCK_TYPE	type,
		const OsStackTraceLogger &	oneBackInStack
	)

void sipxCallObjectFree	(	const SIPX_CALL	hCall,
		const OsStackTraceLogger &	oneBackInStack
	)

SIPX_CALL sipxCallLookupHandle	(	const UtlString &	callID,
		const void *	pSrc
	)

void destroyCallData

(

SIPX_CALL_DATA *

pData

)

UtlBoolean validCallData

(

SIPX_CALL_DATA *

pData

)

UtlBoolean sipxCallGetCommonData	(	SIPX_CALL	hCall,
		SIPX_INSTANCE_DATA **	pInst,
		UtlString *	pStrCallId,
		UtlString *	pStrRemoteAddress,
		UtlString *	pLineId,
		UtlString *	pGhostCallId = NULL,
		UtlString *	pContactAddress = NULL
	)

SIPX_CONF sipxCallGetConf

(

SIPX_CALL

hCall

)

SIPXTAPI_API UtlBoolean sipxCallGetState	(	SIPX_CALL	hCall,
		SIPX_CALLSTATE_EVENT &	lastEvent,
		SIPX_CALLSTATE_CAUSE &	lastCause,
		SIPX_INTERNAL_CALLSTATE &	state
	)

UtlBoolean sipxCallGetMediaState	(	SIPX_CALL	hCall,
		SIPX_MEDIA_EVENT &	lastLocalMediaAudioEvent,
		SIPX_MEDIA_EVENT &	lastLocalMediaVideoEvent,
		SIPX_MEDIA_EVENT &	lastRemoteMediaAudioEvent,
		SIPX_MEDIA_EVENT &	lastRemoteMediaVideoEvent
	)

UtlBoolean sipxCallSetMediaState	(	SIPX_CALL	hCall,
		SIPX_MEDIA_EVENT	event,
		SIPX_MEDIA_TYPE	type
	)

UtlBoolean sipxCallSetState	(	SIPX_CALL	hCall,
		SIPX_CALLSTATE_EVENT	event,
		SIPX_CALLSTATE_CAUSE	cause
	)

SIPX_CONTACT_TYPE sipxCallGetLineContactType

(

SIPX_CALL

hCall

)

SIPX_LINE_DATA* sipxLineLookup	(	const SIPX_LINE	hLine,
		SIPX_LOCK_TYPE	type,
		const OsStackTraceLogger &	oneBackInStack
	)

void sipxLineReleaseLock	(	SIPX_LINE_DATA *	pData,
		SIPX_LOCK_TYPE	type,
		const OsStackTraceLogger &	oneBackInStack
	)

void sipxLineObjectFree

(

const SIPX_LINE

hLine

)

SIPX_LINE sipxLineLookupHandle	(	const char *	szLineURI,
		const char *	requestUri
	)

SIPX_LINE sipxLineLookupHandleByURI

(

const char *

szURI

)

UtlBoolean validLineData

(

const SIPX_LINE_DATA *

)

UtlBoolean sipxAddCallHandleToConf	(	const SIPX_CALL	hCall,
		const SIPX_CONF	hConf
	)

UtlBoolean sipxRemoveCallHandleFromConf	(	const SIPX_CONF	hConf,
		const SIPX_CALL	hCall
	)

SIPX_CONF_DATA* sipxConfLookup	(	const SIPX_CONF	hConf,
		SIPX_LOCK_TYPE	type,
		const OsStackTraceLogger &	oneBackInStack
	)

void sipxConfReleaseLock	(	SIPX_CONF_DATA *	pData,
		SIPX_LOCK_TYPE	type,
		const OsStackTraceLogger &	oneBackInStack
	)

void sipxConfFree

(

const SIPX_CONF

hConf

)

UtlBoolean validConfData

(

const SIPX_CONF_DATA *

pData

)

void sipxIncSessionCount

(

)

void sipxDecSessionCount

(

)

int sipxGetSessionCount

(

)

UtlBoolean sipxIsCallInFocus

(

)

SIPXTAPI_API SIPX_RESULT sipxStructureIntegrityCheck

(

)

const char* sipxContactTypeToString

(

SIPX_CONTACT_TYPE

type

)

const char* sipxTransportTypeToString

(

SIPX_TRANSPORT_TYPE

type

)

void sipxInfoFree

(

SIPX_INFO_DATA *

pData

)

Frees the INFO structure allocated by a call to sipxCallSendInfo.

Parameters

pData

Pointer to SIPX_INFO_DATA structure

void sipxInfoObjectFree

(

SIPX_INFO

hInfo

)

Releases the INFO handle created by a call to sipxCallSendInfo.

Also cals sipxInfoFree.

Parameters

hInfo

Handle to the Info object

void sipxTransportFree

(

SIPX_TRANSPORT_DATA *

pData

)

Frees the TRANSPORT structure allocated by a call to sipxConfigExternalTransportAdd.

Parameters

pData

Pointer to SIPX_TRANSPORT_DATA structure

void sipxTransportObjectFree

(

SIPX_TRANSPORT

hTransport

)

Releases the TRANSPORT handle created sipxConfigExternalTransportAdd Also cals sipxTransportFree.

Parameters

hInfo

Handle to the Transport object

void sipxGetContactHostPort	(	SIPX_INSTANCE_DATA *	pData,
		SIPX_CONTACT_TYPE	contactType,
		Url &	uri,
		SIPX_TRANSPORT_TYPE	protocol
	)

SIPX_INFO_DATA* sipxInfoLookup	(	const SIPX_INFO	hInfo,
		SIPX_LOCK_TYPE	type,
		const OsStackTraceLogger &	oneBackInStack
	)

Looks up the SIPX_INFO_DATA structure pointer, given the SIPX_INFO handle.

Parameters

hInfo	Info Handle
type	Lock type to use during lookup.

void sipxInfoReleaseLock	(	SIPX_INFO_DATA *	pData,
		SIPX_LOCK_TYPE	type,
		const OsStackTraceLogger &	oneBackInStack
	)

Unlocks the mutex associated with the INFO DATA.

Parameters

pData	pointer to the SIPX_INFO structure
type	Type of lock (read or write)

SIPX_PUBLISH_DATA* sipxPublishLookup	(	const SIPX_PUB	hPub,
		SIPX_LOCK_TYPE	type,
		const OsStackTraceLogger &	oneBackInStack
	)

void sipxPublishReleaseLock	(	SIPX_PUBLISH_DATA *	pData,
		SIPX_LOCK_TYPE	type,
		const OsStackTraceLogger &	oneBackInStack
	)

SIPX_SUBSCRIPTION_DATA* sipxSubscribeLookup	(	const SIPX_SUB	hSub,
		SIPX_LOCK_TYPE	type,
		const OsStackTraceLogger &	oneBackInStack
	)

void sipxSubscribeReleaseLock	(	SIPX_SUBSCRIPTION_DATA *	pData,
		SIPX_LOCK_TYPE	type,
		const OsStackTraceLogger &	oneBackInStack
	)

SIPX_TRANSPORT_DATA* sipxTransportLookup	(	const SIPX_TRANSPORT	hTransport,
		SIPX_LOCK_TYPE	type
	)

Looks up the SIPX_TRANSPORT_DATA structure pointer, given the SIPX_TRANSPORT handle.

Parameters

hTransport	Transport Handle
type	Lock type to use during lookup.

void sipxTransportReleaseLock	(	SIPX_TRANSPORT_DATA *	pData,
		SIPX_LOCK_TYPE	type
	)

Unlocks the mutex associated with the TRANSPORT DATA.

Parameters

pData	pointer to the SIPX_TRANSPORT structure
type	Type of lock (read or write)

void sipxTransportDestroyAll

(

const SIPX_INST

hInst

)

Destroy all external transports for a given instance.

SIPXTAPI_API void sipxLogEntryAdd	(	OsSysLogPriority	logLevel,
		const char *	format,
			...
	)

Adds a log entry to the system log - made necessary to add logging capability on the API level.

Parameters

logLevel	priority of the log entry
format	a format string for the following variable argument list

SIPXTAPI_API SIPX_RESULT sipxConfigAllowMethod	(	const SIPX_INST	hInst,
		const char *	method,
		const bool	bAllow = true
	)

Utility function for setting allowed methods on a instance's user-agent.

SIPXTAPI_API SIPX_RESULT sipxGetActiveCallIds	(	SIPX_INST	hInst,
		int	maxCalls,
		int &	actualCalls,
		UtlString	callIds[]
	)

Get the list of active calls for the specified call manager instance.

void sipxSubscribeClientSubCallback	(	enum SipSubscribeClient::SubscriptionState	newState,
		const char *	earlyDialogHandle,
		const char *	dialogHandle,
		void *	applicationData,
		int	responseCode,
		const char *	responseText,
		long	expiration,
		const SipMessage *	subscribeResponse
	)

Callback for subscription client state.

void sipxSubscribeClientNotifyCallback	(	const char *	earlyDialogHandle,
		const char *	dialogHandle,
		void *	applicationData,
		const SipMessage *	notifyRequest
	)

Callback for subscription client NOTIFY content.

SIPXTAPI_API SIPX_RESULT sipxCheckForHandleLeaks

(

)

Look for leaks in internal handles.

SIPXTAPI_API SIPX_RESULT sipxFlushHandles

(

)

Flush handles to remove peaks between test cases – this WILL leak memory.

SIPXTAPI_API SIPX_RESULT sipxTranslateToneId	(	const SIPX_TONE_ID	toneId,
		SIPX_TONE_ID &	xlateId
	)

Translate tone ids to implementation specific codes.

Parameters

toneId	sipx-internal tone id
xlateId	implementation-specific tone id

SIPXTAPI_API SIPX_RESULT sipxCallGetConnectionMediaInterface	(	const SIPX_CALL	hCall,
		void **	ppInstData
	)

Gets an CpMediaInterface pointer, associated with the call connection.

Parameters

hCall	Handle to a call. Call handles are obtained either by invoking sipxCallCreate or passed to your application through a listener interface.
ppInstData	pointer to a memory address that is set to the media interface pointer.

SIPXTAPI_API SIPX_RESULT sipxConfigGetLocalAudioConnectionId	(	const SIPX_INST	hInst,
		int &	connectionId
	)

Returns the 'local' connection id.

Parameters

hInst

Instance pointer obtained by sipxInitialize

SIPXTAPI_API CpMediaInterface* sipxCallGetCpMediaInterface

(

const SIPX_CALL

hCall

)

Get pointer to Sipx media interface for call.

Parameters

hCall

Handle to a call. Call handles are obtained either by invoking sipxCallCreate or passed to your application through a listener interface.

SIPXTAPI_API OsMsgQ* sipxCallGetMediaConrolQueue

(

const SIPX_CALL

hCall

)

Get pointer to Sipx media control message queue for call.

Parameters

hCall

Handle to a call. Call handles are obtained either by invoking sipxCallCreate or passed to your application through a listener interface.

UtlBoolean sipxCallSetRemoveInsteadofDrop

(

SIPX_CALL

hCall

)

UtlBoolean sipxCallIsRemoveInsteadOfDropSet

(

SIPX_CALL

hCall

)

SIPX_RESULT __sipxEventListenerAdd	(	const SIPX_INST	hInst,
		SIPX_EVENT_CALLBACK_PROC	pCallbackProc,
		void *	pUserData
	)

SIPX_RESULT __sipxEventListenerRemove	(	const SIPX_INST	hInst,
		SIPX_EVENT_CALLBACK_PROC	pCallbackProc,
		void *	pUserData
	)

void sipxUpdateListeners	(	SIPX_INST	hOldInst,
		SIPX_INST	hNewInst
	)

SIPXTAPI_API SIPX_RESULT sipxConfigLoadSecurityRuntime

(

)

Dynamically loads the following NSS runtime libraries, if they can be found: smime3.dll;nss3.dll;nspr4.dll;plc4.dll.

Returns

SIPX_RESULT_SUCCESS if all NSS libraries were loaded. Otherwise, SIPX_RESULT_MISSING_RUNTIME_FILES is returned.

void sipxCreateExternalTransportContacts

(

const SIPX_TRANSPORT_DATA *

pData

)

Called from sipxConfigExternalTransportAdd, this function creates LOCAL, STUN, and RELAY contact records for the newly added transport mechanism.