SIP_INIT_CONN_OBJECT(3SIP) Session Initiation Protocol Library Functions
NAME
sip_init_conn_object, sip_clear_stale_data, sip_conn_destroyed -
connection object related functions
SYNOPSIS
cc [
flag ... ]
file ...
-lsip [
library ... ]
#include <sip.h>
int sip_init_conn_object(
sip_conn_object_t obj);
void sip_clear_stale_data(
sip_conn_object_t obj);
void sip_conn_destroyed(
sip_conn_object_t obj);
DESCRIPTION
The
sip_init_conn_object() function initializes the connection object
obj for use by the stack. The first member of the connection object
(a void *) is used by the stack to store connection object specific
stack-private data.
The
sip_clear_stale_data() function is used to clear any stack-
private data in the connection object
obj.
The
sip_conn_destroyed() function is used to intimate the stack of
the pending destruction of the connection object
obj. The stack clean
up any stack-private data in
obj and also removes
obj from any caches
the stack maintains.
RETURN VALUES
The
sip_init_conn_object() function returns
0 on success and the
appropriate error value on failure.
The value of
errno is not changed by these calls in the event of an
error.
ATTRIBUTES
See
attributes(7) for descriptions of the following attributes:
+--------------------+-----------------+
| ATTRIBUTE TYPE | ATTRIBUTE VALUE |
+--------------------+-----------------+
|Interface Stability | Committed |
+--------------------+-----------------+
|MT-Level | MT-Safe |
+--------------------+-----------------+
SEE ALSO
libsip(3LIB) January 25, 2007 SIP_INIT_CONN_OBJECT(3SIP)
