te
Copyright (c) 2007, Sun Microsystems, Inc. All Rights Reserved
The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License.
You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License.
When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
Copyright (c) 2007, Sun Microsystems, Inc. All Rights Reserved
The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License.
You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License.
When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
sip_hold_dialog 3SIP "25 Jan 2007" "SunOS 5.11" "Session Initiation Protocol Library Functions"
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 TYPE | ATTRIBUTE VALUE |
| Interface Stability | Committed |
| MT-Level | MT-Safe |
SEE ALSO
libsip(3LIB)