share/man/man3sip/sip_msg_to_str.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_MSG_TO_STR 3SIP "Jan 25, 2007"
   7 .SH NAME
   8 sip_msg_to_str, sip_hdr_to_str, sip_reqline_to_str, sip_respline_to_str,
   9 sip_sent_by_to_str \- return string representations
  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 \fBchar *\fR\fIsip_msg_to_str\fR(\fBsip_msg_t\fR \fIsip_msg\fR,
  17      \fBint *\fR\fIerror\fR);
  18 .fi
  19
  20 .LP
  21 .nf
  22 \fBchar *\fR\fIsip_hdr_to_str\fR(\fBsip_header_t\fR \fIsip_header\fR,
  23      \fBint *\fR\fIerror\fR);
  24 .fi
  25
  26 .LP
  27 .nf
  28 \fBchar *\fR\fIsip_reqline_to_str\fR(\fBsip_msg_t\fR \fIsip_msg\fR,
  29      \fBint *\fR\fIerror\fR);
  30 .fi
  31
  32 .LP
  33 .nf
  34 \fBchar *\fR\fIsip_respline_to_str\fR(\fBsip_msg_t\fR \fIsip_msg\fR,
  35      \fBint *\fR\fIerror\fR);
  36 .fi
  37
  38 .LP
  39 .nf
  40 \fBchar *\fR\fIsip_sent_by_to_str\fR(\fBint *\fR\fIerror\fR);
  41 .fi
  42
  43 .SH DESCRIPTION
  44 .sp
  45 .LP
  46 The \fBsip_msg_to_str()\fR function returns the string representation of the
  47 \fBSIP\fR message \fIsip_msg\fR. Deleted headers are not included in the
  48 returned string. The caller is responsible for freeing the returned string.
  49 .sp
  50 .LP
  51 The \fBsip_hdr_to_str()\fR function returns the string representation of the
  52 \fBSIP\fR header \fIsip_header\fR. The caller is responsible for freeing the
  53 returned string.
  54 .sp
  55 .LP
  56 The \fBsip_reqline_to_str()\fR function returns the string representation of
  57 the request line from the \fBSIP\fR message \fIsip_msg\fR. The caller is
  58 responsible for freeing the returned string.
  59 .sp
  60 .LP
  61 The \fBsip_respline_to_str()\fR function returns the string representation of
  62 the response line from the \fBSIP\fR message \fIsip_msg\fR. The caller is
  63 responsible for freeing the returned string.
  64 .sp
  65 .LP
  66 The \fBsip_sent_by_to_str()\fR function can be used to retrieve the list of
  67 sent-by values registered with the stack. The returned string is a comma
  68 separated list of sent-by values. The caller is responsible for freeing the
  69 returned string.
  70 .SH RETURN VALUES
  71 .sp
  72 .LP
  73 The \fBsip_msg_to_str()\fR, \fBsip_hdr_to_str()\fR, \fBsip_reqline_to_str()\fR,
  74 \fBsip_respline_to_str()\fR, and \fBsip_sent_by_to_str()\fR functions return
  75 the relevant string on success and \fBNULL\fR on failure.
  76 .sp
  77 .LP
  78 The value of \fBerrno\fR is not changed by these calls in the event of an
  79 error.
  80 .SH ERRORS
  81 .sp
  82 .LP
  83 For the \fBsip_msg_to_str()\fR, \fBsip_hdr_to_str()\fR,
  84 \fBsip_reqline_to_str()\fR, and \fBsip_respline_to_str()\fR, one of the
  85 following values is set if the error is non-null:
  86 .sp
  87 .ne 2
  88 .na
  89 \fB\fBEINVAL\fR\fR
  90 .ad
  91 .RS 10n
  92 Input is null.
  93 .RE
  94
  95 .sp
  96 .ne 2
  97 .na
  98 \fB\fBENOMEM\fR\fR
  99 .ad
 100 .RS 10n
 101 Memory allocation failure.
 102 .RE
 103
 104 .sp
 105 .LP
 106 On success, the value of the location pointed to by \fIerror\fR is set to
 107 \fB0\fR.
 108 .SH ATTRIBUTES
 109 .sp
 110 .LP
 111 See \fBattributes\fR(5) for descriptions of the following attributes:
 112 .sp
 113
 114 .sp
 115 .TS
 116 box;
 117 c | c
 118 l | l .
 119 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 120 _
 121 Interface Stability     Committed
 122 _
 123 MT-Level        MT-Safe
 124 .TE
 125
 126 .SH SEE ALSO
 127 .sp
 128 .LP
 129 \fBlibsip\fR(3LIB)