exosip2_subscribe(3) [debian man page]
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 } enum eXosip_ss_reason { DEACTIVATED, PROBATION, REJECTED, TIMEOUT, GIVEUP, NORESOURCE } enum eXosip_ss_status { EXOSIP_NOTIFY_UNKNOWN, EXOSIP_NOTIFY_PENDING, EXOSIP_NOTIFY_ONLINE, EXOSIP_NOTIFY_BUSY, EXOSIP_NOTIFY_BERIGHTBACK, EXOSIP_NOTIFY_AWAY, EXOSIP_NOTIFY_ONTHEPHONE, EXOSIP_NOTIFY_OUTTOLUNCH, EXOSIP_NOTIFY_CLOSED } 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) Detailed Description 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, intexpires) 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 (intdid, 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 (intdid, 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 (intdid) Remove outgoing subscription context. Parameters: did identifier of the subscription. Author Generated automatically by Doxygen for libeXosip2 from the source code. Version 3.1.0 Sun Jun 24 2012 eXosip2 SUBSCRIBE and outgoing subscriptions(3)
Check Out this Related Man Page
eXosip2 INVITE and Call Management(3) libeXosip2 eXosip2 INVITE and Call Management(3) NAME
eXosip2 INVITE and Call Management - Functions int eXosip_call_set_reference (int id, void *reference) void * eXosip_call_get_reference (int cid) int eXosip_call_build_initial_invite (osip_message_t **invite, const char *to, const char *from, const char *route, const char *subject) int eXosip_call_send_initial_invite (osip_message_t *invite) int eXosip_call_build_request (int did, const char *method, osip_message_t **request) int eXosip_call_build_ack (int did, osip_message_t **ack) int eXosip_call_send_ack (int did, osip_message_t *ack) int eXosip_call_build_refer (int did, const char *refer_to, osip_message_t **request) int eXosip_call_build_info (int did, osip_message_t **request) int eXosip_call_build_options (int did, osip_message_t **request) int eXosip_call_build_update (int did, osip_message_t **request) int eXosip_call_build_notify (int did, int subscription_status, osip_message_t **request) int eXosip_call_send_request (int did, osip_message_t *request) int eXosip_call_build_answer (int tid, int status, osip_message_t **answer) int eXosip_call_send_answer (int tid, int status, osip_message_t *answer) int eXosip_call_terminate (int cid, int did) int eXosip_call_build_prack (int tid, osip_message_t **prack) int eXosip_call_send_prack (int tid, osip_message_t *prack) int eXosip_transfer_send_notify (int did, int subscription_status, char *body) int eXosip_call_get_referto (int did, char *refer_to, size_t refer_to_len) int eXosip_call_find_by_replaces (char *replaces) Detailed Description Function Documentation int eXosip_call_set_reference (intid, void *reference) Set a new application context for an existing call Parameters: id call-id or dialog-id of call reference New application context. void* eXosip_call_get_reference (intcid) Get the application context pointer for an existing call. Parameters: cid id of the call. Returns: Application context reference int eXosip_call_build_initial_invite (osip_message_t **invite, const char *to, const char *from, const char *route, const char *subject) Build a default INVITE message for a new call. Parameters: invite Pointer for the SIP element to hold. to SIP url for callee. from SIP url for caller. route Route header for INVITE. (optional) subject Subject for the call. int eXosip_call_send_initial_invite (osip_message_t *invite) Initiate a call. Parameters: invite SIP INVITE message to send. int eXosip_call_build_request (intdid, const char *method, osip_message_t **request) Build a default request within a call. (INVITE, OPTIONS, INFO, REFER) Parameters: did dialog id of call. method request type to build. request The sip request to build. int eXosip_call_build_ack (intdid, osip_message_t **ack) Build a default ACK for a 200ok received. Parameters: did dialog id of call. ack The sip request to build. int eXosip_call_send_ack (intdid, osip_message_t *ack) Send the ACK for the 200ok received.. Parameters: did dialog id of call. ack SIP ACK message to send. int eXosip_call_build_refer (intdid, const char *refer_to, osip_message_t **request) Build a default REFER for a call transfer. Parameters: did dialog id of call. refer_to url for call transfer (Refer-To header). request The sip request to build. int eXosip_call_build_info (intdid, osip_message_t **request) Build a default INFO within a call. Parameters: did dialog id of call. request The sip request to build. int eXosip_call_build_options (intdid, osip_message_t **request) Build a default OPTIONS within a call. Parameters: did dialog id of call. request The sip request to build. int eXosip_call_build_update (intdid, osip_message_t **request) Build a default UPDATE within a call. Parameters: did dialog id of call. request The sip request to build. int eXosip_call_build_notify (intdid, intsubscription_status, osip_message_t **request) Build a default NOTIFY within a call. Parameters: did dialog id of call. subscription_status Subscription status of the request. request The sip request to build. int eXosip_call_send_request (intdid, osip_message_t *request) send the request within call. (INVITE, OPTIONS, INFO, REFER, UPDATE) Parameters: did dialog id of call. request The sip request to send. int eXosip_call_build_answer (inttid, intstatus, osip_message_t **answer) Build default Answer for request. Parameters: tid id of transaction to answer. status Status code to use. answer The sip answer to build. int eXosip_call_send_answer (inttid, intstatus, osip_message_t *answer) Send Answer for invite. Parameters: tid id of transaction to answer. status response status if answer is NULL. (not allowed for 2XX) answer The sip answer to send. int eXosip_call_terminate (intcid, intdid) Terminate a call. send CANCEL, BYE or 603 Decline. Parameters: cid call id of call. did dialog id of call. int eXosip_call_build_prack (inttid, osip_message_t **prack) Build a PRACK for invite. Parameters: tid id of the invite transaction. prack The sip prack to build. int eXosip_call_send_prack (inttid, osip_message_t *prack) Send a PRACK for invite. Parameters: tid id of the invite transaction. prack The sip prack to send. int eXosip_transfer_send_notify (intdid, intsubscription_status, char *body) Send a NOTIFY containing the information about a call transfer. THIS METHOD WILL BE REPLACED or REMOVED, please use the new API to build NOTIFY. Parameters: did dialog id of call. subscription_status the subscription status. body the body to attach to NOTIFY. int eXosip_call_get_referto (intdid, char *refer_to, size_trefer_to_len) Get Refer-To header with Replace parameter from dialog. Parameters: did id of the dialog. refer_to buffer to be filled with refer-to info. refer_to_len size of refer_to buffer. int eXosip_call_find_by_replaces (char *replaces) Return did (or cid) for the replace header. Parameters: replaces buffer to be filled with refer-to info. Author Generated automatically by Doxygen for libeXosip2 from the source code. Version 3.1.0 Sun Jun 24 2012 eXosip2 INVITE and Call Management(3)