libamsip  5.1.0
Functions
amsip subscription interface
Subscription control and Instant Messaging API.

Functions

int am_subscription_start (const char *identity, const char *url, const char *proxy, const char *route, const char *event, const char *accept, int expires)
int am_subscription_build_initial_subscribe (const char *identity, const char *url, const char *proxy, const char *route, const char *event, const char *accept, int expires, osip_message_t **asubscribe)
int am_subscription_start_with_initial_subscribe (osip_message_t *subscribe)
int am_subscription_refresh (int did, const char *event, const char *accept, int expires)
int am_subscription_build_refresh (int did, const char *event, const char *accept, int expires, osip_message_t **subscribe)
int am_subscription_send_refresh (int did, osip_message_t *subscribe)
int am_subscription_remove (int did)

Detailed Description

Function Documentation

int am_subscription_start ( const char *  identity,
const char *  url,
const char *  proxy,
const char *  route,
const char *  event,
const char *  accept,
int  expires 
)

Configure amsip to start a SIP subscription.

Parameters
identitySIP url for caller.
urlSIP url for callee.
proxyproxy header for SUBSCRIBE.
routeSet the outbound proxy server
eventEvent header for SUBSCRIBE.
acceptAccept header.
expiresExpires header for SUBSCRIBE.
int am_subscription_build_initial_subscribe ( const char *  identity,
const char *  url,
const char *  proxy,
const char *  route,
const char *  event,
const char *  accept,
int  expires,
osip_message_t **  asubscribe 
)

Configure amsip to start a SIP subscription.

Parameters
identitySIP url for caller.
urlSIP url for callee.
proxyproxy header for SUBSCRIBE.
routeSet the outbound proxy server
eventEvent header for SUBSCRIBE.
acceptAccept header.
expiresExpires header for SUBSCRIBE.
asubscribepointer will contains a prepared SUBSCRIBE request.
int am_subscription_start_with_initial_subscribe ( osip_message_t *  subscribe)

Configure amsip to start a SIP subscription from a built subscribe message.

Parameters
subscribepointer containing prepared SUBSCRIBE request.
int am_subscription_refresh ( int  did,
const char *  event,
const char *  accept,
int  expires 
)

Build and send a SUBSCRIBE to refresh a subscription.

Parameters
didSession identifier.
eventEvent header for SUBSCRIBE.
acceptAccept header.
expiresexpires time (0 to stop subscription).
int am_subscription_build_refresh ( int  did,
const char *  event,
const char *  accept,
int  expires,
osip_message_t **  subscribe 
)

Build a SUBSCRIBE to refresh a subscription.

Parameters
didSession identifier.
eventEvent header for SUBSCRIBE.
acceptAccept header.
expiresexpires time (0 to stop subscription).
subscribepointer will contains a prepared SUBSCRIBE request.
int am_subscription_send_refresh ( int  did,
osip_message_t *  subscribe 
)

Send a SUBSCRIBE to refresh a subscription.

Parameters
dididentifier of the subscription.
subscribeSUBSCRIBE request to be sent.
int am_subscription_remove ( int  did)

Remove outgoing subscription context.

Parameters
dididentifier of the subscription.