agt_action.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.
 */
#ifndef _H_agt_action
#define _H_agt_action
 
/*  FILE: agt_action.h
*********************************************************************
*                                   *
*            P U R P O S E                  *
*                                   *
*********************************************************************/
 
/*********************************************************************
*                                   *
*          C H A N G E   H I S T O R Y              *
*                                   *
*********************************************************************
 
date         init     comment
----------------------------------------------------------------------
03-jan-16    abb      Begun
 
*/
 
#ifndef _H_agt_rpc
#include "agt_rpc.h"
#endif
 
#ifndef _H_rpc
#include "rpc.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_xml_util
#include "xml_util.h"
#endif
 
#ifdef __cplusplus
extern "C" {
#endif
 
 
/********************************************************************
*                                                                   *
*                         T Y P E S                                 *
*                                                                   *
*********************************************************************/
 
 
typedef status_t
    (*agt_action_cb_t) (ses_cb_t *scb,
                        rpc_msg_t *msg,
                        xml_node_t *methnode,
                        val_value_t *actionval);
 
 
typedef struct agt_action_cbset_t_ {
    agt_action_cb_t  acb[AGT_RPC_NUM_CALLBACK_PHASES];
 
    boolean regdone;
 
#ifdef WITH_YCONTROL
    dlq_hdr_t subsysQ;
#endif
 
} agt_action_cbset_t;
 
 
/********************************************************************
*                                   *
*           F U N C T I O N S               *
*                                   *
*********************************************************************/
 
 
extern status_t
    agt_action_init (void);
 
 
extern void
    agt_action_cleanup (void);
 
 
extern status_t
    agt_action_register_action (const xmlChar *defpath,
                                agt_rpc_phase_t  phase,
                                agt_action_cb_t action_cb);
 
 
extern void
    agt_action_unregister_action (const xmlChar *defpath);
 
 
extern boolean
    agt_action_is_action (obj_template_t *rpcobj);
 
 
extern status_t
    agt_action_parse_input (ses_cb_t *scb,
                            rpc_msg_t *msg,
                            xml_node_t *method,
                            obj_template_t *rpcobj,
                            val_value_t **action_val);
 
extern boolean
    agt_action_callback_set (obj_template_t *obj);
 
 
extern void agt_action_callback_regdone (obj_template_t *obj);
 
 
extern boolean
    agt_action_callback_is_regdone (obj_template_t *obj);
 
 
#ifdef WITH_YCONTROL
extern status_t
    agt_action_register_subsys_callback (const xmlChar *subsys_id,
                                         const xmlChar *modname,
                                         const xmlChar *revision,
                                         const xmlChar *defpath);
 
 
extern void
    agt_action_unregister_subsys_callback (const xmlChar *subsys_id,
                                           const xmlChar *modname,
                                           const xmlChar *revision,
                                           const xmlChar *defpath);
 
#endif  // WITH_YCONTROL
 
 
extern val_value_t *
    agt_action_find_node (val_value_t *val);
 
 
extern void
    agt_action_unload_module (ncx_module_t *mod);
 
 
#ifdef __cplusplus
}  /* end extern 'C' */
#endif
 
#endif      /* _H_agt_action */