agt_acm_extern.h

Go to the documentation of this file.

/*
 * Copyright (c) 2008 - 2012, Andy Bierman, All Rights Reserved.
 * Copyright (c) 2012 - 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_acm_extern
#define _H_agt_acm_extern
 
/*  FILE: agt_acm_extern.h
*********************************************************************
*                                   *
*            P U R P O S E                  *
*                                   *
*********************************************************************/
 
/*********************************************************************
*                                   *
*          C H A N G E   H I S T O R Y              *
*                                   *
*********************************************************************
 
date         init     comment
----------------------------------------------------------------------
18-jun-12    abb      Begun; split from agt_acm.h
*/
 
#include <xmlstring.h>
 
 
#ifndef _H_obj
#include "obj.h"
#endif
 
#ifndef _H_op
#include "op.h"
#endif
 
#ifndef _H_status
#include "status.h"
#endif
 
#ifndef _H_val
#include "val.h"
#endif
 
#ifndef _H_xml_msg
#include "xml_msg.h"
#endif
 
 
#ifdef __cplusplus
extern "C" {
#endif
 
/********************************************************************
*                                   *
*            C O N S T A N T S              *
*                                   *
*********************************************************************/
 
 
/********************************************************************
*                                   *
*                T Y P E S                  *
*                                   *
*********************************************************************/
 
 
typedef boolean
    (*agt_acm_extern_rpc_fn_t) (xml_msg_hdr_t *msg,
                                const xmlChar *user,
                                const obj_template_t *rpcobj);
 
 
typedef boolean
    (*agt_acm_extern_notif_fn_t) (const xmlChar *user,
                                  const obj_template_t *notifobj);
 
 
typedef boolean
    (*agt_acm_extern_write_fn_t) (xml_msg_hdr_t *msg,
                                  const xmlChar *user,
                                  const val_value_t *newval,
                                  const val_value_t *curval,
                                  op_editop_t editop);
 
 
typedef boolean
    (*agt_acm_extern_read_fn_t) (xml_msg_hdr_t *msg,
                                 const xmlChar *user,
                                 const val_value_t *val);
 
 
/********************************************************************
*                                   *
*           F U N C T I O N S               *
*                                   *
*********************************************************************/
 
 
extern status_t
    agt_acm_extern_init2 (void);
 
 
extern void agt_acm_extern_init0 (void);
 
 
extern status_t
    agt_acm_extern_init1 (void);
 
 
extern void
    agt_acm_extern_cleanup (void);
 
 
extern status_t
    agt_acm_extern_init_msg_cache (ses_cb_t *scb,
                                   xml_msg_hdr_t *msg);
 
 
extern void agt_acm_extern_register_callbacks
    (agt_acm_extern_rpc_fn_t rpcfn,
     agt_acm_extern_notif_fn_t notfn,
     agt_acm_extern_write_fn_t writefn,
     agt_acm_extern_read_fn_t readfn);
 
 
extern boolean
    agt_acm_extern_rpc_allowed (xml_msg_hdr_t *msg,
                                const xmlChar *user,
                                const obj_template_t *rpcobj);
 
 
extern boolean
    agt_acm_extern_notif_allowed (const xmlChar *user,
                                  const obj_template_t *notifobj);
 
 
extern boolean
    agt_acm_extern_val_write_allowed (xml_msg_hdr_t *msg,
                                      const xmlChar *user,
                                      const val_value_t *newval,
                                      const val_value_t *curval,
                                      op_editop_t editop);
 
 
extern boolean
    agt_acm_extern_val_read_allowed (xml_msg_hdr_t *msg,
                                     const xmlChar *user,
                                     const val_value_t *val);
 
 
#ifdef __cplusplus
}  /* end extern 'C' */
#endif
 
#endif      /* _H_agt_acm_extern */