examples/PIPS/opencmessagequeuelibraryex/engine/inc/msgqlib.h

Go to the documentation of this file.

#ifndef MSGQLIB_H
#define MSGQLIB_H

#include <_ansi.h>

#ifdef __cplusplus
extern "C" {
#endif

/* MsgQLib sizes */
#define  MAX_MSG_LEN       2048 

/* hash table parameters - table size must be a prime number  */
#define  MSGQ_TBL_SZ       101

/* message send states */
#define MSG_Q_READY        0
#define MSG_Q_CLEANING     1


#define NO_WAIT                         0
#define WAIT_FOREVER            0xFFFF

#ifndef NULL
#define NULL                            0
#endif /* NULL */

/* errors */
#define KMsgQLibErr                             0x100
#define KMsgQLibNoMemoryErr     (KMsgQLibErr | 1) /* out of memory */
#define KMsgQLibQIdErr                  (KMsgQLibErr | 2) /* queue already in use or invalid */
#define KMsgQLibParamErr        (KMsgQLibErr | 3) /* illegal parm(s)/val(s) */
#define KMsgQLibQFlushErr       (KMsgQLibErr | 4) /* queue being flushed */
#define KMsgQLibQShortErr       (KMsgQLibErr | 5) /* internal error:  inconsistency between #of msgs*/

#define  MSG_Q_FIFO       1
#define  MSG_Q_PRIORITY   2
#define  MSG_PRI_NORMAL   3
#define  MSG_PRI_URGENT   4
#define  SEM_Q_FIFO       5
#define  SEM_Q_PRIORITY   6

#define  OK               0
#define  ERROR           -1  

typedef  unsigned long    ULONG ;
typedef  unsigned short   ushort_t;

IMPORT_C int MsgQCreate (ULONG qName, ULONG maxMsgs, ULONG qOptions, int* err);

IMPORT_C int MsgQDelete (ULONG qName, int* err);

IMPORT_C int MsgQSend (ULONG qName, char* msg, ULONG nBytes, ULONG priority, int timeout, int* err);

IMPORT_C int MsgQReceive (ULONG qName, char* msg, ULONG maxNBytes, int timeout, int* err);

IMPORT_C int MsgQCheck (ULONG qName, int* err);

IMPORT_C int MsgQMaxCheck (ULONG qName, int* err);

IMPORT_C int MsgQClean (ULONG qName, int* err);

#ifdef __cplusplus
}
#endif

#endif /* MSGQLIB_H */

---