agt_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.
 */
#ifdef WITH_YCONTROL
#ifndef _H_agt_ycontrol
#define _H_agt_ycontrol
 
/*  FILE: agt_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
----------------------------------------------------------------------
10-apr-14    abb      Begun
 
*/
 
#ifndef _H_agt_rpc
#include "agt_rpc.h"
#endif
 
#ifndef _H_ses
#include "ses.h"
#endif
 
#ifndef _H_status
#include "status.h"
#endif
 
#ifndef _H_xml_util
#include "xml_util.h"
#endif
 
#ifndef _H_xmlns
#include "xmlns.h"
#endif
 
#ifndef _H_ycontrol_types
#include "ycontrol_types.h"
#endif
 
#ifdef __cplusplus
extern "C" {
#endif
 
 
#define AGT_YCONTROL_MAX_SERVICES   4
 
 
/********************************************************************
*                                                                   *
*                         T Y P E S                                 *
*                                                                   *
*********************************************************************/
 
 
typedef status_t
    (*agt_ycontrol_service_fn_t) (ses_cb_t *scb,
                                  ycontrol_msgtype_t msgtype,
                                  uint32 msgid,
                                  const xmlChar *subsys_id,
                                  ycontrol_msgbody_t msgbody_type,
                                  val_value_t *msgbody,
                                  boolean *scb_valid);
 
 
typedef void
    (*agt_ycontrol_subsys_gone_fn_t) (const xmlChar *subsys_id);
 
 
typedef struct agt_ycontrol_cb_t_ {
    dlq_hdr_t   qhdr;
 
    xmlChar    *service_name;
 
    agt_ycontrol_service_fn_t  service_fn;
 
    agt_ycontrol_subsys_gone_fn_t  subsys_gone_fn;
} agt_ycontrol_cb_t;
 
 
typedef struct agt_ycontrol_subsys_t_ {
    dlq_hdr_t   qhdr;
 
    xmlChar    *subsys_id;
 
    xmlChar    *service_id[AGT_YCONTROL_MAX_SERVICES];
 
    ses_id_t   subsys_sid;
 
    ses_id_t   dropped_sid;
 
    boolean    session_dropped;
} agt_ycontrol_subsys_t;
 
 
/********************************************************************
*                                                                   *
*                       F U N C T I O N S                           *
*                                                                   *
*********************************************************************/
 
 
extern status_t
    agt_ycontrol_init1 (void);
 
 
extern status_t
    agt_ycontrol_init2 (void);
 
 
extern void
    agt_ycontrol_cleanup (void);
 
 
extern boolean
    agt_ycontrol_dispatch (ses_cb_t *scb,
                           xml_node_t *top);
 
 
extern status_t
    agt_ycontrol_send_payload (ses_cb_t *scb,
                               const xmlChar *service_id,
                               uint32 *msgid,
                               ycontrol_msgtype_t msgtype,
                               val_value_t *service_payload,
                               boolean with_ywattrs);
 
 
 
extern status_t
    agt_ycontrol_send_callback (ses_cb_t *scb,
                                const xmlChar *service_id,
                                uint32 *msgid,
                                ycontrol_msgtype_t msgtype,
                                boolean with_ywattrs,
                                obj_template_t *service_obj,
                                agt_rpc_data_cb_t data_cbfn,
                                rpc_msg_t *rpcmsg,
                                boolean need_filesave);
 
 
extern status_t
    agt_ycontrol_send_error (ses_cb_t *scb,
                             const xmlChar *service_id,
                             uint32 msgid,
                             status_t res,
                             const xmlChar *errstr);
 
 
extern status_t
    agt_ycontrol_send_ok (ses_cb_t *scb,
                          const xmlChar *service_id,
                          uint32 msgid);
 
 
extern status_t
    agt_ycontrol_send_event (const xmlChar *service_id,
                             val_value_t *service_payload,
                             boolean with_ywattrs);
 
 
 
extern status_t
    agt_ycontrol_send_event_subsys (const xmlChar *service_id,
                                    val_value_t *service_payload,
                                    boolean with_ywattrs,
                                    const xmlChar *subsys_id);
 
 
 
extern status_t
    agt_ycontrol_register_service (const xmlChar *service_name,
                                   agt_ycontrol_service_fn_t service_fn);
 
 
extern status_t
    agt_ycontrol_register_service_ex (const xmlChar *service_name,
                      agt_ycontrol_service_fn_t service_fn,
                      agt_ycontrol_subsys_gone_fn_t subsys_gone_fn);
 
 
extern void
    agt_ycontrol_unregister_service (const xmlChar *service_name);
 
 
extern status_t
    agt_ycontrol_add_subsys (ses_id_t subsys_sid,
                             const xmlChar *subsys_id);
 
 
extern void
    agt_ycontrol_remove_subsys (ses_id_t sid,
                                const xmlChar *subsys_id);
 
 
extern obj_template_t *
    agt_ycontrol_get_obj (void);
 
 
extern ses_cb_t *
    agt_ycontrol_get_scb (const xmlChar *subsys_id);
 
 
extern void
    agt_ycontrol_drop_session (ses_id_t sid);
 
 
extern boolean
    agt_ycontrol_any_subsys_active (void);
 
 
extern status_t
    agt_ycontrol_send_shutdown_event (void);
 
 
extern status_t
    agt_ycontrol_send_shutdown_event_byservice (const xmlChar *service_id);
 
 
extern boolean
    agt_ycontrol_init_was_done (void);
 
 
extern const xmlChar *
    agt_ycontrol_get_subsys_id (ses_id_t sid);
 
 
#ifdef __cplusplus
}  /* end extern 'C' */
#endif
 
#endif      /* _H_agt_ycontrol */
#endif  // WITH_YCONTROL