Internal Definitions


Physical Type

See also:
packet_types_table


#define NQ_PT_NONE   0x00
#define NQ_PT_REQUEST   0x01
#define NQ_PT_RESPONSE   0x02
#define NQ_PT_TELEGRAM   0x03

Logical Type

See also:
packet_types_table


#define NQ_LT_NONE   0x00
#define NQ_LT_GET   0x01
 Logical 'get' paket (request data from peer).
#define NQ_LT_PUT   0x02
 Logical 'put' paket (write data to peer).
#define NQ_LT_CALL   0x03
 Logical 'call' paket (call a remote function on peer).
#define NQ_LT_TRAP   0x04
 Logical 'trap' paket (signal something to peer).
#define NQ_LT_UPDATE   0x05
 Logical 'update' paket (a self inducted paket, that was send to update data at remote peer).

Variable Types

Note:
NQ_VARTYPE_BINARY and NQ_VARTYPE_TEXT are naturally 1-dimensional arrays by itself
other VARTYPES can be also 1-dimensional arrays (in shortest case 1 element)
See also:
CNQMessage::write CNQMessage::read


#define NQ_VARTYPE_BINARY   (NQ_MIN_VARTYPE)
 Variable type constant to identify binary data.
#define NQ_VARTYPE_FLOAT   (NQ_MIN_VARTYPE+1)
 Variable type constant to identify float data.
#define NQ_VARTYPE_DOUBLE   (NQ_MIN_VARTYPE+2)
 Variable type constant to identify double data.
#define NQ_VARTYPE_INT8   (NQ_MIN_VARTYPE+3)
 Variable type constant to identify signed 8bit data.
#define NQ_VARTYPE_UINT8   (NQ_MIN_VARTYPE+4)
 Variable type constant to identify unsigned 8bit data.
#define NQ_VARTYPE_INT16   (NQ_MIN_VARTYPE+5)
 Variable type constant to identify signed 16bit data.
#define NQ_VARTYPE_UINT16   (NQ_MIN_VARTYPE+6)
 Variable type constant to identify unsigned 16bit data.
#define NQ_VARTYPE_INT32   (NQ_MIN_VARTYPE+7)
 Variable type constant to identify signed 32bit data.
#define NQ_VARTYPE_UINT32   (NQ_MIN_VARTYPE+8)
 Variable type constant to identify unsigned 32bit data.
#define NQ_VARTYPE_TEXT   (NQ_MIN_VARTYPE+9)
 Variable type constant to identify textual data.

Defines

#define NQ_PACKET_SPECIAL_BITS_VALID_MASK   0xFFFC
#define NQ_PACKET_SPECIAL_BITS_DEFAULT_VALUE   0x0000
#define NQ_PACKET_BIT_WANT_ACK   0x0002
#define NQ_PACKET_BIT_IS_ACKPACKET   0x0001
#define NQ_MIN_VARTYPE   1
#define NQ_MAX_VARTYPE   (NQ_VARTYPE_TEXT)
#define NQ_MAX_PACKETPAYLOAD_SIZE   (NQ_MAX_PACKET_SIZE-NQ_SIZE_MESSAGE_FILL_STUFF-NQ_SIZE_PACKET_FILL_STUFF)
#define NQ_MIN_SIZE_DATA   (16)
 min_size_data (inside linked list):
#define NQ_MIN_SIZE_DATA_NET   (12)
 one data block on the net (minimum size)
#define NQ_MAX_NUM_ENTRIES   (NQ_MAX_PACKETPAYLOAD_SIZE / NQ_MIN_SIZE_DATA_NET)
#define NQ_SIZE_ADD_LINKEDLIST   (4*NQ_MAX_NUM_ENTRIES)
 size to add for in-CNQMessage workbuffer wor max_packetpayload_size (includes linked list costs)
#define NQ_SENDQUEUE_SIZE   10
#define NQ_RECVQUEUE_SIZE   10
#define NQ_ACKQUEUE_SIZE   10
#define NQ_NUM_CNQMESSAGEBUFFERS   40
#define NQ_SEND_SEMAPHORE_TIMEOUT_MS   500
#define NQ_SEND_SELECT_TIMEOUT_MS   200
#define NQ_RECV_SELECT_TIMEOUT_MS   100
#define NQ_SEND_THREAD_PRIORITY   SW_THREAD_PRIORITY_BELOW_NORMAL
#define NQ_RECV_THREAD_PRIORITY   SW_THREAD_PRIORITY_NORMAL
#define NQ_SIZE_MESSAGE_FILL_STUFF   16
#define NQ_SIZE_PACKET_FILL_STUFF   10
#define NQ_PACKET_MAGIC_TOP   0xA51C
#define NQ_PACKET_MAGIC_TAIL   0xC15A
#define NQ_PACKET_VERSIONS_SUPPORTED   0x0001
#define NQ_NO_SEMAPHORE   NULL
#define NQ_RESPONSEWAITQUEUE_MAX_SIZE   10
#define NQ_PEERLIST_MAX_SIZE   10

Define Documentation

#define NQ_ACKQUEUE_SIZE   10

Definition at line 237 of file NQDeclarations.h.

Referenced by CNetworkQueue::CNetworkQueue().

#define NQ_LT_CALL   0x03

Logical 'call' paket (call a remote function on peer).

Definition at line 173 of file NQDeclarations.h.

Referenced by CNQMessage::check_int(), and SimulateLocalPeer().

#define NQ_LT_GET   0x01

Logical 'get' paket (request data from peer).

Definition at line 169 of file NQDeclarations.h.

Referenced by CNQMessage::check_int().

#define NQ_LT_NONE   0x00

See also:
packet_format No Logical Type defined

Definition at line 167 of file NQDeclarations.h.

Referenced by CNQMessage::clear().

#define NQ_LT_PUT   0x02

Logical 'put' paket (write data to peer).

Definition at line 171 of file NQDeclarations.h.

Referenced by CNQMessage::check_int().

#define NQ_LT_TRAP   0x04

Logical 'trap' paket (signal something to peer).

Definition at line 175 of file NQDeclarations.h.

Referenced by CNQMessage::check_int().

#define NQ_LT_UPDATE   0x05

Logical 'update' paket (a self inducted paket, that was send to update data at remote peer).

Definition at line 177 of file NQDeclarations.h.

Referenced by CNQMessage::check_int(), SimulateLocalPeer(), and SimulateRemotePeer().

#define NQ_MAX_NUM_ENTRIES   (NQ_MAX_PACKETPAYLOAD_SIZE / NQ_MIN_SIZE_DATA_NET)

maximum amount of data entries per packet depends on max_packetload_size and min_size_data

Definition at line 229 of file NQDeclarations.h.

Referenced by CNQMessage::clear(), and CNQMessage::ImportMessageFromPacketBuffer().

#define NQ_MAX_PACKETPAYLOAD_SIZE   (NQ_MAX_PACKET_SIZE-NQ_SIZE_MESSAGE_FILL_STUFF-NQ_SIZE_PACKET_FILL_STUFF)

Definition at line 219 of file NQDeclarations.h.

#define NQ_MAX_VARTYPE   (NQ_VARTYPE_TEXT)

Definition at line 187 of file NQDeclarations.h.

Referenced by CNQMessage::ImportMessageFromPacketBuffer().

#define NQ_MIN_SIZE_DATA   (16)

min_size_data (inside linked list):

Definition at line 222 of file NQDeclarations.h.

Referenced by CNQMessage::clear(), and CNQMessage::ImportMessageFromPacketBuffer().

#define NQ_MIN_SIZE_DATA_NET   (12)

one data block on the net (minimum size)

Definition at line 225 of file NQDeclarations.h.

Referenced by CNQMessage::write().

#define NQ_MIN_VARTYPE   1

Definition at line 186 of file NQDeclarations.h.

Referenced by CNQMessage::ImportMessageFromPacketBuffer().

#define NQ_NO_SEMAPHORE   NULL

#define NQ_NUM_CNQMESSAGEBUFFERS   40

Definition at line 238 of file NQDeclarations.h.

Referenced by CNetworkQueue::create().

#define NQ_PACKET_BIT_IS_ACKPACKET   0x0001

#define NQ_PACKET_BIT_WANT_ACK   0x0002

#define NQ_PACKET_MAGIC_TAIL   0xC15A

Definition at line 256 of file NQDeclarations.h.

Referenced by CNQMessage::check_int(), and CNQMessage::clear().

#define NQ_PACKET_MAGIC_TOP   0xA51C

Definition at line 255 of file NQDeclarations.h.

Referenced by CNQMessage::check_int(), and CNQMessage::clear().

#define NQ_PACKET_SPECIAL_BITS_DEFAULT_VALUE   0x0000

Definition at line 182 of file NQDeclarations.h.

Referenced by CNQMessage::clear().

#define NQ_PACKET_SPECIAL_BITS_VALID_MASK   0xFFFC

Definition at line 181 of file NQDeclarations.h.

Referenced by CNQMessage::check_int().

#define NQ_PACKET_VERSIONS_SUPPORTED   0x0001

Definition at line 257 of file NQDeclarations.h.

Referenced by CNQMessage::check_int().

#define NQ_PEERLIST_MAX_SIZE   10

Definition at line 265 of file NQDeclarations.h.

Referenced by CNQPeerList::CNQPeerList().

#define NQ_PT_NONE   0x00

Definition at line 154 of file NQDeclarations.h.

Referenced by CNQMessage::clear().

#define NQ_PT_REQUEST   0x01

#define NQ_PT_RESPONSE   0x02

#define NQ_PT_TELEGRAM   0x03

#define NQ_RECV_SELECT_TIMEOUT_MS   100

Definition at line 242 of file NQDeclarations.h.

Referenced by CNetworkQueue::ReceiveProcessTask().

#define NQ_RECV_THREAD_PRIORITY   SW_THREAD_PRIORITY_NORMAL

Definition at line 246 of file NQDeclarations.h.

Referenced by CNetworkQueue::create().

#define NQ_RECVQUEUE_SIZE   10

Definition at line 236 of file NQDeclarations.h.

Referenced by CNetworkQueue::CNetworkQueue(), and CNetworkQueue::create().

#define NQ_RESPONSEWAITQUEUE_MAX_SIZE   10

Definition at line 262 of file NQDeclarations.h.

Referenced by CNQResponseWaitQueue::CNQResponseWaitQueue().

#define NQ_SEND_SELECT_TIMEOUT_MS   200

Definition at line 241 of file NQDeclarations.h.

Referenced by CNetworkQueue::SendProcessTask().

#define NQ_SEND_SEMAPHORE_TIMEOUT_MS   500

Definition at line 240 of file NQDeclarations.h.

Referenced by CNetworkQueue::SendProcessTask().

#define NQ_SEND_THREAD_PRIORITY   SW_THREAD_PRIORITY_BELOW_NORMAL

Definition at line 244 of file NQDeclarations.h.

Referenced by CNetworkQueue::create().

#define NQ_SENDQUEUE_SIZE   10

Definition at line 235 of file NQDeclarations.h.

Referenced by CNetworkQueue::CNetworkQueue(), and CNetworkQueue::create().

#define NQ_SIZE_ADD_LINKEDLIST   (4*NQ_MAX_NUM_ENTRIES)

size to add for in-CNQMessage workbuffer wor max_packetpayload_size (includes linked list costs)

Definition at line 232 of file NQDeclarations.h.

Referenced by CNQMessage::clear(), and CNQMessage::ImportMessageFromPacketBuffer().

#define NQ_SIZE_MESSAGE_FILL_STUFF   16

#define NQ_SIZE_PACKET_FILL_STUFF   10

#define NQ_VARTYPE_BINARY   (NQ_MIN_VARTYPE)

#define NQ_VARTYPE_DOUBLE   (NQ_MIN_VARTYPE+2)

#define NQ_VARTYPE_FLOAT   (NQ_MIN_VARTYPE+1)

#define NQ_VARTYPE_INT16   (NQ_MIN_VARTYPE+5)

#define NQ_VARTYPE_INT32   (NQ_MIN_VARTYPE+7)

#define NQ_VARTYPE_INT8   (NQ_MIN_VARTYPE+3)

#define NQ_VARTYPE_TEXT   (NQ_MIN_VARTYPE+9)

#define NQ_VARTYPE_UINT16   (NQ_MIN_VARTYPE+6)

#define NQ_VARTYPE_UINT32   (NQ_MIN_VARTYPE+8)

#define NQ_VARTYPE_UINT8   (NQ_MIN_VARTYPE+4)


Generated on Tue Apr 22 18:19:58 2008 for NetworkQueue by  doxygen 1.5.5