Content-type: text/html Man page of sip_hold_dialog

sip_hold_dialog

Section: Session Initiation Protocol Library Functions (3SIP)
Updated: 20 Mar 2007
Index Return to Main Contents
 

NAME

sip_hold_dialog, sip_release_dialog - hold/release reference on a dialog  

SYNOPSIS

cc [ flag ... ] file ... -lsip [ library ... ]
#include <sip.h>

void sip_hold_dialog(sip_dialog_t dialog);

void sip_release_dialog(sip_dialog_t dialog);

 

DESCRIPTION

For functions that return a pointer of type sip_str_t, sip_str_t is supplied by:

typedef struct sip_str {
    char        *sip_str_ptr;
    int sip_str_len;
}sip_str_t;

The sip_str_ptr parameter points to the start of the returned value and sip_str_len supplies the length of the returned value.

The sip_hold_dialog() function is used to hold a reference on the dialog. A dialog is not freed if there are any references on it.

The sip_release_dialog() function is used to release a reference in the dialog. If the reference in a dialog drops to 0 and it is in SIP_DLG_DESTROYED state, it is freed.  

RETURN VALUES

The value of errno is not changed by these calls in the event of an error.  

ATTRIBUTES

See attributes(5) for descriptions of the following attributes:

ATTRIBUTE TYPEATTRIBUTE VALUE

Interface StabilityStable

MT-Level

 

SEE ALSO

libsip(3SIP)


 

Index

NAME
SYNOPSIS
DESCRIPTION
RETURN VALUES
ATTRIBUTES
SEE ALSO

This document was created by man2html, using the manual pages.
Time: 02:37:50 GMT, October 02, 2010