share/man/man3sip/sip_create_OKack.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_CREATE_OKACK 3SIP "Jan 25, 2007"
   7 .SH NAME
   8 sip_create_OKack \- create an ACK request for a final response
   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 \fBint\fR \fIsip_create_OKack\fR(\fBsip_msg_t\fR \fIresponse\fR,
  16      \fBsip_msg_t\fR \fIack_msg\fR, \fBchar *\fR\fItransport\fR,
  17      \fBchar *\fR\fIsent_by\fR, \fBint\fR \fIsent_by_port\fR,
  18      \fBchar *\fR\fIvia_params\fR);
  19 .fi
  20
  21 .SH DESCRIPTION
  22 .sp
  23 .LP
  24 The \fBsip_create_OKack()\fR function constructs an \fBACK\fR request in
  25 \fIack_msg\fR for the final \fB2\fR\fIXX\fR \fBSIP\fR response. The request
  26 line is created using the \fBURI\fR in the \fBCONTACT\fR header from the
  27 \fIresponse\fR. The SIP-Version in the request line is "2.0". The \fBVIA\fR
  28 header for the \fBACK\fR request is created using \fItransport\fR,
  29 \fIsent_by\fR, \fIsent_by_port\fR (if non-zero), and \fIvia_params\fR (if
  30 non-null). The following headers are copied to \fIack_msg\fR from
  31 \fIresponse\fR:
  32 .br
  33 .in +2
  34 \fBFROM\fR
  35 .in -2
  36 .br
  37 .in +2
  38 \fBTO\fR
  39 .in -2
  40 .br
  41 .in +2
  42 \fBCALL-ID\fR
  43 .in -2
  44 .br
  45 .in +2
  46 \fBMAX_FORWARDS\fR
  47 .in -2
  48 .sp
  49 .LP
  50 The \fBCSEQ\fR header is created using the method as \fBACK\fR and the sequence
  51 number from the \fBCSEQ\fR header in \fIresponse\fR.
  52 .SH RETURN VALUES
  53 .sp
  54 .LP
  55 The \fBsip_create_OKack()\fR function returns \fB0\fR on success and the
  56 appropriate error value in case of failure.
  57 .sp
  58 .LP
  59 The value of \fBerrno\fR is not changed by these calls in the event of an
  60 error.
  61 .SH ERRORS
  62 .sp
  63 .LP
  64 On failure, the \fBsip_create_OKack()\fR function could return one of the
  65 following errors:
  66 .sp
  67 .ne 2
  68 .na
  69 \fB\fBEINVAL\fR\fR
  70 .ad
  71 .RS 11n
  72 If mandatory input is not provided or if the input is invalid.
  73 .sp
  74 The \fBsip_create_OKack()\fR function can return this error if it does not find
  75 a \fBCONTACT\fR header or if it is unable to obtain the \fBURI\fR from the
  76 \fBCONTACT\fR header for the request line.
  77 .RE
  78
  79 .sp
  80 .ne 2
  81 .na
  82 \fB\fBENOTSUP\fR\fR
  83 .ad
  84 .RS 11n
  85 If the input \fBSIP\fR message cannot be modified.
  86 .RE
  87
  88 .sp
  89 .ne 2
  90 .na
  91 \fB\fBENOMEM\fR\fR
  92 .ad
  93 .RS 11n
  94 If memory allocation fails when creating the request/response line or when
  95 creating headers in the \fBACK\fR request.
  96 .RE
  97
  98 .SH ATTRIBUTES
  99 .sp
 100 .LP
 101 See \fBattributes\fR(5) for descriptions of the following attributes:
 102 .sp
 103
 104 .sp
 105 .TS
 106 box;
 107 c | c
 108 l | l .
 109 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 110 _
 111 Interface Stability     Committed
 112 _
 113 MT-Level        MT-Safe
 114 .TE
 115
 116 .SH SEE ALSO
 117 .sp
 118 .LP
 119 \fBlibsip\fR(3LIB)