HP-UX C SIP Stack Programmer's Guide (Novembery 2007)

48 HP-UX C SIP Stack Programmer’s Guide
Call-leg API
RvSipCallLegDisconnect()
You can call RvSipCallLegDisconnect() at any point in the life span of a call-leg
in order to disconnect the call. The call-leg reaction to this function depends on
the current call-leg state. For example, if the call-leg is in the CONNECTED
state, calling this function causes a BYE message to be sent. The call-leg then
moves to the DISCONNECTING state. If the call-leg is in the IDLE state,
calling RvSipCallLegDisconnect() terminates the call-leg. In this case, the call-
leg assumes the TERMINATED state.
RvSipCallLegTerminate()
The RvSipCallLegTerminate() function causes a call-leg to be terminated
without sending any messages (CANCEL or BYE). The call-leg will assume the
TERMINATED state. Calling this function causes an abnormal termination of
the call-leg. All transactions related to the call-leg will be terminated as well.
PRACK F
UNCTIONALITY The following API functions allow the application to support RFC 3262. To use
these functions you must configure the SIP Stack to support the 100rel option
tag.
RvSipCallLegProvisionalResponseReliable()
You can use RvSipCallLegProvisionalResponseReliable() to send a reliable
provisional response (1xx class other then 100) to the remote party. This
function can be called only when an INVITE request is received, such as in the
OFFERING state and the MODIFY_REINVITE_RECEIVED state.
RvSipCallLegSendPrack()
When the SIP Stack is configured to work in a manual PRACK mode, the
application is responsible for generating the PRACK message whenever a
reliable provisional response is received. When a reliable provisional response is
received, the call-leg PRACK state machine assumes the
REL_PROV_RESPONSE_RCVD state. You should then call the
RvSipCallLegSendPrack() function to send the PRACK message to the remote
party. The call-leg PRACK state machine will then assume the PRACK_SENT
state. When calling this function, the SIP Stack is responsible for adding the
RAck header to the PRACK message.