.TH "eXosip2_subscribe" 3 "Thu Dec 15 2016" "Version 4.1.0" "libeXosip2" \" -*- nroff -*-
.ad l
.nh
.SH NAME
eXosip2_subscribe \- eXosip2 SUBSCRIBE and outgoing subscriptions
.SS "Enumerations"

.in +1c
.ti -1c
.RI "enum \fBeXosip_ss\fP { \fBEXOSIP_SUBCRSTATE_UNKNOWN\fP, \fBEXOSIP_SUBCRSTATE_PENDING\fP, \fBEXOSIP_SUBCRSTATE_ACTIVE\fP, \fBEXOSIP_SUBCRSTATE_TERMINATED\fP }"
.br
.ti -1c
.RI "enum \fBeXosip_ss_reason\fP { \fBDEACTIVATED\fP, \fBPROBATION\fP, \fBREJECTED\fP, \fBTIMEOUT\fP, \fBGIVEUP\fP, \fBNORESOURCE\fP }"
.br
.ti -1c
.RI "enum \fBeXosip_ss_status\fP { \fBEXOSIP_NOTIFY_UNKNOWN\fP, \fBEXOSIP_NOTIFY_PENDING\fP, \fBEXOSIP_NOTIFY_ONLINE\fP, \fBEXOSIP_NOTIFY_BUSY\fP, \fBEXOSIP_NOTIFY_BERIGHTBACK\fP, \fBEXOSIP_NOTIFY_AWAY\fP, \fBEXOSIP_NOTIFY_ONTHEPHONE\fP, \fBEXOSIP_NOTIFY_OUTTOLUNCH\fP, \fBEXOSIP_NOTIFY_CLOSED\fP }"
.br
.in -1c
.SS "Functions"

.in +1c
.ti -1c
.RI "int \fBeXosip_subscribe_build_initial_request\fP (struct eXosip_t *excontext, osip_message_t **subscribe, const char *to, const char *from, const char *route, const char *event, int expires)"
.br
.ti -1c
.RI "int \fBeXosip_subscribe_send_initial_request\fP (struct eXosip_t *excontext, osip_message_t *subscribe)"
.br
.ti -1c
.RI "int \fBeXosip_subscribe_build_refresh_request\fP (struct eXosip_t *excontext, int did, osip_message_t **sub)"
.br
.ti -1c
.RI "int \fBeXosip_subscribe_send_refresh_request\fP (struct eXosip_t *excontext, int did, osip_message_t *sub)"
.br
.ti -1c
.RI "int \fBeXosip_subscribe_remove\fP (struct eXosip_t *excontext, int did)"
.br
.in -1c
.SH "Detailed Description"
.PP 

.SH "Enumeration Type Documentation"
.PP 
.SS "enum \fBeXosip_ss\fP"
Structure for subscription status 
.PP
\fBEnumerator\fP
.in +1c
.TP
\fB\fIEXOSIP_SUBCRSTATE_UNKNOWN \fP\fP
unknown subscription-state 
.TP
\fB\fIEXOSIP_SUBCRSTATE_PENDING \fP\fP
pending subscription-state 
.TP
\fB\fIEXOSIP_SUBCRSTATE_ACTIVE \fP\fP
active subscription-state 
.TP
\fB\fIEXOSIP_SUBCRSTATE_TERMINATED \fP\fP
terminated subscription-state 
.SS "enum \fBeXosip_ss_reason\fP"
Structure for subscription reason 
.PP
\fBEnumerator\fP
.in +1c
.TP
\fB\fIDEACTIVATED \fP\fP
deactivated for subscription-state 
.TP
\fB\fIPROBATION \fP\fP
probation for subscription-state 
.TP
\fB\fIREJECTED \fP\fP
rejected for subscription-state 
.TP
\fB\fITIMEOUT \fP\fP
timeout for subscription-state 
.TP
\fB\fIGIVEUP \fP\fP
giveup for subscription-state 
.TP
\fB\fINORESOURCE \fP\fP
noresource for subscription-state 
.SS "enum \fBeXosip_ss_status\fP"
Structure for notification status 
.PP
\fBEnumerator\fP
.in +1c
.TP
\fB\fIEXOSIP_NOTIFY_UNKNOWN \fP\fP
unknown state for subscription 
.TP
\fB\fIEXOSIP_NOTIFY_PENDING \fP\fP
subscription not yet accepted 
.TP
\fB\fIEXOSIP_NOTIFY_ONLINE \fP\fP
online status 
.TP
\fB\fIEXOSIP_NOTIFY_BUSY \fP\fP
busy status 
.TP
\fB\fIEXOSIP_NOTIFY_BERIGHTBACK \fP\fP
be right back status 
.TP
\fB\fIEXOSIP_NOTIFY_AWAY \fP\fP
away status 
.TP
\fB\fIEXOSIP_NOTIFY_ONTHEPHONE \fP\fP
on the phone status 
.TP
\fB\fIEXOSIP_NOTIFY_OUTTOLUNCH \fP\fP
out to lunch status 
.TP
\fB\fIEXOSIP_NOTIFY_CLOSED \fP\fP
closed status 
.SH "Function Documentation"
.PP 
.SS "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\&.
.PP
\fBParameters:\fP
.RS 4
\fIexcontext\fP eXosip_t instance\&. 
.br
\fIsubscribe\fP Pointer for the SIP request to build\&. 
.br
\fIto\fP SIP url for callee\&. 
.br
\fIfrom\fP SIP url for caller\&. 
.br
\fIroute\fP Route header for SUBSCRIBE\&. (optional) 
.br
\fIevent\fP Event header for SUBSCRIBE\&. 
.br
\fIexpires\fP Expires header for SUBSCRIBE\&. 
.RE
.PP

.SS "int eXosip_subscribe_send_initial_request (struct eXosip_t * excontext, osip_message_t * subscribe)"
Send an initial SUBSCRIBE request\&.
.PP
\fBParameters:\fP
.RS 4
\fIexcontext\fP eXosip_t instance\&. 
.br
\fIsubscribe\fP SIP SUBSCRIBE message to send\&. 
.RE
.PP

.SS "int eXosip_subscribe_build_refresh_request (struct eXosip_t * excontext, int did, osip_message_t ** sub)"
Build a default new SUBSCRIBE message\&.
.PP
\fBParameters:\fP
.RS 4
\fIexcontext\fP eXosip_t instance\&. 
.br
\fIdid\fP identifier of the subscription\&. 
.br
\fIsub\fP Pointer for the SIP request to build\&. 
.RE
.PP

.SS "int eXosip_subscribe_send_refresh_request (struct eXosip_t * excontext, int did, osip_message_t * sub)"
Send a new SUBSCRIBE request\&.
.PP
\fBParameters:\fP
.RS 4
\fIexcontext\fP eXosip_t instance\&. 
.br
\fIdid\fP identifier of the subscription\&. 
.br
\fIsub\fP SIP SUBSCRIBE message to send\&. 
.RE
.PP

.SS "int eXosip_subscribe_remove (struct eXosip_t * excontext, int did)"
Remove outgoing subscription context\&.
.PP
\fBParameters:\fP
.RS 4
\fIexcontext\fP eXosip_t instance\&. 
.br
\fIdid\fP identifier of the subscription\&. 
.RE
.PP

.SH "Author"
.PP 
Generated automatically by Doxygen for libeXosip2 from the source code\&.