hbagent.hxx

Vovida 社区开源的 SIP 协议源码

#ifndef HBAgent_HXX
#define HBAgent_HXX

/* ====================================================================
 * The Vovida Software License, Version 1.0 
 * 
 * Copyright (c) 2000 Vovida Networks, Inc.  All rights reserved.
 * 
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in
 *    the documentation and/or other materials provided with the
 *    distribution.
 * 
 * 3. The names "VOCAL", "Vovida Open Communication Application Library",
 *    and "Vovida Open Communication Application Library (VOCAL)" must
 *    not be used to endorse or promote products derived from this
 *    software without prior written permission. For written
 *    permission, please contact [e-mail].
 *
 * 4. Products derived from this software may not be called "VOCAL", nor
 *    may "VOCAL" appear in their name, without prior written
 *    permission of Vovida Networks, Inc.
 * 
 * THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESSED OR IMPLIED
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, TITLE AND
 * NON-INFRINGEMENT ARE DISCLAIMED.  IN NO EVENT SHALL VOVIDA
 * NETWORKS, INC. OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT DAMAGES
 * IN EXCESS OF $1,000, NOR FOR ANY INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
 * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
 * USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
 * DAMAGE.
 * 
 * ====================================================================
 * 
 * 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/>.
 *
 */

static const char* const HBAgent_hxx_Version =
    "$Id: HBAgent.hxx,v 1.7 2001/02/05 19:50:30 maivu Exp $";

#include "AgentApi.hxx"

/**
 * Class HBAgent
 *
 * Compiled into the Heartbeat Server to notify the Network Manager
 * about status of all  servers in system.  
 * The servers are RS, MS, FS, POS, CDR, JS.
 *
 */
class HBAgent: public AgentApi
{
    public:
        /**
	 * Return the one HBAgent or create it if it doesn't already exist.
	 * @return  Pointer to the singleton agent.
	 */
        static Sptr < HBAgent > instance();

        /// Destructor
        ~HBAgent();

       /**
	* Build Message to be sent to Network Manager
	* @param  sender  Address of the message sender
	* @return  The return status
	*/
        voReturnStatus buildMessage(NetworkAddress *sender);
        
        /// Set the log level for debugging
        void setLogLevel(string level);

    protected:

        /**
	 * Process the message passed in.
	 * @param  message  Message to be processed
	 * @param  sender  Address of the message sender
	 * @return  The return status
	 */
        virtual voReturnStatus processMessage(ipcMessage *message, NetworkAddress *sender);

        /// pointer to the singleton occurrence of this object
        static Sptr < HBAgent > theHBAgent;

        /**
	 * Constructor
	 * @param  application type
	 * @param  application name
	 */
        HBAgent();

    private:
        /// set the log level
        string logLevel;
}
;
#endif //HBAgent_HXX