agt_yp_ha.h

Go to the documentation of this file.

/*
 * Copyright (c) 2016 - 2021, YumaWorks, Inc., All Rights Reserved.
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
#ifdef WITH_YP_HA
#ifndef _H_agt_yp_ha
#define _H_agt_yp_ha
 
/*  FILE: agt_yp_ha.h
*********************************************************************
*                                   *
*            P U R P O S E                  *
*                                   *
*********************************************************************/
 
/*********************************************************************
*                                   *
*          C H A N G E   H I S T O R Y              *
*                                   *
*********************************************************************
 
date         init     comment
----------------------------------------------------------------------
06-feb-16    abb      Begun
*/
 
#include <xmlstring.h>
 
#ifndef _H_agt
#include "agt.h"
#endif
 
#ifndef _H_agt_cfg
#include "agt_cfg.h"
#endif
 
#ifndef _H_status_enum
#include "status_enum.h"
#endif
 
#ifdef __cplusplus
extern "C" {
#endif
 
 
/* header only */
 
 
/********************************************************************
*                                   *
*            C O N S T A N T S              *
*                                   *
*********************************************************************/
 
 
/********************************************************************
*                                   *
*                T Y P E S                  *
*                                   *
*********************************************************************/
 
typedef enum yp_ha_state_t_ {
    HA_STATE_NONE,
 
    HA_STATE_DISABLED,
 
    HA_STATE_ERROR,
 
    HA_STATE_WAIT_ROLE,
 
    HA_STATE_BE_ACTIVE,
 
    HA_STATE_ACTIVE,
 
    HA_STATE_BE_STANDBY,
 
    HA_STATE_STANDBY,
 
    HA_STATE_SHUTTING_DOWN,
} yp_ha_state_t;
 
 
typedef struct yp_ha_server_t_ {
    dlq_hdr_t  qhdr;
 
    xmlChar *server_name;
 
    xmlChar *server_addr;
 
    uint16   server_port;
 
    struct yp_ha_subsys_t_ *subsys_cb;
 
} yp_ha_server_t;
 
 
typedef struct yp_ha_service_t_ {
    dlq_hdr_t ha_serverQ;
 
    yp_ha_server_t *my_server_cb;
 
    const xmlChar *ha_server_key;
 
    obj_template_t *yp_ha_obj;
 
    val_value_t *payload_val;
 
    yp_ha_state_t ha_state;
 
    boolean ha_enabled;
 
    boolean ha_init_done;
 
    struct yp_ha_active_t_ *active_cb;
 
    struct yp_ha_standby_t_ *standby_cb;
 
    xmlChar tstamp[TSTAMP_MIN_SIZE];
 
    uint64 config_updates;
 
    uint64 config_failures;
 
    xmlChar last_error_time[TSTAMP_MIN_SIZE];
 
    status_t last_error_num;
 
} yp_ha_service_t;
 
 
/********************************************************************
*                                   *
*           F U N C T I O N S               *
*                                   *
*********************************************************************/
 
extern void
    agt_yp_ha_preinit (void);
 
 
extern status_t
    agt_yp_ha_init (void);
 
 
extern status_t
    agt_yp_ha_init2 (void);
 
 
extern void
    agt_yp_ha_cleanup (void);
 
 
extern status_t
    agt_yp_ha_add_server_cli (const xmlChar *valstr);
 
 
extern boolean
    agt_yp_ha_mgmt_enabled (void);
 
 
extern status_t
    agt_yp_ha_be_active (void);
 
 
extern status_t
    agt_yp_ha_be_none (void);
 
 
extern status_t
    agt_yp_ha_be_standby (const xmlChar *new_server_id);
 
 
extern agt_ha_role_t
    agt_yp_ha_get_role (void);
 
 
extern const xmlChar *
    agt_yp_ha_get_role_state (const xmlChar **tstamp);
 
 
extern yp_ha_service_t *
    agt_yp_ha_get_service_cb (void);
 
 
extern void
    agt_yp_ha_check_standby_io (void);
 
 
extern yp_ha_server_t *
    agt_yp_ha_find_server (const xmlChar *server_name);
 
 
extern void
    agt_yp_ha_config_update (rpc_msg_t *msg,
                             agt_cfg_transaction_t *txcb);
 
 
extern status_t
    agt_yp_ha_nvstore (void);
 
 
extern boolean
    agt_yp_ha_sil_disabled (void);
 
 
 
extern void
    agt_yp_ha_mod_event (const xmlChar *name,
                         const xmlChar *revision,
                         val_value_t *inputval,
                         boolean is_module,
                         boolean is_load);
 
 
extern status_t
    agt_yp_ha_get_config_info (ncx_transaction_id_t *config_id,
                               const xmlChar **config_stamp);
 
 
 
extern status_t
    agt_yp_ha_get_error_info (const xmlChar **tstamp,
                              const xmlChar **msg);
 
 
extern const xmlChar *
    agt_yp_ha_get_active_server (void);
 
 
 
extern status_t
    agt_yp_ha_get_config_counters(uint64 *updates,
                                  uint64 *failures);
 
 
#ifdef __cplusplus
}  /* end extern 'C' */
#endif
 
#endif      /* _H_agt_yp_ha */
#endif   // WITH_YP_HA