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]
sip_init_conn_object, sip_clear_stale_data, sip_conn_destroyed - connection object related functions

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

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.

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.

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

ATTRIBUTE TYPE ATTRIBUTE VALUE

Interface Stability Committed

MT-Level MT-Safe

libsip(3LIB)