ycontrol.h

Go to the documentation of this file.

/*
 * Copyright (c) 2008 - 2012, Andy Bierman, All Rights Reserved.
 * Copyright (c) 2012 - 2025, 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.
 */
#ifndef _H_ycontrol
#define _H_ycontrol
 
/*  FILE: ycontrol.h
*********************************************************************
*                                                                   *
*                        P U R P O S E                              *
*                                                                   *
*********************************************************************/
 
/*********************************************************************
*                                                                   *
*                  C H A N G E   H I S T O R Y                      *
*                                                                   *
*********************************************************************
 
date         init     comment
----------------------------------------------------------------------
15-mar-14    abb      Begun
*/
 
#include <time.h>
#include <sys/time.h>
 
// TBD: remove dependency on xmlstring.h for xmlChar */
#include <xmlstring.h>
 
#ifndef _H_ncxtypes
#include "ncxtypes.h"
#endif
 
#ifndef _H_obj
#include "obj.h"
#endif
 
#ifndef _H_ses
#include "ses.h"
#endif
 
#ifndef _H_status_enum
#include "status_enum.h"
#endif
 
#ifndef _H_val
#include "val.h"
#endif
 
#ifndef _H_tstamp
#include "tstamp.h"
#endif
 
#ifndef _H_ycontrol_types
#include "ycontrol_types.h"
#endif
 
#ifdef __cplusplus
extern "C" {
#endif
 
 
 
 
/********************************************************************
*                                                                   *
*                        C O N S T A N T S                          *
*                                                                   *
*********************************************************************/
 
 
#define YCONTROL_DEF_RETRY_INTERVAL   5000  
 
#define YCONTROL_DEF_MAX_RETRIES      5000
 
#define SHUTDOWN_STATE(ST) \
    ((ST) == YCONTROL_ST_SHUTDOWN_REQ ||        \
     (ST) == YCONTROL_ST_DISCONNECTING ||       \
     (ST) == YCONTROL_ST_SHUTDOWN)
 
#define YCONTROL_MAX_SERVICES        2
 
#define YCONTROL_MOD (const xmlChar *)"yumaworks-ycontrol"
 
#define YCONTROL_OBJ (const xmlChar *)"ycontrol"
 
 
/********************************************************************
*                                                                   *
*                            T Y P E S                              *
*                                                                   *
*********************************************************************/
 
 
typedef status_t
    (*ycontrol_service_start_t) (void);
 
 
typedef status_t
    (*ycontrol_service_stop_t) (ses_cb_t *scb);
 
 
 
 
typedef status_t
    (*ycontrol_service_msg_rcvr_t)
    (ses_cb_t *scb,
     ycontrol_msgtype_t msgtype,
     uint32 msgid,
     const xmlChar *server_id,
     ycontrol_msgbody_t msgbody_type,
     val_value_t *msgbody,
     boolean *response_sent);
 
 
typedef void
    (*ycontrol_service_shutdown_t) (void);
 
 
 
 
typedef void
    (*ycontrol_timer_handler_t) (void);
 
 
 
typedef void
    (*ycontrol_service_reconnect_t) (void);
 
 
typedef enum ycontrol_state_t_ {
    YCONTROL_ST_NONE,
 
    YCONTROL_ST_INIT,
 
    YCONTROL_ST_CONNECT,
 
    YCONTROL_ST_CONNECTING,
 
    YCONTROL_ST_WAIT_CONNECT_RETRY,
 
    YCONTROL_ST_CONNECTED,
 
    YCONTROL_ST_SHUTDOWN_REQ,
 
    YCONTROL_ST_DISCONNECTING,
 
    YCONTROL_ST_SHUTDOWN,
 
    YCONTROL_ST_SHUTDOWN_DONE
} ycontrol_state_t;
 
 
typedef struct ycontrol_service_t_ {
    xmlChar *service_name;
 
    ycontrol_service_start_t service_start;
 
    ycontrol_service_stop_t service_stop;
 
    ycontrol_service_msg_rcvr_t service_msg_rcvr;
 
    ycontrol_service_shutdown_t service_shutdown;
 
    ycontrol_service_reconnect_t service_reconnect;
 
} ycontrol_service_t;
 
 
typedef struct ycontrol_profile_t_ {
 
    xmlChar *subsys_id;
 
    xmlChar *server_id;
 
    char *server_root;
 
    ycontrol_state_t ycontrol_state;
 
    status_t ycontrol_res;
 
    int connect_retries;
 
    int connect_max_retries;
 
    int connect_retry_interval;
 
    boolean shutdown_requested;
 
    boolean is_standby;
 
    time_t boot_timestamp;
 
    struct timeval retry_timestamp;
 
    ses_cb_t *ycontrol_scb;
 
    fd_set active_fd_set;
 
    fd_set read_fd_set;
 
    fd_set write_fd_set;
 
    ncx_module_t *ycontrol_mod;
 
    obj_template_t *ycontrol_obj;
 
    val_value_t *ycontrol_msg;
 
    val_value_t *ycontrol_txid;
 
    val_value_t *ycontrol_payload;
 
    val_value_t *ycontrol_ok;
 
    val_value_t *ycontrol_error;
 
    uint32 next_msgid;
 
    ycontrol_timer_handler_t  timer_handler;
 
    ycontrol_service_t service[YCONTROL_MAX_SERVICES];
 
} ycontrol_profile_t;
 
 
 
/********************************************************************
*                                                                   *
*                       F U N C T I O N S                           *
*                                                                   *
*********************************************************************/
 
 
 
extern status_t
    ycontrol_init (int argc,
                   char *argv[],
                   const xmlChar *subsys_id);
 
 
extern status_t
    ycontrol_init_ex (int argc,
                      char *argv[],
                      const xmlChar *subsys_id,
                      boolean is_standby);
 
 
extern status_t
    ycontrol_init_ex2 (int argc,
                       char *argv[],
                       const xmlChar *subsys_id,
                       boolean is_standby,
                       boolean quiet_mode);
 
 
extern status_t
    ycontrol_init2 (void);
 
 
extern status_t
    ycontrol_init2_ha (const char *server_id,
                       const char *server_addr,
                       uint16 server_port);
 
#ifdef PTHREADS
extern void
    ycontrol_init2_ha_thd (thd_tcb_t *tcb);
#endif  // PTHREADS
 
 
extern void
    ycontrol_cleanup (void);
 
 
extern void
    ycontrol_cleanup_ex (boolean do_ncx_cleanup);
 
 
extern status_t
    ycontrol_check_io (void);
 
 
extern boolean
    ycontrol_is_ready (void);
 
 
extern void
    ycontrol_request_shutdown (void);
 
 
extern boolean
    ycontrol_shutdown_requested (void);
 
 
extern status_t
    ycontrol_register_service (const xmlChar *service_name,
                               ycontrol_service_start_t service_start,
                               ycontrol_service_stop_t service_stop,
                               ycontrol_service_msg_rcvr_t service_rcvr,
                               ycontrol_service_shutdown_t service_shut);
 
 
extern status_t
    ycontrol_register_service2 (const xmlChar *service_name,
                                ycontrol_service_start_t service_start,
                                ycontrol_service_stop_t service_stop,
                                ycontrol_service_msg_rcvr_t service_rcvr,
                                ycontrol_service_shutdown_t service_shut,
                                ycontrol_service_reconnect_t service_reconnect);
 
 
 
 
extern void
    ycontrol_unregister_service (const xmlChar *service_name);
 
 
extern void
    ycontrol_service_start (void);
 
 
extern void
    ycontrol_service_stop (void);
 
 
extern obj_template_t *
    ycontrol_get_service_object (const xmlChar *service_name);
 
 
extern status_t
    ycontrol_send (const xmlChar *service_id,
                   uint32 *msgid,
                   ycontrol_msgtype_t msgtype,
                   val_value_t *service_payload,
                   status_t msg_status);
 
 
extern status_t
    ycontrol_send_ex (const xmlChar *service_id,
                      uint32 *msgid,
                      ycontrol_msgtype_t msgtype,
                      val_value_t *service_payload,
                      status_t msg_status,
                      const xmlChar *txid_str);
 
 
extern status_t
    ycontrol_send_ex2 (const xmlChar *service_id,
                       uint32 *msgid,
                       ycontrol_msgtype_t msgtype,
                       val_value_t *service_payload,
                       status_t msg_status,
                       boolean with_origin,
                       const xmlChar *txid_str);
 
 
extern status_t
    ycontrol_send_error (const xmlChar *service_id,
                         uint32 *msgid,
                         status_t msg_status,
                         uint32 error_index,
                         const xmlChar *error_message,
                         const xmlChar *txid_str);
 
 
extern status_t
    ycontrol_send_ok (const xmlChar *service_id,
                      uint32 *msgid,
                      const xmlChar *txid_str);
 
 
extern boolean
    ycontrol_dispatch_msg (ses_cb_t  *scb);
 
 
extern void
    ycontrol_setup_reconnect (void);
 
 
extern boolean
    ycontrol_shutdown_now (void);
 
 
extern void
    ycontrol_set_timer_handler (ycontrol_timer_handler_t timer_handler);
 
 
extern void
    ycontrol_set_retry_interval (int retry_int);
 
 
extern const xmlChar *
    ycontrol_get_subsys_id (void);
 
 
 
extern void
    ycontrol_set_retry_limit (uint16 retry_limit);
 
 
extern status_t
    ycontrol_set_server_root (const char *server_root);
 
 
extern void
    ycontrol_service_reconnect (void);
 
 
#ifdef __cplusplus
}  /* end extern 'C' */
#endif
 
#endif      /* _H_ycontrol */