libeXosip2  4.1.0
Enumerations | Functions
eXosip2 SUBSCRIBE and outgoing subscriptions
SIP messages and call control API

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 (struct eXosip_t *excontext, osip_message_t **subscribe, const char *to, const char *from, const char *route, const char *event, int expires)
int eXosip_subscribe_send_initial_request (struct eXosip_t *excontext, osip_message_t *subscribe)
int eXosip_subscribe_build_refresh_request (struct eXosip_t *excontext, int did, osip_message_t **sub)
int eXosip_subscribe_send_refresh_request (struct eXosip_t *excontext, int did, osip_message_t *sub)
int eXosip_subscribe_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

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

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,
int  expires 
)

Build a default initial SUBSCRIBE request.

Parameters
excontexteXosip_t instance.
subscribePointer for the SIP request to build.
toSIP url for callee.
fromSIP url for caller.
routeRoute header for SUBSCRIBE. (optional)
eventEvent header for SUBSCRIBE.
expiresExpires header for SUBSCRIBE.
int eXosip_subscribe_send_initial_request ( struct eXosip_t *  excontext,
osip_message_t *  subscribe 
)

Send an initial SUBSCRIBE request.

Parameters
excontexteXosip_t instance.
subscribeSIP SUBSCRIBE message to send.
int eXosip_subscribe_build_refresh_request ( struct eXosip_t *  excontext,
int  did,
osip_message_t **  sub 
)

Build a default new SUBSCRIBE message.

Parameters
excontexteXosip_t instance.
dididentifier of the subscription.
subPointer for the SIP request to build.
int eXosip_subscribe_send_refresh_request ( struct eXosip_t *  excontext,
int  did,
osip_message_t *  sub 
)

Send a new SUBSCRIBE request.

Parameters
excontexteXosip_t instance.
dididentifier of the subscription.
subSIP SUBSCRIBE message to send.
int eXosip_subscribe_remove ( struct eXosip_t *  excontext,
int  did 
)

Remove outgoing subscription context.

Parameters
excontexteXosip_t instance.
dididentifier of the subscription.