exosip2_notify(3) [debian man page]

eXosip2 SUBSCRIBE and incoming subscriptions(3) 		    libeXosip2			   eXosip2 SUBSCRIBE and incoming subscriptions(3)

NAME

       eXosip2 SUBSCRIBE and incoming subscriptions -

   Functions
       int eXosip_insubscription_build_answer (int tid, int status, osip_message_t **answer)
       int eXosip_insubscription_send_answer (int tid, int status, osip_message_t *answer)
       int eXosip_insubscription_build_request (int did, const char *method, osip_message_t **request)
       int eXosip_insubscription_build_notify (int did, int subscription_status, int subscription_reason, osip_message_t **request)
       int eXosip_insubscription_send_request (int did, osip_message_t *request)
       int eXosip_insubscription_remove (int did)

Detailed Description
Function Documentation
   int eXosip_insubscription_build_answer (inttid, intstatus, osip_message_t **answer)
       Build answer for an SUBSCRIBE request.

       Parameters:
	   tid id of SUBSCRIBE transaction.
	   status status for SIP answer to build.
	   answer The SIP answer to build.

   int eXosip_insubscription_send_answer (inttid, intstatus, osip_message_t *answer)
       Send answer for an SUBSCRIBE request.

       Parameters:
	   tid id of SUBSCRIBE transaction.
	   status status for SIP answer to send.
	   answer The SIP answer to send. (default will be sent if NULL)

   int eXosip_insubscription_build_request (intdid, const char *method, osip_message_t **request)
       Build a request within subscription.

       Parameters:
	   did id of incoming subscription.
	   method request method to build.
	   request The SIP request to build.

   int eXosip_insubscription_build_notify (intdid, intsubscription_status, intsubscription_reason, osip_message_t **request)
       Build a NOTIFY request within subscription.

       Parameters:
	   did id of incoming subscription.
	   subscription_status subscription status (pending, active, terminated)
	   subscription_reason subscription reason
	   request The SIP request to build.

   int eXosip_insubscription_send_request (intdid, osip_message_t *request)
       Send a request within subscription.

       Parameters:
	   did id of incoming subscription.
	   request The SIP request to send.

   int eXosip_insubscription_remove (intdid)
       Remove incoming 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 incoming subscriptions(3)

How-To initialize libeXosip2.(3)				    libeXosip2					  How-To initialize libeXosip2.(3)

NAME

       How-To initialize libeXosip2. - When using eXosip, your first task is to initialize both eXosip context and libosip library (parser and
       state machines). This must be done prior to any use of libeXosip2.

	       #include <eXosip2/eXosip.h>

	       int i;

	       TRACE_INITIALIZE (6, stdout);

	       i=eXosip_init();
	       if (i!=0)
		 return -1;

	       i = eXosip_listen_addr (IPPROTO_UDP, NULL, port, AF_INET, 0);
	       if (i!=0)
		 {
		   eXosip_quit();
		   fprintf (stderr, 'could not initialize transport layer
');
		   return -1;
		 }

	       ... then you have to send messages and wait for eXosip events...

       In the previous code, you've learned how to:

       o Initialize the osip trace (compile this code with -DENABLE_TRACE)
       o Initialize eXosip (and osip) stack
       o Open a socket for signalling (only UDP with initial eXosip2 version)
       Now you have to handle eXosip events. Here is some code to get eXosip_event from the eXosip2 stack.
	 eXosip_event_t *je;
	 for (;;)
	   {
	     je = eXosip_event_wait (0, 50);
	     eXosip_lock();
	     eXosip_automatic_action ();
	     eXosip_unlock();
	     if (je == NULL)
	       break;
	     if (je->type == EXOSIP_CALL_NEW)
	       {
	       ....
	       ....
	       }
	     else if (je->type == EXOSIP_CALL_ACK)
	       {
	       ....
	       ....
	       }
	     else if (je->type == EXOSIP_CALL_ANSWERED)
	       {
	       ....
	       ....
	       }
	     else .....
	     ....
	     ....
	     eXosip_event_free(je);
	   }
       You will receive one event for each SIP message sent. Each event contains the original request of the affected transaction and the last
       response that triggers the event when available.
       You can access all headers from those messages and store them in your own context for other actions or graphic displays.
       For example, when you receive a REFER request for a call transfer, you'll typically retreive the 'refer-To' header:
	 osip_header_t *referto_head = NULL;
	 i = osip_message_header_get_byname (evt->sip, 'refer-to', 0, &referto_head);
	 if (referto_head == NULL || referto_head->hvalue == NULL)
       The eXosip_event also contains identifiers for calls, registrations, incoming subscriptions or outgoing subscriptions when applicable.
       Those identifiers are used in API to control calls, registrations, incoming or outgoing subscriptions. These API will build default
       messages with usual SIP headers (From, To, Call-ID, CSeq, Route, Record-Route, Max-Forward...) and send thoses messages for you.
Author
       Generated automatically by Doxygen for libeXosip2 from the source code.

Version 3.1.0							  Sun Jun 24 2012				  How-To initialize libeXosip2.(3)