1sip_get_dialog_staStees(s3iSoInP)Initiation Protocol LibrarysFiupn_cgteito_ndsialog_state(3SIP)
2
3
4

NAME

6       sip_get_dialog_state,  sip_get_dialog_callid, sip_get_dialog_local_tag,
7       sip_get_dialog_remote_tag,    sip_get_dialog_local_uri,    sip_get_dia‐
8       log_remote_uri,      sip_get_dialog_local_contact_uri,     sip_get_dia‐
9       log_remote_target_uri,      sip_get_dialog_route_set,      sip_get_dia‐
10       log_local_cseq,     sip_get_dialog_remote_cseq,    sip_get_dialog_type,
11       sip_get_dialog_method,  sip_is_dialog_secure,  sip_get_dialog_msgcnt  -
12       get dialog attributes
13

SYNOPSIS

15       cc [ flag ... ] file ... -lsip [ library ... ]
16       #include <sip.h>
17
18       int sip_get_dialog_state(sip_dialog_t dialog, int *error);
19
20
21       const sip_str_t *sip_get_dialog_callid(sip_dialog_t dialog,
22            int *error);
23
24
25       const sip_str_t *sip_get_dialog_local_tag(sip_dialog_t dialog,
26            int *error);
27
28
29       const sip_str_t *sip_get_dialog_remote_tag(sip_dialog_t dialog,
30            int *error);
31
32
33       const struct sip_uri *sip_get_dialog_local_uri(sip_dialog_t dialog,
34            int *error);
35
36
37       const struct sip_uri *sip_get_dialog_remote_uri(sip_dialog_t dialog,
38            int *error);
39
40
41       const struct sip_uri *sip_get_dialog_local_contact_uri(
42            sip_dialog_t dialog, int *error);
43
44
45       const struct sip_uri *sip_get_dialog_remote_target_uri(
46            sip_dialog_t dialog, int *error);
47
48
49       const sip_str_t *sip_get_dialog_route_set(sip_dialog_t dialog,
50            int *error);
51
52
53       boolean_t sip_is_dialog_secure(sip_dialog_t dialog,
54            int *error);
55
56
57       uint32_t sip_get_dialog_local_cseq(sip_dialog_t dialog,
58            int *error);
59
60
61       uint32_t sip_get_dialog_remote_cseq(sip_dialog_t dialog,
62            int *error);
63
64
65       int sip_get_dialog_type(sip_dialog_t dialog,int *error);
66
67
68       int sip_get_dialog_method(sip_dialog_t dialog,int *error);
69
70
71       int sip_get_dialog_msgcnt(sip_dialog_t dialog,int *error);
72
73

DESCRIPTION

75       For  functions  that  return  a pointer of type sip_str_t, sip_str_t is
76       supplied by:
77
78         typedef struct sip_str {
79              char *sip_str_ptr;
80              int  sip_str_len;
81         }sip_str_t;
82
83
84
85       The sip_str_ptr parameter points to the start of the returned value and
86       sip_str_len supplies the length of the returned value.
87
88
89       The  sip_get_dialog_state()  returns  the state of the dialog. A dialog
90       can be in one of the following states:
91         SIP_DLG_NEW
92         SIP_DLG_EARLY
93         SIP_DLG_CONFIRMED
94         SIP_DLG_DESTROYED
95
96
97       The sip_get_dialog_callid() function returns the call  ID  value  main‐
98       tained in the dialog.
99
100
101       The  sip_get_dialog_local_tag()  and  sip_get_dialog_remote_tag() func‐
102       tions return the local and remote tag values, maintained in the dialog.
103
104
105       The      sip_get_dialog_local_uri(),       sip_get_dialog_remote_uri(),
106       sip_get_dialog_local_contact_uri(),    and   sip_get_dialog_remote_tar‐
107       get_uri() functions return the local, remote, local contract,  and  the
108       remote target URIs, maintained in the dialog.
109
110
111       The  sip_get_dialog_route_set() function returns the route set, if any,
112       maintained in the dialog.
113
114
115       The sip_get_dialog_local_cseq() and sip_get_dialog_remote_cseq()  func‐
116       tions  return  the local and remote CSEQ numbers maintained in the dia‐
117       log.
118
119
120       The sip_get_dialog_type() function returns one of the following  dialog