sil_sa.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_sil_sa
#define _H_sil_sa
 
/*  FILE: sil_sa.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 <xmlstring.h>
 
#ifndef _H_agt_not
#include "agt_not.h"
#endif
 
#ifndef _H_rpc
#include "rpc.h"
#endif
 
#ifndef _H_val
#include "val.h"
#endif
 
#ifndef _H_sil_sa_types
#include "sil_sa_types.h"
#endif
 
#ifdef __cplusplus
extern "C" {
#endif
 
 
 
 
/********************************************************************
*                                                                   *
*                        C O N S T A N T S                          *
*                                                                   *
*********************************************************************/
 
#define SIL_SA      (const xmlChar *)"sil-sa"
 
#define SIL_SA_MOD  (const xmlChar *)"yumaworks-sil-sa"
 
#define SIL_SA_OBJ  (const xmlChar *)"sil-sa"
 
#define SIL_REQ_OK(ST) ((ST) >= SIL_SA_ST_READY)
 
 
/********************************************************************
*                                                                   *
*                            T Y P E S                              *
*                                                                   *
*********************************************************************/
 
 
/********************************************************************
*                                                                   *
*                       F U N C T I O N S                           *
*                                                                   *
*********************************************************************/
 
 
extern status_t
    sil_sa_register_service (void);
 
 
extern val_value_t *
    sil_sa_get_key (rpc_msg_t *msg,
                    uint32 keynum);
 
 
extern val_value_t *
    sil_sa_get_action_key (rpc_msg_t *msg,
                           uint32 keynum);
 
 
extern void
    sil_sa_queue_notification (agt_not_msg_t *notif);
 
 
extern void
    sil_sa_queue_notification_stream (const xmlChar *stream_name,
                                      agt_not_msg_t *notif);
 
 
extern void
    sil_sa_notif_test (int8 N1,
                       int16 N2,
                       const xmlChar *N3);
 
 
 
extern status_t
    sil_sa_add_library_parm (const xmlChar *libstr);
 
 
extern boolean
    sil_sa_any_library_parms (void);
 
 
extern boolean
    sil_sa_find_library_parm (const xmlChar *libstr);
 
 
const xmlChar*
    sil_sa_get_username (void);
 
 
extern const xmlChar *
    sil_sa_get_client_addr (void);
 
 
const xmlChar *
    sil_sa_get_rpc_msg_id (rpc_msg_t *msg);
 
 
extern void sil_sa_term_msg_test (uint32 count);
 
 
extern status_t
    sil_sa_add_edit (const xmlChar *defpath,
                     val_value_t *edit_value,
                     const xmlChar *edit_operation,
                     const xmlChar *insert_where,
                     const xmlChar *insert_point,
                     boolean skip_cb);
 
 
extern val_value_t *
    sil_sa_get_data (ncx_cfg_t cfg_id,
                     const xmlChar *defpath,
                     status_t *retres);
 
 
extern sil_sa_child_edit_t *
    sil_sa_first_child_edit (rpc_msg_t *msg);
 
 
extern sil_sa_child_edit_t *
    sil_sa_next_child_edit (sil_sa_child_edit_t *curedit);
 
 
extern void
    sil_sa_child_edit_fields (sil_sa_child_edit_t *child_edit,
                              op_editop_t *editop,
                              val_value_t **newval,
                              val_value_t **curval);
 
 
extern void
    sil_sa_set_error_msg (rpc_msg_t *msg,
                          const xmlChar *strval);
 
 
 
extern void
    sil_sa_get_user_data_parms (void **data_ref,
                                uint32 *data_index);
 
 
extern void
    sil_sa_set_user_data_parms (void *data_ref,
                                uint32 data_index);
 
 
#ifdef __cplusplus
}  /* end extern 'C' */
#endif
 
#endif      /* _H_sil_sa */