share/man/man3sip/sip_branchid.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_BRANCHID 3SIP "Jan 25, 2007"
   7 .SH NAME
   8 sip_branchid \- generate a RFC 3261 complaint branch ID
   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 \fBchar *\fR\fIsip_branchid\fR(\fBsip_msg_t\fR \fIsip_msg\fR);
  16 .fi
  17
  18 .SH DESCRIPTION
  19 .sp
  20 .LP
  21 The \fBsip_branchid()\fR function can be used to generate a value for the
  22 branch parameter for a \fBVIA\fR header. The returned string is prefixed with
  23 \fBz9hG4bK\fR to conform to RFC 3261. If \fIsip_msg\fR is null or \fIsip_msg\fR
  24 does not have a \fBVIA\fR header, a random value is generated. Otherwise, the
  25 value is generated using the \fBMD5\fR hash of the \fBVIA\fR, \fBFROM\fR,
  26 \fBCALL-ID\fR, \fBCSEQ\fR headers and the \fBURI\fR from the request line. The
  27 caller is responsible for freeing the returned string.
  28 .SH RETURN VALUES
  29 .sp
  30 .LP
  31 The \fBsip_branchid()\fR function returns a string on success and \fBNULL\fR on
  32 failure.
  33 .sp
  34 .LP
  35 The value of \fBerrno\fR is not changed by these calls in the event of an
  36 error.
  37 .SH ATTRIBUTES
  38 .sp
  39 .LP
  40 See \fBattributes\fR(5) for descriptions of the following attributes:
  41 .sp
  42
  43 .sp
  44 .TS
  45 box;
  46 c | c
  47 l | l .
  48 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  49 _
  50 Interface Stability     Committed
  51 _
  52 MT-Level        MT-Safe
  53 .TE
  54
  55 .SH SEE ALSO
  56 .sp
  57 .LP
  58 \fBlibsip\fR(3LIB)