====================================================================
VOCAL Release 1.2.0 Heartbeat Server README
====================================================================
Module:       Heartbeat Server
Release:      1.2.0 (aka. Asiago)
Release Date: February 22, 2001

====================================================================
LICENSE AND COPYRIGHT
====================================================================
For information about licensing, please see the LICENSE file in
this directory, or http://www.vovida.org/license.html .

--------------------------------------------------------------------
This software consists of voluntary contributions made by Vovida
Networks, Inc. and many individuals on behalf of Vovida Networks,
Inc.  For more information on Vovida Networks, Inc., please see
http://www.vovida.org/.

All third party licenses and copyright notices and other required
legends also need to be complied with as well.

====================================================================
INTRODUCTION
====================================================================

The Heartbeat servers detects all heartbeats from any servers in VOCAL which
heartbeating to the multicast address, and report statuses to the Network 
Manager (if there is one running in the system).

====================================================================
NEW FEATURES IN THIS RELEASE
====================================================================

====================================================================
BUG FIXES
====================================================================

====================================================================
KNOWN LIMITATIONS
====================================================================

====================================================================
GETTING STARTED
====================================================================
--------------------------------------------------------------------
HARDWARE OR SOFTWARE REQUIREMENTS
--------------------------------------------------------------------
The recommended hardware is as follows:
700MHz, Intel Pentium III PC processor, 512MB RAM

In addition to the source code in this directory, the Heartbeat Server
requires the following software packages within the VOCAL tree:
    UTIL HEARTBEAT PSLIB PSUTILIB PTHREAD LIBXML

--------------------------------------------------------------------
INSTALLATION INSTRUCTIONS
--------------------------------------------------------------------
See "BUILD OR COMPILE INSTRUCTIONS"

--------------------------------------------------------------------
BUILD OR COMPILE INSTRUCTIONS
--------------------------------------------------------------------
The Heartbeat Server executable can be built in one of two ways:
a) cd ../vocal/heartbeat/hbs
   make

b) cd ../vocal
   make hbs

In either scenario, the executable 'ms' is as:
../vocal/heartbeat/hbs/bin.<hardwareArchitecture>/hbs

--------------------------------------------------------------------
USING THE SOFTWARE
--------------------------------------------------------------------
Usage: hbs [OPTIONS]...[PSERVER HOST:PORT]
                      [BACKUP PSERVER HOST:PORT]
                      [SIPPORT]
Options: -d  Do not run in daemon mode
         -f <log file>  Log to this filename
         -r  Retransmission on
         -v LOG_LEVEL
            LOG_EMERG
            LOG_ALERT
            LOG_CRIT
            LOG_ERR
            LOG_WARNING
            LOG_NOTICE
            LOG_INFO
            LOG_DEBUG
            LOG_DEBUG_STACK
            LOG_DEBUG_OPER
            LOG_DEBUG_HB

To execute the Heartbeat Server, you need to supply a host address
and port for the provisioning server, a host address and port for
the redundant/backup provisioning server, and a port number for
the Heartbeat Server's SIP stack to use.
If redundant provisioning servers are not used, the main
provisioning server host and port can be specified as the
redundant provisioning server.

Example: hbs -rd -v LOG_INFO -f hbs.log ps1:6005 ps2:6005 5070

====================================================================
SOURCE CODE INFORMATION
====================================================================
See "DIRECTORY STRUCTURE"

====================================================================
DIRECTORY STRUCTURE
====================================================================
The source code is in ./vocal/heartbeat/hbs


====================================================================
CONTACT INFORMATION AND WEBSITE
====================================================================
We welcome your feedback, suggestions and contributions.
Contact us via email if you have questions, feedback,
code submissions, and bug reports.

For general inquiries - info@vovida.org

We have mailing lists for the VOCAL applications and
proctocol stacks:
VOCAL - vocal@vovida.org
COPS - cops@vovida.org
MGCP - mgcp@vovida.org
RADIUS - radius@vovida.org
RTP - rtp@vovida.org
SIP - sip@vovida.org
TRIP - trip@vovida.org
You can subscribe to the mailing lists on www.vovida.org.

You can submit bug, patches, software contributions, and feature
requests using Bugzilla.  Access Bugzilla from www.vovida.org.

====================================================================





======================================================================

Copyright 2000-2003, Cisco Systems, Inc.
THE INFORMATION HEREIN IS PROVIDED ON AN "AS IS" BASIS, WITHOUT ANY
WARRANTIES OR REPRESENTATIONS, EXPRESS, IMPLIED OR STATUTORY, INCLUDING
WITHOUT LIMITATION, WARRANTIES OF NONINFRINGEMENT, MERCHANTABILITY OR
FITNESS FOR A PARTICULAR PURPOSE.

$Id: README,v 1.3.2.1 2003/03/28 05:25:48 bko Exp $
