table of contents
eXosip2 SUBSCRIBE and outgoing subscriptions(3) | libeXosip2 | eXosip2 SUBSCRIBE and outgoing subscriptions(3) |
NAME¶
eXosip2 SUBSCRIBE and outgoing subscriptions -Enumerations¶
enum eXosip_ss { EXOSIP_SUBCRSTATE_UNKNOWN, EXOSIP_SUBCRSTATE_PENDING, EXOSIP_SUBCRSTATE_ACTIVE, EXOSIP_SUBCRSTATE_TERMINATED }
Functions¶
int eXosip_subscribe_build_initial_request (struct eXosip_t *excontext, osip_message_t **subscribe, const char *to, const char *from, const char *route, const char *event, int expires)
Detailed Description¶
Enumeration Type Documentation¶
enum eXosip_ss¶
Structure for subscription status Enumerator- EXOSIP_SUBCRSTATE_UNKNOWN
- unknown subscription-state
- EXOSIP_SUBCRSTATE_PENDING
- pending subscription-state
- EXOSIP_SUBCRSTATE_ACTIVE
- active subscription-state
- EXOSIP_SUBCRSTATE_TERMINATED
- terminated subscription-state
enum eXosip_ss_reason¶
Structure for subscription reason Enumerator- DEACTIVATED
- deactivated for subscription-state
- PROBATION
- probation for subscription-state
- REJECTED
- rejected for subscription-state
- TIMEOUT
- timeout for subscription-state
- GIVEUP
- giveup for subscription-state
- NORESOURCE
- noresource for subscription-state
enum eXosip_ss_status¶
Structure for notification status Enumerator- EXOSIP_NOTIFY_UNKNOWN
- unknown state for subscription
- EXOSIP_NOTIFY_PENDING
- subscription not yet accepted
- EXOSIP_NOTIFY_ONLINE
- online status
- EXOSIP_NOTIFY_BUSY
- busy status
- EXOSIP_NOTIFY_BERIGHTBACK
- be right back status
- EXOSIP_NOTIFY_AWAY
- away status
- EXOSIP_NOTIFY_ONTHEPHONE
- on the phone status
- EXOSIP_NOTIFY_OUTTOLUNCH
- out to lunch status
- EXOSIP_NOTIFY_CLOSED
- closed status
Function Documentation¶
int eXosip_subscribe_build_initial_request (struct eXosip_t *excontext, osip_message_t **subscribe, const char *to, const char *from, const char *route, const char *event, intexpires)¶
Build a default initial SUBSCRIBE request. Parameters:excontext eXosip_t instance.
subscribe Pointer for the SIP request to build.
to SIP url for callee.
from SIP url for caller.
route Route header for SUBSCRIBE. (optional)
event Event header for SUBSCRIBE.
expires Expires header for SUBSCRIBE.
int eXosip_subscribe_send_initial_request (struct eXosip_t *excontext, osip_message_t *subscribe)¶
Send an initial SUBSCRIBE request. Parameters:excontext eXosip_t instance.
subscribe SIP SUBSCRIBE message to send.
int eXosip_subscribe_build_refresh_request (struct eXosip_t *excontext, intdid, osip_message_t **sub)¶
Build a default new SUBSCRIBE message. Parameters:excontext eXosip_t instance.
did identifier of the subscription.
sub Pointer for the SIP request to build.
int eXosip_subscribe_send_refresh_request (struct eXosip_t *excontext, intdid, osip_message_t *sub)¶
Send a new SUBSCRIBE request. Parameters:excontext eXosip_t instance.
did identifier of the subscription.
sub SIP SUBSCRIBE message to send.
int eXosip_subscribe_remove (struct eXosip_t *excontext, intdid)¶
Remove outgoing subscription context. Parameters:excontext eXosip_t instance.
did identifier of the subscription.
Author¶
Generated automatically by Doxygen for libeXosip2 from the source code.Sat Aug 16 2014 | Version 4.1.0 |