share/man/man3sip/sip_add_branchid_to_via.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_ADD_BRANCHID_TO_VIA 3SIP "Jan 25, 2007"
   7 .SH NAME
   8 sip_add_branchid_to_via \- add a branch parameter to the topmost VIA header in
   9 the SIP message
  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_add_branchid_to_via\fR(\fBsip_msg_t\fR \fIsip_msg\fR, \fBchar *\fR\fIbranchid\fR);
  17 .fi
  18
  19 .SH DESCRIPTION
  20 .sp
  21 .LP
  22 The \fBsip_add_branchid_to_via()\fR function adds a branch \fIparam\fR to the
  23 topmost \fBVIA\fR header in the \fBSIP\fR message \fIsip_msg\fR. Note that a
  24 new header is created as a result of adding the branch parameter and the old
  25 header is marked deleted. Applications with multiple threads working on the
  26 same \fBVIA\fR header need to take note of this.
  27 .SH RETURN VALUES
  28 .sp
  29 .LP
  30 These functions return \fB0\fR on success and the appropriate error value on
  31 failure.
  32 .SH ERRORS
  33 .sp
  34 .LP
  35 On failure, functions that return an error value may return one of the
  36 following:
  37 .sp
  38 .ne 2
  39 .na
  40 \fB\fBEINVAL\fR\fR
  41 .ad
  42 .RS 10n
  43 Mandatory parameters are not provided or are NULL.
  44 .sp
  45 For \fBsip_add_branchid_to_via()\fR, the topmost \fBVIA\fR header already has a
  46 branch \fIparam\fR or the \fBSIP\fR message does not have a \fBVIA\fR header.
  47 .RE
  48
  49 .sp
  50 .ne 2
  51 .na
  52 \fB\fBEPERM\fR\fR
  53 .ad
  54 .RS 10n
  55 The message cannot be modified.
  56 .RE
  57
  58 .sp
  59 .ne 2
  60 .na
  61 \fB\fBENOMEM\fR\fR
  62 .ad
  63 .RS 10n
  64 There is an error allocating memory for creating headers/parameters.
  65 .RE
  66
  67 .SH ATTRIBUTES
  68 .sp
  69 .LP
  70 See \fBattributes\fR(5) for descriptions of the following attributes:
  71 .sp
  72
  73 .sp
  74 .TS
  75 box;
  76 c | c
  77 l | l .
  78 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  79 _
  80 Interface Stability     Committed
  81 _
  82 MT-Level        MT-Safe
  83 .TE
  84
  85 .SH SEE ALSO
  86 .sp
  87 .LP
  88 \fBlibsip\fR(3LIB)