eXosip2_subscribe man page

eXosip2_subscribe — eXosip2 SUBSCRIBE and outgoing subscriptions

Enumerations

Functions

int eXosip_subscribe_build_initial_request (osip_message_t **subscribe, const char *to, const char *from, const char *route, const char *event, int expires)

int eXosip_subscribe_send_initial_request (osip_message_t *subscribe)

int eXosip_subscribe_build_refresh_request (int did, osip_message_t **sub)

int eXosip_subscribe_send_refresh_request (int did, osip_message_t *sub)

int eXosip_subscribe_remove (int did)

Enumeration Type Documentation

enum eXosip_ss

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

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

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 (osip_message_t ** subscribe, const char * to, const char * from, const char * route, const char * event, int expires)

Build a default initial SUBSCRIBE request.

Parameters:

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 (osip_message_t * subscribe)

Send an initial SUBSCRIBE request.

Parameters:

subscribe SIP SUBSCRIBE message to send.

int eXosip_subscribe_build_refresh_request (int did, osip_message_t ** sub)

Build a default new SUBSCRIBE message.

Parameters:

did identifier of the subscription.
sub Pointer for the SIP request to build.

int eXosip_subscribe_send_refresh_request (int did, osip_message_t * sub)

Send a new SUBSCRIBE request.

Parameters:

did identifier of the subscription.
sub SIP SUBSCRIBE message to send.

int eXosip_subscribe_remove (int did)

Remove outgoing subscription context.

Parameters:

did identifier of the subscription.

Author

Generated automatically by Doxygen for libeXosip2 from the source code.

Info

Thu Feb 4 2016 Version 3.1.0 libeXosip2