---

ahm_lib.h

Go to the documentation of this file.

/***************************************************************************
BSD License
 
Copyright (c) 2002, Intel Corporation
All rights reserved.
 
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
 
  a.. Redistributions of source code must retain the above copyright notice,
      this list of conditions and the following disclaimer.
  b.. 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.
  c.. Neither the name of Intel Corporation nor the names of its contributors
      may be used to endorse or promote products derived from this software
      without specific prior written permission.
 
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, 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.
 
****************************************************************************/

#ifndef __AHM_LIB_H__
#define __AHM_LIB_H__

#define REGISTRATION_DIRECTORY "/var/appmonitord"

#include "appHeartbeatMonitor.h"

extern int ahm_fifo_fd;

extern int errno;

struct internal_reg_info
{
   /** The process identifier for the registering application */
   pid_t         pid;

   /** The identifer used for this thread, which is unique among this
       application's threads */
   unsigned long id;  
  
   /** This is the process name as it should appear in /proc. It 
       should not contain any path, simply the executable name */ 
   char          process_name[STRING_LENGTH]; 

   /** The absolute path to the recovery script to be launched if/when
       the application misses a heartbeat */
   char          recovery_script[STRING_LENGTH]; 

   /** This is the registration file name */
   char          registration_file[STRING_LENGTH];
   
   /** the maximum amount of time to lapse between heartbeats.
       This is how frequently the daemon will expect the 
       heartbeats.*/   
   unsigned long max_interval; 
   
   /** the minimum amount of time to lapse between heartbeats. 
       This is the value used by the application to send 
       heartbeats.  An min,max interval is used to minimize
       false heartbeat failures */
   unsigned long min_interval; 

   /** The absolute path of the heartbeat fifo */
   char         hb_fifo[STRING_LENGTH];

   /** The file descriptor of the open heartbeat fifo */
   int          hb_fifo_fd;

   /** This is used to indicate when registration has failed.
       This value should be at least equal to the heartbeat service's
       registration interval. An application will initialize and
       then register, yet the heartbeat service may take up to X seconds
       to process the registration (as defined as startup of the
       service). This allows the client to wait a reasonable
       amount of time before considering registration as a failure.
       NOTE: at this time, this value is set using REGISTRAION_TIMEOUT. 
       It will be determined later if we need to have this be
       set dynamically. */
   unsigned long registration_timeout;

};

/** private functions */

int ok_to_send_heartbeat(int a_fd) ;
int create_heartbeat_fifo(struct internal_reg_info **a_reginfo);
int create_registration_file(struct internal_reg_info **a_reginfo);


#endif /* __AHM_LIB_H__ */

---