#include <CpGatewayManager.h>

Inheritance diagram for CpGatewayManager:

Collaboration diagram for CpGatewayManager:

Public Member Functions
	CpGatewayManager ()

	CpGatewayManager (const CpGatewayManager &rCpGatewayManager)

virtual	~CpGatewayManager ()

CpGatewayManager &	operator= (const CpGatewayManager &rhs)

OsStatus	setGatewayInterface (const char terminalName, PtGatewayInterface pInterface)

void	getNewCallId (UtlString &callId)
	param: (in) terminalName - the terminalName with which the interface is to work. param: (in) pInterface - interface object to be called for media setup information for calls on the geteway terminal. retcode: OS_SUCCESS - the interface was registered for the named terminal. More...

OsStatus	connect (const char callId, const char fromAddressUrl, const char fromTerminalName, const char toAddressUrl)

OsStatus	answer (const char callId, const char terminalName)
	param: (in) callId - must refer to an existing call or a valid callId from getNewCallId. In the latter case a new call will be created. param: (in) fromAddressUrl - the originating terminal url. Note: this should be validated if it is used in conjuction with the provider or proxy server. param: (in) fromTerminalname - this should be a valid gateway terminal having a registered (via setGatewayInterface) PtGatewayInterface. param: (in) toAddressUrl - destination url. Note: in general this cannot be validated as the call may be to an address which is outside the domain of the provider. retcode: OS_SUCCESS - the callId is valid and an attempt will be made to connect the call. This does not indicate that the connect was successful or completed. retcode: OS_INVALID_ARGUMENT - the call indicated by callId previously existed, but was in an invalid state to connect a call. More...

OsStatus	disconnectConnection (const char callId, const char connectionAddressUrl)
	param: callId - identifies an existing incomming call. param: terminalName - this should be a valid gateway terminal having a registered (via setGatewayInterface) PtGatewayInterface having the address of the destination of the incoming call. retcode: OS_SUCCESS - the callId is valid and an attempt will be made to answer the call. This does not indicate that the answer was successful or completed. retcode: OS_INVALID_ARGUMENT - the call indicated by callId or the terminalName indicated does not exist. More...

UtlBoolean	gatewayInterfaceExists (const char *terminalName)
	param: (in) callId - the handle indicating which call contains the connection to disconnect. param: (in) connectionAddressUrl - indicates which leg of the call is to be disconnected. retcode: OS_SUCCESS - the callId and connectionAddressUrl are valid and an attempt will be made to disconnect the connection. This does not indicate that the disconnect was successful or completed. retcode: OS_INVALID_ARGUMENT - the call indicated by callId or the connection indicated by connectionAddressUrl does not exist. More...

Static Public Member Functions
static CpGatewayManager *	getCpGatewayManager ()

Constructor & Destructor Documentation

CpGatewayManager ( )

CpGatewayManager ( const CpGatewayManager & rCpGatewayManager )

~CpGatewayManager ( )

virtual

Member Function Documentation

OsStatus answer	(	const char *	callId,
		const char *	terminalName
	)

param: (in) callId - must refer to an existing call or a valid callId from getNewCallId. In the latter case a new call will be created. param: (in) fromAddressUrl - the originating terminal url. Note: this should be validated if it is used in conjuction with the provider or proxy server. param: (in) fromTerminalname - this should be a valid gateway terminal having a registered (via setGatewayInterface) PtGatewayInterface. param: (in) toAddressUrl - destination url. Note: in general this cannot be validated as the call may be to an address which is outside the domain of the provider. retcode: OS_SUCCESS - the callId is valid and an attempt will be made to connect the call. This does not indicate that the connect was successful or completed. retcode: OS_INVALID_ARGUMENT - the call indicated by callId previously existed, but was in an invalid state to connect a call.

OsStatus connect	(	const char *	callId,
		const char *	fromAddressUrl,
		const char *	fromTerminalName,
		const char *	toAddressUrl
	)

OsStatus disconnectConnection	(	const char *	callId,
		const char *	connectionAddressUrl
	)

param: callId - identifies an existing incomming call. param: terminalName - this should be a valid gateway terminal having a registered (via setGatewayInterface) PtGatewayInterface having the address of the destination of the incoming call. retcode: OS_SUCCESS - the callId is valid and an attempt will be made to answer the call. This does not indicate that the answer was successful or completed. retcode: OS_INVALID_ARGUMENT - the call indicated by callId or the terminalName indicated does not exist.

UtlBoolean gatewayInterfaceExists ( const char * terminalName )

param: (in) callId - the handle indicating which call contains the connection to disconnect. param: (in) connectionAddressUrl - indicates which leg of the call is to be disconnected. retcode: OS_SUCCESS - the callId and connectionAddressUrl are valid and an attempt will be made to disconnect the connection. This does not indicate that the disconnect was successful or completed. retcode: OS_INVALID_ARGUMENT - the call indicated by callId or the connection indicated by connectionAddressUrl does not exist.

CpGatewayManager * getCpGatewayManager ( )

static

void getNewCallId ( UtlString & callId )

param: (in) terminalName - the terminalName with which the interface is to work. param: (in) pInterface - interface object to be called for media setup information for calls on the geteway terminal. retcode: OS_SUCCESS - the interface was registered for the named terminal.

CpGatewayManager & operator= ( const CpGatewayManager & rhs )

OsStatus setGatewayInterface	(	const char *	terminalName,
		PtGatewayInterface *	pInterface
	)

sipXcallLib home page

Public Member Functions

Static Public Member Functions

Constructor & Destructor Documentation

Member Function Documentation