share/man/man3sip/sip_init_conn_object.3sip

   1 '\" te
   2 .\"  Copyright (c) 2007, Sun Microsystems, Inc.  All Rights Reserved
   3 .\" 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.
   4 .\" 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.
   5 .\" 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]
   6 .TH SIP_INIT_CONN_OBJECT 3SIP "Jan 25, 2007"
   7 .SH NAME
   8 sip_init_conn_object, sip_clear_stale_data, sip_conn_destroyed \- connection
   9 object related functions
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 \fBcc\fR [ \fIflag\fR ... ] \fIfile\fR ... \fB-lsip\fR [ \fIlibrary\fR ... ]
  14 #include <sip.h>
  15
  16 \fBint\fR \fIsip_init_conn_object\fR(\fBsip_conn_object_t\fR \fIobj\fR);
  17 .fi
  18
  19 .LP
  20 .nf
  21 \fBvoid\fR \fIsip_clear_stale_data\fR(\fBsip_conn_object_t\fR \fIobj\fR);
  22 .fi
  23
  24 .LP
  25 .nf
  26 \fBvoid\fR \fIsip_conn_destroyed\fR(\fBsip_conn_object_t\fR \fIobj\fR);
  27 .fi
  28
  29 .SH DESCRIPTION
  30 .sp
  31 .LP
  32 The \fBsip_init_conn_object()\fR function initializes the connection object
  33 \fIobj\fR for use by the stack. The first member of the connection object (a
  34 void *) is used by the stack to store connection object specific stack-private
  35 data.
  36 .sp
  37 .LP
  38 The \fBsip_clear_stale_data()\fR function is used to clear any stack-private
  39 data in the connection object \fIobj\fR.
  40 .sp
  41 .LP
  42 The \fBsip_conn_destroyed()\fR function is used to intimate the stack of the
  43 pending destruction of the connection object \fIobj\fR. The stack clean up any
  44 stack-private data in \fIobj\fR and also removes \fIobj\fR from any caches the
  45 stack maintains.
  46 .SH RETURN VALUES
  47 .sp
  48 .LP
  49 The \fBsip_init_conn_object()\fR function returns \fB0\fR on success and the
  50 appropriate error value on failure.
  51 .sp
  52 .LP
  53 The value of \fBerrno\fR is not changed by these calls in the event of an
  54 error.
  55 .SH ATTRIBUTES
  56 .sp
  57 .LP
  58 See \fBattributes\fR(5) for descriptions of the following attributes:
  59 .sp
  60
  61 .sp
  62 .TS
  63 box;
  64 c | c
  65 l | l .
  66 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  67 _
  68 Interface Stability     Committed
  69 _
  70 MT-Level        MT-Safe
  71 .TE
  72
  73 .SH SEE ALSO
  74 .sp
  75 .LP
  76 \fBlibsip\fR(3LIB)