userapps/opensource/libosip2/README

   1 Project    : "The GNU oSIP library" is an implementation of SIP - rfc3261.
   2 Last update: 2.0.9
   3 Email      : jack@atosc.org
   4 License    : LGPL (http://www.gnu.org)
   5 Home Page  : http://www.fsf.org/software/osip/osip.html
   6 Download   : ftp://ftp.gnu.org/gnu/osip
   7
   8 "The GNU oSIP library" is part of the "GNU project".
   9 You  can  check www.fsf.org for more information about
  10 being part of the "GNU project".
  11
  12 This is "the GNU oSIP library". It has been designed
  13 to provide the Internet Community a  simple  way  to
  14 support the  Session  Initiation  Protocol.  SIP  is
  15 described in  the  RFC3261  which  is  available  at
  16 http://www.ietf.org/rfc/rfc3261.txt.
  17
  18
  19 FEATURES: (version 2.0.9)
  20 ---------
  21
  22 The oSIP library consists of 2 parts:
  23
  24 PARSER:
  25   *  SIP URL parser.
  26   *  SIP message parser. (and accessor API)
  27   *  SDP message parser. (and accessor API)
  28   *  MIME support for message with multiple attachments.
  29
  30 TRANSACTION LAYER:
  31   *  2 states machines for "client transaction" (INVITE and other).
  32   *  2 states machines for "server transaction"
  33   *  user controls the application with events.
  34   *  events managed by the oSIP stack are announced through callbacks.
  35   *  A SDP framework for quick negotiation. (for UAC/UAS only)
  36   *  dialog handling facility. (for UAC/UAS only)
  37   *  timers management framework.
  38
  39 EXTRA:
  40   *  Porting osip is easy. You probably only have to modify
  41         ./src/osipparser2/osip_port.c
  42         ./src/osip2/port_fifo.c
  43         ./src/osip2/port_sema.c
  44         ./src/osip2/port_thread.c
  45         ./include/osipparser2/osip_port.h
  46      Please redistribute your ports to jack@atosc.org.
  47
  48   *  oSIP is not tight to any design! You can use the library
  49      either in a multi-threaded environment or not, use your
  50      own interruption's mechanism for timer, or use your own
  51      transport protocol.
  52
  53 Documentation:
  54 --------------
  55
  56 Yet available:
  57   *  The help directory contains some help for specific platforms.
  58   *  Documentation link at http://www.gnu.org/software/osip/
  59
  60 Installation procedure:
  61 -----------------------
  62
  63 The library is known to compile on various platform:
  64   *  GNU/Linux
  65   *  OpenBsd 3.1/3.2  // (FreeBSD&NetBSD should also work)
  66   *  Windows NT/95/2000 (VC++6.0 or cygwin)
  67   *  Solaris
  68   *  HP-Unix.
  69   *  VxWorks.
  70   *  Some embedded systems with linux.
  71
  72 For more informations about compilation, please look in
  73 the ./help directory.
  74
  75 Tests programs:
  76 ---------------
  77
  78 The library contains some built-in test for the parser. To quickly test
  79 the parser, type: (Note that some tests MUST fail!)
  80
  81   $> make check
  82
  83 Watch out the ./src/test/README file for more informations.
  84
  85 Contact information:
  86 --------------------
  87
  88 For more information on the SIP stack, or any contributions,
  89 you can contact the author at <jack@atosc.org>.
  90
  91 A Mailing list is available for support: <osip@atosc.org>.
  92 You can subscribe by writing to: <osip-request@atosc.org>
  93 with a subject set to "subscribe".
  94
  95 Latest version is available at:
  96 ftp://ftp.gnu.org/gnu/osip
  97
  98 Home page is located at:
  99 http://www.fsf.org/software/osip/osip.html
 100