1sip_hold_msg(3SIP)Session Initiation Protocol Library Functionssip_hold_msg(3SIP)
2
3
4

NAME

6       sip_hold_msg,  sip_free_msg  -  adds and removes a reference from a SIP
7       message
8

SYNOPSIS

10       cc [ flag ... ] file ... -lsip [ library ... ]
11       #include <sip.h>
12
13       void sip_hold_msg(sip_msg_t sip_msg);
14
15
16       void sip_free_msg(sip_msg_t sip_msg);
17
18

DESCRIPTION

20       The sip_hold_msg() function adds a reference to the SIP message  passed
21       as  the argument. The reference is used to prevent the SIP message from
22       being freed when in use.
23
24
25       The sip_free_msg() function is used to remove an added reference on the
26       SIP  message  passed  as the argument. If this is the last reference on
27       the SIP message (i.e. the number of references on the  SIP  message  is
28       0),  the SIP message is destroyed and associated resources freed. Free‐
29       ing a SIP message does not set the sip_msg pointer  to  NULL.  Applica‐
30       tions should not expect the pointer to a freed SIP message to be NULL.
31

RETURN VALUES

33       The  value  of  errno  is not changed by these calls in the event of an
34       error.
35

ATTRIBUTES

37       See attributes(5) for descriptions of the following attributes:
38
39
40
41
42       ┌─────────────────────────────┬─────────────────────────────┐
43       │      ATTRIBUTE TYPE         │      ATTRIBUTE VALUE        │
44       ├─────────────────────────────┼─────────────────────────────┤
45       │Interface Stability          │Committed                    │
46       ├─────────────────────────────┼─────────────────────────────┤
47       │MT-Level                     │MT-Safe                      │
48       └─────────────────────────────┴─────────────────────────────┘
49

SEE ALSO

51       libsip(3LIB)
52
53
54
55SunOS 5.11                        25 Jan 2007               sip_hold_msg(3SIP)
Impressum