The SetNumByeRetransmissions procedure allows an application to specify the number of additional BYE SIP messages that will be re-transmitted to a call endpoint in the event that a valid "200 OK" or error SIP response is not detected for the first BYE request that is sent.

This API procedure should not be used unless your application is having problems terminating calls with other SIP devices, servers or gateways. By default, the VOIP Media Engine will transmit a single BYE request to terminate a call. It then waits to receive the BYE acknowledge from the far end (usually a successful SIP "200 OK" response or a SIP error response). If the BYE response is not received within the time-out value programmed by the SetCallTerminateTimeout(UInt32) API procedure, then the VOIP Media Engine will send an additional number of BYE request as specified by this API procedure.

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

Syntax

C#
public VoipMediaEngine..::.TELEPHONY_RETURN_VALUE SetNumByeRetransmissions(
	uint NumByeRetransmissions
)
Visual Basic (Declaration)
Public Function SetNumByeRetransmissions ( _
	NumByeRetransmissions As UInteger _
) As VoipMediaEngine..::.TELEPHONY_RETURN_VALUE
Visual C++
public:
VoipMediaEngine..::.TELEPHONY_RETURN_VALUE SetNumByeRetransmissions(
	unsigned int NumByeRetransmissions
)
J#
public VoipMediaEngine..::.TELEPHONY_RETURN_VALUE SetNumByeRetransmissions(
	UInt32 NumByeRetransmissions
)

Parameters

NumByeRetransmissions
Type: System..::.UInt32
The number of additional SIP BYE messages to retransmit after detecting that the far end has not responded to an initial call termination. The VOIP Media Engine defaults to retransmitting 2 additional BYE SIP messages after detecting a call terminate timeout error.

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
SipCallFailure
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)

SipInvalidHandle
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)

Remarks

None.

See Also