share/man/man3sip/sip_hold_msg.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_HOLD_MSG 3SIP "Jan 25, 2007"
   7 .SH NAME
   8 sip_hold_msg, sip_free_msg \- adds and removes a reference from a SIP message
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fBcc\fR [ \fIflag\fR ... ] \fIfile\fR ... \fB-lsip\fR [ \fIlibrary\fR ... ]
  13 #include <sip.h>
  14
  15 \fBvoid\fR \fIsip_hold_msg\fR(\fBsip_msg_t\fR \fIsip_msg\fR);
  16 .fi
  17
  18 .LP
  19 .nf
  20 \fBvoid\fR \fIsip_free_msg\fR(\fBsip_msg_t\fR \fIsip_msg\fR);
  21 .fi
  22
  23 .SH DESCRIPTION
  24 .sp
  25 .LP
  26 The \fBsip_hold_msg()\fR function adds a reference to the SIP message passed as
  27 the argument. The reference is used to prevent the \fBSIP\fR message from being
  28 freed when in use.
  29 .sp
  30 .LP
  31 The \fBsip_free_msg()\fR function is used to remove an added reference on the
  32 \fBSIP\fR message passed as the argument. If this is the last reference on the
  33 \fBSIP\fR message (i.e. the number of references on the \fBSIP\fR message is
  34 \fB0\fR), the \fBSIP\fR message is destroyed and associated resources freed.
  35 Freeing a \fBSIP\fR message does not set the \fIsip_msg\fR pointer to
  36 \fINULL\fR. Applications should not expect the pointer to a freed \fBSIP\fR
  37 message to be \fINULL\fR.
  38 .SH RETURN VALUES
  39 .sp
  40 .LP
  41 The value of \fBerrno\fR is not changed by these calls in the event of an
  42 error.
  43 .SH ATTRIBUTES
  44 .sp
  45 .LP
  46 See \fBattributes\fR(5) for descriptions of the following attributes:
  47 .sp
  48
  49 .sp
  50 .TS
  51 box;
  52 c | c
  53 l | l .
  54 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  55 _
  56 Interface Stability     Committed
  57 _
  58 MT-Level        MT-Safe
  59 .TE
  60
  61 .SH SEE ALSO
  62 .sp
  63 .LP
  64 \fBlibsip\fR(3LIB)