messages.h

Go to the documentation of this file.

/**********************************************************************
 *
 * Verball Model Storage Library, Common Information Model Library 
 * for integration of Intelligent Services.
 * Copyright (C) 2005 Nikita Vinokurov, Orgway LLC.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; 
 * version 2.1 of the License.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, 
 * Boston, MA  02110-1301  USA
 *
 * $Id: messages.h,v 1.12 2006/09/18 21:38:30 sbreg Exp $
 **********************************************************************/

#ifndef _MESSAGES_H_
#define _MESSAGES_H_

#include <limits.h>

#ifdef _WIN32
#include "pthread.h"
#else
#include <pthread.h>
#endif //_WIN32

#include "sockets.h"
#include "../stmt/statement.h"

#define MSG_V3_PROTO_ERROR -234422

#define MSG_V3_PROTO_TIMEOUT -234423

#define MSG_V3_PROTO_OK 0
#define MSG_V3_PROTO_SOCKET_ERROR -234424
#define MSG_V3_PROTO_NOMEM        -234425
#define MSG_V3_PROTO_WRONG_MAGIC  -234426
#define MSG_V3_PROTO_UNKNOWN_PREFIX -234427
#define MSG_V3_PROTO_UNKNOWN_COMMAND -234428
#define MSG_V3_PROTO_NOT_READY -234429
#define MSG_V3_PROTO_WRONG_STATE    -234430
#define MSG_V3_PROTO_BAD_VALUE      -234431

#define MSG_V3_PROTO_NO_ROOM_FOR_TXN -234432

#define CONN_RECV_TIME_OUT      LONG_MAX    

#define CONN_SEND_TIME_OUT      LONG_MAX

/* 
    Note, what time-out will set again and again
    after every incoming/outgoing TCP packet
    while whole message is not be readed/sent.
 */




#define SAFE_STR(s) (s ? s : "")

/* macro _MS_SERVER defined only in server project. */
//#ifndef _MS_SERVER
//typedef enum _client_connection_states {
//  error = -1,
//  inactive,
//  connected,
//  active,
//  closed
//} client_conn_state;
//
//typedef struct _client_connection {
//  hsocket                 sk;
//  client_conn_state       ccs;
//  int                     final_read; /**< The final message read flag */
//  pthread_mutex_t         session_lock; /**< Session locker */
//  int                     last_error;
//} client_conn;

// #else // i.e. server project
// #include "../ols/conn_pool.h"
//#endif //_MS_SERVER

#ifdef __cplusplus
extern "C"
{
#endif/* __cplusplus */



typedef enum { 
    MSG_V3_ALLOC_SELF,
    MSG_V3_ALLOC_AUTO

} msgv3_alloc;

typedef enum {
    MSG_V3_PREFIX_DEFAULT = 0,
    MSG_V3_PREFIX_LEN = 1,
    MSG_V3_PREFIX_CONTEXT,
    MSG_V3_PREFIX_PREDICATE,
    MSG_V3_PREFIX_SUBJECT,
    MSG_V3_PREFIX_OBJECT,
    MSG_V3_PREFIX_OPERATION,
    MSG_V3_PREFIX_PREV,
    MSG_V3_PREFIX_NUM,
    MSG_V3_PREFIX_ERRSTR,
    MSG_V3_PREFIX_START,
    MSG_V3_PREFIX_END,
    MSG_V3_PREFIX_TXN,
    MSG_V3_PREFIX_LOGIN,
    MSG_V3_PREFIX_FINAL,
    MSG_V3_PREFIX_CMD,
    MSG_V3_PREFIX_MAGIC,
    MSG_V3_PREFIXES_COUNT

} msgv3_prefix;

#define MSG_V3_PREFIX_DEFAULT_BIT (0x01 << MSG_V3_PREFIX_DEFAULT)
#define MSG_V3_PREFIX_LEN_BIT     (0x01 << MSG_V3_PREFIX_LEN)
#define MSG_V3_PREFIX_CONTEXT_BIT (0x01 << MSG_V3_PREFIX_CONTEXT)
#define MSG_V3_PREFIX_PREDICATE_BIT (0x01 << MSG_V3_PREFIX_PREDICATE)
#define MSG_V3_PREFIX_SUBJECT_BIT (0x01 << MSG_V3_PREFIX_SUBJECT)
#define MSG_V3_PREFIX_OBJECT_BIT  (0x01 << MSG_V3_PREFIX_OBJECT)
#define MSG_V3_PREFIX_NUM_BIT       (0x01 << MSG_V3_PREFIX_NUM)
#define MSG_V3_PREFIX_ERR_BIT     (0x01 << MSG_V3_PREFIX_ERRSTR)
#define MSG_V3_PREFIX_START_BIT   (0x01 << MSG_V3_PREFIX_START)
#define MSG_V3_PREFIX_END_BIT     (0x01 << MSG_V3_PREFIX_END)
#define MSG_V3_PREFIX_TXN_BIT     (0x01 << MSG_V3_PREFIX_TXN)
#define MSG_V3_PREFIX_LOGIN_BIT   (0x01 << MSG_V3_PREFIX_LOGIN)
#define MSG_V3_PREFIX_OPERATION_BIT (0x01 << MSG_V3_PREFIX_OPERATION)
#define MSG_V3_PREFIX_PREV_BIT      (0x01 << MSG_V3_PREFIX_PREV)
#define MSG_V3_PREFIX_STATEMENT_BITS (MSG_V3_PREFIX_CONTEXT_BIT | MSG_V3_PREFIX_SUBJECT_BIT | MSG_V3_PREFIX_PREDICATE_BIT | MSG_V3_PREFIX_OBJECT_BIT | MSG_V3_PREFIX_OPERATION_BIT | MSG_V3_PREFIX_PREV_BIT | MSG_V3_PREFIX_START_BIT | MSG_V3_PREFIX_END_BIT )
#define MSG_V3_PREFIX_MASK_BITS (MSG_V3_PREFIX_CONTEXT_BIT | MSG_V3_PREFIX_SUBJECT_BIT | MSG_V3_PREFIX_PREDICATE_BIT | MSG_V3_PREFIX_OBJECT_BIT )


typedef enum {
    MSG_V3_COMMAND_OK = 0,
    MSG_V3_COMMAND_FAIL = 1,
    MSG_V3_COMMAND_SET,
    MSG_V3_COMMAND_NOP,
    MSG_V3_COMMAND_NOTIFY,
    MSG_V3_COMMAND_BEGIN,
    MSG_V3_COMMAND_COMMIT,
    MSG_V3_COMMAND_ROLLBACK,
    MSG_V3_COMMAND_LOGIN,
    MSG_V3_COMMAND_LOGOUT,
    MSG_V3_COMMAND_GET,
    MSG_V3_COMMAND_BATCHGET,
    MSG_V3_COMMAND_SYNC,
    MSG_V3_COMMAND_NEWID,
    MSG_V3_COMMAND_EMPTY,
    MSG_V3_COMMAND_GETCOUNT,
    MSG_V3_COMMANDS_COUNT
} msgv3_command;


typedef struct {
    msgv3_alloc alloc_type;
    msgv3_prefix prefix;
    unsigned int size;
    void *value;
    long integer;   

} VrbProt3Value;

typedef struct {
    unsigned int magic;
    msgv3_command cmd;
} VrbProt3Msg;

typedef struct {
    VrbProt3Value values[MSG_V3_PREFIXES_COUNT];
    unsigned int update_bits;

} VrbProt3Pool;


int msgv3_msg_send(hsocket sk, msgv3_command cmd, VrbProt3Pool *pool, unsigned int prefix_mask);

int msgv3_msg_recv(hsocket sk, msgv3_command *cmd, VrbProt3Pool *pool);

void msgv3_value_init(VrbProt3Value *value,
                        msgv3_alloc alloc,
                        msgv3_prefix prefix,
                        unsigned int size, void *buf);

void msgv3_value_free(VrbProt3Value *value);

void msgv3_value_init_string(VrbProt3Value *value, unsigned char prefix, const char *str);


void msgv3_pool_init(VrbProt3Pool *pool);

void msgv3_pool_update(VrbProt3Pool *pool, VrbProt3Value *value);

void msgv3_pool_get_value(VrbProt3Pool *pool, msgv3_prefix prefix, VrbProt3Value *value);

int msgv3_pool_read_value(VrbProt3Pool *pool, msgv3_prefix prefix, unsigned int offset, void *buf, unsigned int size);

void msgv3_pool_clear(VrbProt3Pool *pool);

int msgv3_pool_get_statement(VrbProt3Pool *pool, Statement *stmt);


int msgv3_pool_get_mask(VrbProt3Pool *pool, Statement *mask);


int msgv3_pool_set_statement(VrbProt3Pool *pool, const  Statement *stmt);

int msgv3_pool_set_mask(VrbProt3Pool *pool, const Statement *mask);

void msgv3_value_init_integer(VrbProt3Value *value, msgv3_prefix prefix, long integer);

void msgv3_value_init_null(VrbProt3Value *value, msgv3_prefix prefix);


void msgv3_value_ensure_string(VrbProt3Value *value);

#ifdef __cplusplus
}
#endif/* __cplusplus */


#endif /* _MESSAGES_H_ */

---