cMsgConstants.h File Reference

Go to the source code of this file.

Macros
#define	CMSG_ENDIAN_BIG   0
#define	CMSG_ENDIAN_LITTLE   1
#define	CMSG_ENDIAN_LOCAL   2
#define	CMSG_ENDIAN_NOTLOCAL   3
#define	CMSG_ENDIAN_SWITCH   4
#define	CMSG_DEBUG_NONE   0
#define	CMSG_DEBUG_SEVERE   1
#define	CMSG_DEBUG_ERROR   2
#define	CMSG_DEBUG_WARN   3
#define	CMSG_DEBUG_INFO   4
#define	CMSG_REGIME_MEDIUM   0
#define	CMSG_REGIME_LOW   1
#define	CMSG_REGIME_HIGH   2
#define	CMSG_FAILOVER_ANY   0
#define	CMSG_FAILOVER_CLOUD   1
#define	CMSG_FAILOVER_CLOUD_ONLY   2
#define	CMSG_CLOUD_ANY   0
#define	CMSG_CLOUD_LOCAL   1
#define	CMSG_SHUTDOWN_INCLUDE_ME   1

Enumerations
enum	{   CMSG_OK = 0 , CMSG_ERROR , CMSG_TIMEOUT , CMSG_NOT_IMPLEMENTED ,   CMSG_BAD_ARGUMENT , CMSG_BAD_FORMAT , CMSG_BAD_DOMAIN_TYPE , CMSG_ALREADY_EXISTS ,   CMSG_NOT_INITIALIZED , CMSG_ALREADY_INIT , CMSG_LOST_CONNECTION , CMSG_NETWORK_ERROR ,   CMSG_SOCKET_ERROR , CMSG_PEND_ERROR , CMSG_ILLEGAL_MSGTYPE , CMSG_OUT_OF_MEMORY ,   CMSG_OUT_OF_RANGE , CMSG_LIMIT_EXCEEDED , CMSG_BAD_DOMAIN_ID , CMSG_BAD_MESSAGE ,   CMSG_WRONG_DOMAIN_TYPE , CMSG_NO_CLASS_FOUND , CMSG_DIFFERENT_VERSION , CMSG_WRONG_PASSWORD ,   CMSG_SERVER_DIED , CMSG_ABORT }
enum	{   CMSG_CP_STR = 10 , CMSG_CP_FLT , CMSG_CP_DBL , CMSG_CP_INT8 ,   CMSG_CP_INT16 , CMSG_CP_INT32 , CMSG_CP_INT64 , CMSG_CP_UINT8 ,   CMSG_CP_UINT16 , CMSG_CP_UINT32 , CMSG_CP_UINT64 , CMSG_CP_MSG ,   CMSG_CP_BIN , CMSG_CP_STR_A , CMSG_CP_FLT_A , CMSG_CP_DBL_A ,   CMSG_CP_INT8_A , CMSG_CP_INT16_A , CMSG_CP_INT32_A , CMSG_CP_INT64_A ,   CMSG_CP_UINT8_A , CMSG_CP_UINT16_A , CMSG_CP_UINT32_A , CMSG_CP_UINT64_A ,   CMSG_CP_MSG_A , CMSG_CP_BIN_A }

Macro Definition Documentation

CMSG_CLOUD_ANY

#define CMSG_CLOUD_ANY   0

Client fails over to any cloud server.

CMSG_CLOUD_LOCAL

#define CMSG_CLOUD_LOCAL   1

Client fails over to local cloud servers first.

CMSG_DEBUG_ERROR

#define CMSG_DEBUG_ERROR   2

Output only errors for debugging.

CMSG_DEBUG_INFO

#define CMSG_DEBUG_INFO   4

Output everything for debugging.

CMSG_DEBUG_NONE

#define CMSG_DEBUG_NONE   0

No debugging output.

CMSG_DEBUG_SEVERE

#define CMSG_DEBUG_SEVERE   1

Output only severe (process-ending) errors for debugging.

CMSG_DEBUG_WARN

#define CMSG_DEBUG_WARN   3

Output warnings and errors for debugging.

CMSG_ENDIAN_BIG

#define CMSG_ENDIAN_BIG   0

Is big endian.

CMSG_ENDIAN_LITTLE

#define CMSG_ENDIAN_LITTLE   1

Is little endian.

CMSG_ENDIAN_LOCAL

#define CMSG_ENDIAN_LOCAL   2

Is same endian as local host.

CMSG_ENDIAN_NOTLOCAL

#define CMSG_ENDIAN_NOTLOCAL   3

Is opposite endian as local host.

CMSG_ENDIAN_SWITCH

#define CMSG_ENDIAN_SWITCH   4

Switch recorded value of data's endian.

CMSG_FAILOVER_ANY

#define CMSG_FAILOVER_ANY   0

Client fails over to any server.

CMSG_FAILOVER_CLOUD

#define CMSG_FAILOVER_CLOUD   1

Client fails over to cloud servers first, then any.

CMSG_FAILOVER_CLOUD_ONLY

#define CMSG_FAILOVER_CLOUD_ONLY   2

Client fails over to only cloud servers.

CMSG_REGIME_HIGH

#define CMSG_REGIME_HIGH   2

Client has high data/message throughput.

CMSG_REGIME_LOW

#define CMSG_REGIME_LOW   1

Client has low data/message throughput.

CMSG_REGIME_MEDIUM

#define CMSG_REGIME_MEDIUM   0

Client has medium data/message throughput.

CMSG_SHUTDOWN_INCLUDE_ME

#define CMSG_SHUTDOWN_INCLUDE_ME   1

When shutting down clients, include the calling client (me).

Enumeration Type Documentation

anonymous enum

anonymous enum

Return codes.

Enumerator
CMSG_OK	No error.
CMSG_ERROR	Generic error.
CMSG_TIMEOUT	Timeout.
CMSG_NOT_IMPLEMENTED	Feature not implemented.
CMSG_BAD_ARGUMENT	Function argument(s) have illegal value.
CMSG_BAD_FORMAT	Function argument(s) in wrong format.
CMSG_BAD_DOMAIN_TYPE	Domain type not supported.
CMSG_ALREADY_EXISTS	Unique item already exists.
CMSG_NOT_INITIALIZED	Connection not established - call cMsgConnect.
CMSG_ALREADY_INIT	Connection already established.
CMSG_LOST_CONNECTION	No network connection to cMsg server.
CMSG_NETWORK_ERROR	Communication error talking to server.
CMSG_SOCKET_ERROR	Error setting TCP socket option(s).
CMSG_PEND_ERROR	Error when waiting for messages to arrive.
CMSG_ILLEGAL_MSGTYPE	Received illegal message type.
CMSG_OUT_OF_MEMORY	No more memory available.
CMSG_OUT_OF_RANGE	Argument out of acceptable range.
CMSG_LIMIT_EXCEEDED	Trying to create too many of an item.
CMSG_BAD_DOMAIN_ID	Id does not match any existing domain.
CMSG_BAD_MESSAGE	Message is not in the correct form.
CMSG_WRONG_DOMAIN_TYPE	UDL does not match the server type.
CMSG_NO_CLASS_FOUND	Java class cannot be found to instantiate subdomain handler.
CMSG_DIFFERENT_VERSION	Client and server are different cMsg versions.
CMSG_WRONG_PASSWORD	Wrong password given.
CMSG_SERVER_DIED	Server died.
CMSG_ABORT	Abort effort.

anonymous enum

anonymous enum

Type codes for compound payloads. Make these all 2 digits for ease in net protocol.

Enumerator
CMSG_CP_STR	String.
CMSG_CP_FLT	4 byte float.
CMSG_CP_DBL	8 byte float.
CMSG_CP_INT8	8 bit int.
CMSG_CP_INT16	16 bit int.
CMSG_CP_INT32	32 bit int.
CMSG_CP_INT64	64 bit int.
CMSG_CP_UINT8	unsigned 8 bit int.
CMSG_CP_UINT16	unsigned 16 bit int.
CMSG_CP_UINT32	unsigned 32 bit int.
CMSG_CP_UINT64	unsigned 64 bit int.
CMSG_CP_MSG	cMsg message.
CMSG_CP_BIN	binary.
CMSG_CP_STR_A	String array.
CMSG_CP_FLT_A	4 byte float array.
CMSG_CP_DBL_A	8 byte float array.
CMSG_CP_INT8_A	8 bit int array.
CMSG_CP_INT16_A	16 bit int array.
CMSG_CP_INT32_A	32 bit int array.
CMSG_CP_INT64_A	64 bit int array.
CMSG_CP_UINT8_A	unsigned 8 bit int array.
CMSG_CP_UINT16_A	unsigned 16 bit int array.
CMSG_CP_UINT32_A	unsigned 32 bit int array.
CMSG_CP_UINT64_A	unsigned 64 bit int array.
CMSG_CP_MSG_A	cMsg message array.
CMSG_CP_BIN_A	array of binary items.