1sip_msg_to_str(3SISPe)ssion Initiation Protocol Library Functisoinps_msg_to_str(3SIP)
2
3
4

NAME

6       sip_msg_to_str,           sip_hdr_to_str,           sip_reqline_to_str,
7       sip_respline_to_str, sip_sent_by_to_str - return string representations
8

SYNOPSIS

10       cc [ flag ... ] file ... -lsip [ library ... ]
11       #include <sip.h>
12
13       char *sip_msg_to_str(sip_msg_t sip_msg,
14            int *error);
15
16
17       char *sip_hdr_to_str(sip_header_t sip_header,
18            int *error);
19
20
21       char *sip_reqline_to_str(sip_msg_t sip_msg,
22            int *error);
23
24
25       char *sip_respline_to_str(sip_msg_t sip_msg,
26            int *error);
27
28
29       char *sip_sent_by_to_str(int *error);
30
31

DESCRIPTION

33       The sip_msg_to_str() function returns the string representation of  the
34       SIP  message  sip_msg. Deleted headers are not included in the returned
35       string. The caller is responsible for freeing the returned string.
36
37
38       The sip_hdr_to_str() function returns the string representation of  the
39       SIP  header  sip_header.  The  caller  is  responsible  for freeing the
40       returned string.
41
42
43       The sip_reqline_to_str() function returns the string representation  of
44       the  request line from the SIP message sip_msg. The caller is responsi‐
45       ble for freeing the returned string.
46
47
48       The sip_respline_to_str() function returns the string representation of
49       the response line from the SIP message sip_msg. The caller is responsi‐
50       ble for freeing the returned string.
51
52
53       The sip_sent_by_to_str() function can be used to retrieve the  list  of
54       sent-by  values  registered  with  the  stack. The returned string is a
55       comma separated list of sent-by values. The caller is  responsible  for
56       freeing the returned string.
57

RETURN VALUES

59       The     sip_msg_to_str(),    sip_hdr_to_str(),    sip_reqline_to_str(),
60       sip_respline_to_str(), and sip_sent_by_to_str()  functions  return  the
61       relevant string on success and NULL on failure.
62
63
64       The  value  of  errno  is not changed by these calls in the event of an
65       error.
66

ERRORS

68       For the sip_msg_to_str(), sip_hdr_to_str(),  sip_reqline_to_str(),  and
69       sip_respline_to_str(),  one of the following values is set if the error
70       is non-null:
71
72       EINVAL    Input is null.
73
74
75       ENOMEM    Memory allocation failure.
76
77
78
79       On success, the value of the location pointed to by error is set to 0.
80

ATTRIBUTES

82       See attributes(5) for descriptions of the following attributes:
83
84
85
86
87       ┌─────────────────────────────┬─────────────────────────────┐
88       │      ATTRIBUTE TYPE         │      ATTRIBUTE VALUE        │
89       ├─────────────────────────────┼─────────────────────────────┤
90       │Interface Stability          │Committed                    │
91       ├─────────────────────────────┼─────────────────────────────┤
92       │MT-Level                     │MT-Safe                      │
93       └─────────────────────────────┴─────────────────────────────┘
94

SEE ALSO

96       libsip(3LIB)
97
98
99
100SunOS 5.11                        25 Jan 2007             sip_msg_to_str(3SIP)
Impressum