1eXosip2 SUBSCRIBE and outgoing seuXboslsciirbpie2pXtoSisUoiBnpSs2C(R3I)BE and outgoing subscriptions(3)
2
3
4

NAME

6       eXosip2 SUBSCRIBE and outgoing subscriptions -
7
8   Enumerations
9       enum eXosip_ss { EXOSIP_SUBCRSTATE_UNKNOWN, EXOSIP_SUBCRSTATE_PENDING,
10           EXOSIP_SUBCRSTATE_ACTIVE, EXOSIP_SUBCRSTATE_TERMINATED }
11       enum eXosip_ss_reason { DEACTIVATED, PROBATION, REJECTED, TIMEOUT,
12           GIVEUP, NORESOURCE }
13       enum eXosip_ss_status { EXOSIP_NOTIFY_UNKNOWN, EXOSIP_NOTIFY_PENDING,
14           EXOSIP_NOTIFY_ONLINE, EXOSIP_NOTIFY_BUSY,
15           EXOSIP_NOTIFY_BERIGHTBACK, EXOSIP_NOTIFY_AWAY,
16           EXOSIP_NOTIFY_ONTHEPHONE, EXOSIP_NOTIFY_OUTTOLUNCH,
17           EXOSIP_NOTIFY_CLOSED }
18
19   Functions
20       int eXosip_subscribe_build_initial_request (osip_message_t **subscribe,
21           const char *to, const char *from, const char *route, const char
22           *event, int expires)
23       int eXosip_subscribe_send_initial_request (osip_message_t *subscribe)
24       int eXosip_subscribe_build_refresh_request (int did, osip_message_t
25           **sub)
26       int eXosip_subscribe_send_refresh_request (int did, osip_message_t
27           *sub)
28       int eXosip_subscribe_remove (int did)
29

Enumeration Type Documentation

31   enum eXosip_ss
32       Enumerator:
33
34       EXOSIP_SUBCRSTATE_UNKNOWN
35              unknown subscription-state
36
37       EXOSIP_SUBCRSTATE_PENDING
38              pending subscription-state
39
40       EXOSIP_SUBCRSTATE_ACTIVE
41              active subscription-state
42
43       EXOSIP_SUBCRSTATE_TERMINATED
44              terminated subscription-state
45
46   enum eXosip_ss_reason
47       Enumerator:
48
49       DEACTIVATED
50              deactivated for subscription-state
51
52       PROBATION
53              probation for subscription-state
54
55       REJECTED
56              rejected for subscription-state
57
58       TIMEOUT
59              timeout for subscription-state
60
61       GIVEUP giveup for subscription-state
62
63       NORESOURCE
64              noresource for subscription-state
65
66   enum eXosip_ss_status
67       Enumerator:
68
69       EXOSIP_NOTIFY_UNKNOWN
70              unknown state for subscription
71
72       EXOSIP_NOTIFY_PENDING
73              subscription not yet accepted
74
75       EXOSIP_NOTIFY_ONLINE
76              online status
77
78       EXOSIP_NOTIFY_BUSY
79              busy status
80
81       EXOSIP_NOTIFY_BERIGHTBACK
82              be right back status
83
84       EXOSIP_NOTIFY_AWAY
85              away status
86
87       EXOSIP_NOTIFY_ONTHEPHONE
88              on the phone status
89
90       EXOSIP_NOTIFY_OUTTOLUNCH
91              out to lunch status
92
93       EXOSIP_NOTIFY_CLOSED
94              closed status
95

Function Documentation

97   int eXosip_subscribe_build_initial_request (osip_message_t ** subscribe,
98       const char * to, const char * from, const char * route, const char *
99       event, int expires)
100       Build a default initial SUBSCRIBE request.
101
102       Parameters:
103           subscribe Pointer for the SIP request to build.
104           to SIP url for callee.
105           from SIP url for caller.
106           route Route header for SUBSCRIBE. (optionnal)
107           event Event header for SUBSCRIBE.
108           expires Expires header for SUBSCRIBE.
109
110   int eXosip_subscribe_send_initial_request (osip_message_t * subscribe)
111       Send an initial SUBSCRIBE request.
112
113       Parameters:
114           subscribe SIP SUBSCRIBE message to send.
115
116   int eXosip_subscribe_build_refresh_request (int did, osip_message_t ** sub)
117       Build a default new SUBSCRIBE message.
118
119       Parameters:
120           did identifier of the subscription.
121           sub Pointer for the SIP request to build.
122
123   int eXosip_subscribe_send_refresh_request (int did, osip_message_t * sub)
124       Send a new SUBSCRIBE request.
125
126       Parameters:
127           did identifier of the subscription.
128           sub SIP SUBSCRIBE message to send.
129
130   int eXosip_subscribe_remove (int did)
131       Remove outgoing subscription context.
132
133       Parameters:
134           did identifier of the subscription.
135
136Version 3.0.1                  eXo3s0ipA2ugSU2B0S0C7RIBE and outgoing subscriptions(3)