src/nws_portability/README

   1 $Id$
   2
   3 Portability
   4 -----------
   5
   6 Portability is a library used by the Network Weather System (NWS). It
   7 aims to be portable and to mask sockets, threads and other low level,
   8 system dependent calls. It can be used independetly from the NWS, but
   9 documentation is quite scarse: the header files will be your best
  10 friends.
  11
  12 Compiling and installing
  13 ------------------------
  14
  15 To compile Portability run
  16         ./configure
  17         make all
  18 and you will find a library libNwsPortability.a and the needed file in
  19 the ./build-<your-architecture>/{lib,include}. You can install them with
  20         make install
  21
  22 You can configure where to install library and includes using --prefix
  23 etc ... (./configure --help for the options).
  24
  25 You can configure Portability to be used with threads (--enable-threads)
  26 and to disable sigalarm (--disable-sigalarm).
  27
  28
  29
  30 Adaptive Timeouts
  31 -----------------
  32
  33 Some of Portability's functions take a timeout as argument. Portability
  34 provides a way to use adaptive timeouts: look at timeouts.h for the
  35 interface. In short you can use GetTimeOut to get a timeout estimate that
  36 is more accurate the more information you give Portability through
  37 SetTimeOut. If you call the Send{MessageAnd}Data with a timeout of -1
  38 you'll get the adaptive timeouts without having to tinker with Get/Set
  39 TimeOut.
  40