osip(1) [suse man page]

libosip(1)						      General Commands Manual							libosip(1)

NAME

       libosip2 -- The GNU oSIP library is a low layer SIP implementation.

SYNOPSIS

       #include <include/osipparser2/osip_const.h>

       #include <include/osipparser2/osip_md5.h>

       #include <include/osipparser2/osip_list.h>

       #include <include/osipparser2/osip_uri.h>

       #include <include/osipparser2/osip_message.h>

       #include <include/osipparser2/osip_port.h>

       #include <include/osipparser2/sdp_message.h>

       #include <include/osipparser2/osip_headers.h>

       #include <include/osipparser2/osip_body.h>

       #include <include/osipparser2/osip_rfc3264.h>

       #include <include/osipparser2/osip_parser.h>

       -losipparser2 [The uri, SIP and SDP parsers]

       #include <include/osip2/osip.h>

       #include <include/osip2/osip_fifo.h>

       #include <include/osip2/osip_dialog.h>

       #include <include/osip2/osip_mt.h>

       #include <include/osip2/osip_condv.h>

       #include <include/osip2/osip_negotiation.h>  //OBSOLETE

       -losip2 [The SIP transaction and the dialog API]

DESCRIPTION

       This manual page documents briefly the libosip2 library.

API and Reference Documentation
       API reference & Doxygen documentation is available for osip at http://www.gnu.org/software/osip/

osip general overview.
       The file help/man/osip.html in the source distribution should give you a nice amount of information about the osip stack.

Free software projects -send me your project name-
       antisip, linphone, bayonne

BUGS

       Please use the mailing list osip@atosc.org

AUTHOR

       This manual page was written by Aymeric Moizard jack at atosc.org.

																	libosip(1)

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)