db_api_types.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_db_api_types
#define _H_db_api_types
 
/*  FILE: db_api_types.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-nov-14    abb      Begun
*/
 
#include <xmlstring.h>
 
#ifndef _H_dlq
#include "dlq.h"
#endif
 
#ifndef _H_ncxtypes
#include "ncxtypes.h"
#endif
 
#ifndef _H_obj
#include "obj.h"
#endif
 
#ifndef _H_rpc
#include "rpc.h"
#endif
 
#ifndef _H_status_enum
#include "status_enum.h"
#endif
 
#ifndef _H_val
#include "val.h"
#endif
 
 
#ifdef __cplusplus
extern "C" {
#endif
 
/********************************************************************
*                                   *
*            C O N S T A N T S              *
*                                   *
*********************************************************************/
 
 
/********************************************************************
*                                   *
*                T Y P E S                  *
*                                   *
*********************************************************************/
 
typedef enum db_api_state_t_ {
    DB_API_ST_NONE,
 
    DB_API_ST_START,
 
    DB_API_ST_STOPPED,
 
    DB_API_ST_ERROR,
 
    DB_API_ST_WAIT_REGISTER,
 
    DB_API_ST_READY,
 
    DB_API_ST_WAIT_EDIT,
 
    DB_API_ST_WAIT_GETCONFIG,
 
    DB_API_ST_WAIT_DB_LOCK_INIT,
 
    DB_API_ST_WAIT_SUBRPC,
 
    DB_API_ST_WAIT_PROTOCTL,
 
} db_api_state_t;
 
 
typedef enum lock_state_t_ {
    LOCK_ST_NONE,
 
    LOCK_ST_WAIT_INIT,
 
    LOCK_ST_IDLE,
 
    LOCK_ST_LOCAL_LOCKED,
 
    LOCK_ST_SERVER_LOCKED,
 
    LOCK_ST_ERROR,
} lock_state_t;
 
 
 
typedef void (*db_api_dataresp_cbfn_t) (status_t res,
                                        val_value_t *val,
                                        void *cookie);
 
 
 
typedef struct db_api_cb_t_ {
    ncx_module_t *mod;
 
    obj_template_t *obj;
 
    val_value_t *payload;
 
    db_api_state_t state;
 
    uint32 msgid;
 
    val_value_t *edit_request;
 
    rpc_msg_t *rpc_msg;
 
    uint32 last_msgid;
 
    status_t last_status;
 
    xmlChar *last_msg;
 
    xmlChar *filespec;
 
    db_api_dataresp_cbfn_t cbfn;
 
    void *cookie;
 
    const char *cmdname;
 
    boolean db_lock_enabled;
 
    lock_state_t db_lock_state;
 
    xmlChar *lock_id;
} db_api_cb_t;
 
 
#ifdef __cplusplus
}  /* end extern 'C' */
#endif
 
#endif      /* _H_db_api_types */