eXosip2_subscribe - Man Page

eXosip2 SUBSCRIBE and outgoing subscriptions

Synopsis

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_subscription_build_initial_subscribe (struct eXosip_t *excontext, osip_message_t **subscribe, const char *to, const char *from, const char *route, const char *event, int expires)
int eXosip_subscription_build_initial_refer (struct eXosip_t *excontext, osip_message_t **refer, const char *to, const char *from, const char *route, const char *refer_to)
int eXosip_subscription_send_initial_request (struct eXosip_t *excontext, osip_message_t *subscribe)
int eXosip_subscription_build_refresh_request (struct eXosip_t *excontext, int did, osip_message_t **sub)
int eXosip_subscription_send_refresh_request (struct eXosip_t *excontext, int did, osip_message_t *sub)
int eXosip_subscription_remove (struct eXosip_t *excontext, int did)

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_subscription_build_initial_subscribe (struct eXosip_t * excontext, 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

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_subscription_build_initial_refer (struct eXosip_t * excontext, osip_message_t ** refer, const char * to, const char * from, const char * route, const char * refer_to)

Build a default initial REFER request.

Parameters

excontext eXosip_t instance.
refer Pointer for the SIP request to build.
to SIP url for callee.
from SIP url for caller.
route Route header for REFER. (optional)
refer_to SIP url for transfer.

int eXosip_subscription_send_initial_request (struct eXosip_t * excontext, osip_message_t * subscribe)

Send an initial SUBSCRIBE/REFER request.

Parameters

excontext eXosip_t instance.
subscribe SIP SUBSCRIBE message to send.

int eXosip_subscription_build_refresh_request (struct eXosip_t * excontext, int did, osip_message_t ** sub)

Build a default new SUBSCRIBE/REFER refresh message.

Parameters

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

int eXosip_subscription_send_refresh_request (struct eXosip_t * excontext, int did, osip_message_t * sub)

Send a new SUBSCRIBE/REFER refresh request.

Parameters

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

int eXosip_subscription_remove (struct eXosip_t * excontext, int did)

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.

Info

Thu May 18 2023 Version 5.3.0 libeXosip2