TapiMgr Class Reference

The TapiMgr singleton class allows callback funtion-pointers for tapi to be set, indicating the function that is to be called for the firing of sipXtapi events. More...

#include <TapiMgr.h>

Public Member Functions
virtual	~TapiMgr ()
	TapiMgr destructor. More...
void	setTapiCallback (sipxEventCallbackFn fp)
	Sets the callback function pointer for all Events (to be fired to the sipXtapi layer) More...
void	setTapiMediaCallback (sipxMediaCallbackFn fp)
	Sets the callback function pointer for all media Events (to be fired to the sipXtapi layer) More...
void	setTapiCallCallback (sipxCallEventCallbackFn fp)
	Sets the callback function pointer for Call Events (to be fired to the sipXtapi layer) More...
void	setTapiLineCallback (sipxLineEventCallbackFn fp)
	Sets the callback function pointer for Line Events (to be fired to the sipXtapi layer) More...
void	fireCallEvent (const void *pSrc, const char *szCallId, SipSession *pSession, const char *szRemoteAddress, SIPX_CALLSTATE_EVENT event, SIPX_CALLSTATE_CAUSE cause, void *pEventData, const char *remoteAssertedIdentity=NULL)
	This method calls the Call event callback using the function pointer. More...
void	fireMediaEvent (const void *pSrc, const char *szCallId, const char *szRemoteAddress, SIPX_MEDIA_EVENT event, SIPX_MEDIA_CAUSE cause, SIPX_MEDIA_TYPE type, void *pEventData)
	This method calls the media event callback using the function pointer. More...
void	fireLineEvent (const void *pSrc, const char *szLineIdentifier, SIPX_LINESTATE_EVENT event, SIPX_LINESTATE_CAUSE cause, const char *bodyBytes=NULL)
	This method calls the Line event callback using the function pointer. More...
bool	fireEvent (const void *pSrc, const SIPX_EVENT_CATEGORY event, void *pInfo)
	This method calls the new "unified callback" procedure in sipXtapi. More...

Static Public Member Functions
static TapiMgr &	getInstance ()
	Accessor for the single class instance. More...

Detailed Description

The TapiMgr singleton class allows callback funtion-pointers for tapi to be set, indicating the function that is to be called for the firing of sipXtapi events.

This obviates the need for sipXcallLib and sipXtackLib to link-in the sipXtapi library.

Constructor & Destructor Documentation

~TapiMgr ( )

virtual

TapiMgr destructor.

Member Function Documentation

TapiMgr & getInstance ( )

static

Accessor for the single class instance.

void setTapiCallback

(

sipxEventCallbackFn

fp

)

Sets the callback function pointer for all Events (to be fired to the sipXtapi layer)

void setTapiMediaCallback

(

sipxMediaCallbackFn

fp

)

Sets the callback function pointer for all media Events (to be fired to the sipXtapi layer)

void setTapiCallCallback

(

sipxCallEventCallbackFn

fp

)

Sets the callback function pointer for Call Events (to be fired to the sipXtapi layer)

void setTapiLineCallback

(

sipxLineEventCallbackFn

fp

)

Sets the callback function pointer for Line Events (to be fired to the sipXtapi layer)

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

This method calls the Call event callback using the function pointer.

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

This method calls the media event callback using the function pointer.

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

This method calls the Line event callback using the function pointer.

It calls the deprecated "Line Callback" in sipXtapi.

bool fireEvent	(	const void *	pSrc,
		const SIPX_EVENT_CATEGORY	event,
		void *	pInfo
	)

This method calls the new "unified callback" procedure in sipXtapi.