SetSipLogServer

The SetSipLogServer API procedure can be called to specify the network location of a SIP log server. Using a SIP log server will give you the ability to view transmitted and received SIP protocol messages as they are processed in real time by the VOIP Media Engine™.

This capability is generally used during system debug cycles but can be used for whatever purpose your application requires. A nice feature of real time SIP message logging to a server is the ability to see your SIP transactions in real time. You no longer have to stop your VOIP application to view its log files. The SIP log server capability can be used at the same time as the built-in static SIP log capability of the VOIP Media Engine. For details associated with the static SIP log capability, please refer to the LogSipMessages and the pSipLogFileName members of the START_SIP_TELEPHONY_PARAMS structure.

Application software can call this procedure as many times as required in order to configure more that one remote SIP log server.

Note:
The VOIP Media Engine™ installation image contains a console based SIP log server application (SIPLogD.exe). You can use this SIP log server to take advantage of the media engine's remote SIP logging capability.

TELEPHONY_RETURN_VALUE SetSipLogServer(

SIPHANDLE hStateMachine,

BOOL EnableSipLogServer,

char *pSipLogServer,

int SipLogServerPort

);

Parameters:

hStateMachine

[in] The handle to the telephony engine. This is the handle that was returned by a previous call to the StartSipTelephony procedure.

EnableSipLogServer

[in] Specifies the enable state of real time SIP protocol logging. Set to a non zero value (TRUE) to enable logging to the specified server or zero (FALSE) to disable logging.

pSipLogServer

[in] The address of the SIP log server. This can be an IP address or the network name of the SIP log server machine.

SipLogServerPort

[in] The UDP port of the SIP log server.

Return Value:

If the function succeeds, the return value will be SipSuccess.

If the function fails, the return value will be one of the following values as specified by the TELEPHONY_RETURN_VALUE data type.

Value	Description
SipCallFailure	This is a generic "catch all" API error. If an error condition is not specified by any other API error value, this error will be returned.
SipBadParameter	For API procedures that receive pointers from user software, this error indicates that a NULL pointer condition was detected. Make sure all pointers your software passes to the telephony API are valid.
SipInvalidHandle	An API procedure was passed an invalid handle. The telephony engine attempts to verify user specified telephony handles and returns this error when an invalid handle is detected.
SipUnknownHost	The IP address of the SIP log server could not be resolved using the specified network name.
SipMemoryError	Indicates a low memory situation.