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 VoipMediaEngine..::.START_SIP_TELEPHONY_PARAMS class.

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

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.

Namespace:  LanScape
Assembly:  LMEVoipManaged (in LMEVoipManaged.dll) Version: 6.0.5226.26700


public VoipMediaEngine..::.TELEPHONY_RETURN_VALUE SetSipLogServer(
	bool EnableSipLogServer,
	string SipLogServer,
	int SipLogServerPort
Visual Basic (Declaration)
Public Function SetSipLogServer ( _
	EnableSipLogServer As Boolean, _
	SipLogServer As String, _
	SipLogServerPort As Integer _
Visual C++
VoipMediaEngine..::.TELEPHONY_RETURN_VALUE SetSipLogServer(
	bool EnableSipLogServer, 
	String^ SipLogServer, 
	int SipLogServerPort
public VoipMediaEngine..::.TELEPHONY_RETURN_VALUE SetSipLogServer(
	boolean EnableSipLogServer,
	String SipLogServer,
	int SipLogServerPort


Type: System..::.Boolean
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.
Type: System..::.String
The address of the SIP log server. This can be an IP address or the network name of the SIP log server machine.
Type: System..::.Int32
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 VoipMediaEngine..::.TELEPHONY_RETURN_VALUE data type.

Return ValueDescription
This value is returned by telephony API procedures to indicate general API failure. This error value is used as a "catch all error". If you receive this error, check to make sure that all parameters specified in the API procedure call are correct. Particularly, verify that pointers to memory regions are valid. This error return value is only used if a mapping to another specific error value does not exist.

(API return value)

One of the telephony API procedures was called by application software and was passed a pointer to an invalid memory address. Normally this error will occur when application software passes NULL pointer values to the telephony API. For managed code applications, you should never see this error unless your process space has exhausted memory.

(API return value)

Application software specified an invalid telephony handle in one of the API procedures. This usually indicates memory corruption on the part of application software.

(API return value)

A network address was specified as a UNC name and DNS was used to obtain the destination IP address. DNS could not resolve the UNC network name. Make sure the spelling you specified for the destination machine is correct.

(API return value)

The telephony engine attempted to allocate system memory but the allocation failed. Make sure the host system has enough virtual memory. Increasing the amount of virtual memory can remove these errors, however if critical telephony engine code has been swapped out to disk and is not resident in physical memory, you may experience degraded audio/video performance. If you want to remove this error and obtain the best possible audio/video performance, make sure the host system has enough physical memory. To resolve this error, you may also want to consider disabling certain features of the media engine such as conference calling. You can also reduce memory requirements if you reduce the maximum signal length of internal media engine signal paths by specifying a smaller number for the MaxMixerLinebuffers member of the VoipMediaEngine..::.START_SIP_TELEPHONY_PARAMS class that is passed to the StartSipTelephony(VoipMediaEngine..::.START_SIP_TELEPHONY_PARAMS) and ReStartSipTelephony(VoipMediaEngine..::.START_SIP_TELEPHONY_PARAMS) API procedures.




See Also