NQDeclarations.h

Go to the documentation of this file.

#ifndef __DECLARATIONS_H_INCLUDED__
#define __DECLARATIONS_H_INCLUDED__

#include "PlatformSW.h"



#define NQ_MAX_PACKET_SIZE              1472

#define NQ_DEFAULT_PACKETQUEUE_SIZE 10

// error definitions inside classes 


// CNQPeerList

#define ERR_PL_NONE             0           
#define ERR_PL_LOCK             1
#define ERR_PL_FULL             2           
#define ERR_PL_NOTFOUND         3
#define ERR_PL_INDEXNOTSET      4

// CNQPacketQueue

#define ERR_PQ_NONE             0   
#define ERR_PQ_LOCK             1   
#define ERR_PQ_FULL             2   
#define ERR_PQ_NOTFOUND         3   
#define ERR_PQ_BADPARAM         4   

/* @}*/

// CNQResponseWaitQueue
/* @{ */

#define ERR_RWQ_NONE            0
#define ERR_RWQ_LOCK            1
#define ERR_RWQ_FULL            2
#define ERR_RWQ_NOTFOUND        3

/* @} */

// CNetworkQueue
#define ERR_NQ_BASE      0
#define ERR_NQ_NUMERRORS 28

/*  @name Error Codes for CNetworkQueue
 *  @{
 */
#define ERR_NQ_NONE             (ERR_NQ_BASE+0)
#define ERR_NQ_ALREADY          (ERR_NQ_BASE+1)
#define ERR_NQ_BADPOOL          (ERR_NQ_BASE+2)
#define ERR_NQ_BADIP            (ERR_NQ_BASE+3)
#define ERR_NQ_SOCREATE         (ERR_NQ_BASE+4)
#define ERR_NQ_SOBIND           (ERR_NQ_BASE+5)
#define ERR_NQ_ADDPEER          (ERR_NQ_BASE+6)
#define ERR_NQ_SONONBLOCK       (ERR_NQ_BASE+7)
#define ERR_NQ_SEMCREATESEND    (ERR_NQ_BASE+8)
#define ERR_NQ_SEMCREATERECV    (ERR_NQ_BASE+9)
#define ERR_NQ_THRDCREATESEND   (ERR_NQ_BASE+10)
#define ERR_NQ_THRDCREATERECV   (ERR_NQ_BASE+11)
#define ERR_NQ_THRDCLEANUP      (ERR_NQ_BASE+12)
#define ERR_NQ_SOCLOSE          (ERR_NQ_BASE+13)
#define ERR_NQ_SEMCLEANUP       (ERR_NQ_BASE+14)
#define ERR_NQ_MSGINVALID       (ERR_NQ_BASE+15)
#define ERR_NQ_SENDQUEUEFULL    (ERR_NQ_BASE+16)
#define ERR_NQ_SENDQUEUE        (ERR_NQ_BASE+17)
#define ERR_NQ_SEMNOTIFY        (ERR_NQ_BASE+18)
#define ERR_NQ_EMPTY            (ERR_NQ_BASE+19)
#define ERR_NQ_RECVQUEUE        (ERR_NQ_BASE+20)
#define ERR_NQ_TIMEOUT          (ERR_NQ_BASE+21)
#define ERR_NQ_SEMCREATE        (ERR_NQ_BASE+22)
#define ERR_NQ_RESPTROUBLE      (ERR_NQ_BASE+23)
#define ERR_NQ_SEMDELETE        (ERR_NQ_BASE+24)
#define ERR_NQ_INVALIDPEER      (ERR_NQ_BASE+25)
#define ERR_NQ_ACKQUEUE         (ERR_NQ_BASE+26)
#define ERR_NQ_RESPWAITQUEUE    (ERR_NQ_BASE+27)
 // Group nq_errorcodes


// -------- from message.h

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



#define NQ_LT_NONE                  0x00
#define NQ_LT_GET                   0x01
#define NQ_LT_PUT                   0x02
#define NQ_LT_CALL                  0x03
#define NQ_LT_TRAP                  0x04
#define NQ_LT_UPDATE                0x05

// only last two bits are defined
#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_VARTYPE_BINARY               (NQ_MIN_VARTYPE)
#define NQ_VARTYPE_FLOAT                (NQ_MIN_VARTYPE+1)
#define NQ_VARTYPE_DOUBLE               (NQ_MIN_VARTYPE+2)
#define NQ_VARTYPE_INT8                 (NQ_MIN_VARTYPE+3)
#define NQ_VARTYPE_UINT8                (NQ_MIN_VARTYPE+4)
#define NQ_VARTYPE_INT16                (NQ_MIN_VARTYPE+5)
#define NQ_VARTYPE_UINT16               (NQ_MIN_VARTYPE+6)
#define NQ_VARTYPE_INT32                (NQ_MIN_VARTYPE+7)
#define NQ_VARTYPE_UINT32               (NQ_MIN_VARTYPE+8)
#define NQ_VARTYPE_TEXT                 (NQ_MIN_VARTYPE+9)

#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)

#define NQ_MIN_SIZE_DATA_NET            (12)

#define NQ_MAX_NUM_ENTRIES              (NQ_MAX_PACKETPAYLOAD_SIZE / NQ_MIN_SIZE_DATA_NET)

#define NQ_SIZE_ADD_LINKEDLIST          (4*NQ_MAX_NUM_ENTRIES)

// -------- from Networkqueue.h
#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 RECV_THREAD_PRIORITY      SW_THREAD_PRIORITY_ABOVE_NORMAL // does not work on linux without root priv
#define NQ_RECV_THREAD_PRIORITY     SW_THREAD_PRIORITY_NORMAL

// (authid, pidx, reqid, subsysid, numdlbk, packet types, packet type param)
#define NQ_SIZE_MESSAGE_FILL_STUFF      16

// (magic, size, version, alignfiller, tail)
#define NQ_SIZE_PACKET_FILL_STUFF       10

// packet magics and supported version
#define NQ_PACKET_MAGIC_TOP         0xA51C
#define NQ_PACKET_MAGIC_TAIL            0xC15A
#define NQ_PACKET_VERSIONS_SUPPORTED    0x0001

#define NQ_NO_SEMAPHORE             NULL

// -------- for ResponseWaitQueue
#define NQ_RESPONSEWAITQUEUE_MAX_SIZE   10

// -------- for PeerList
#define NQ_PEERLIST_MAX_SIZE            10

// special timeout type used e.g. by CNetworkQueue
// platform-independent timeval
typedef struct
{
    INT32 tv_sec;   //seconds
    INT32 tv_usec;  //microseconds
} NQ_TIMEVAL; // PlatformIndependent TIMEVAL structure


typedef struct 
{    
    UINT32 RcvInvalidPeerAddress;

    UINT32 RcvSocketErrors;                 
    UINT32 RcvNoBuffersLeft;    
    UINT32 RcvNoDataReceived;               
    UINT32 RcvSelectErrors;                 
    
    UINT32 RcvDroppedPacketsBadChecksum;    
    UINT32 RcvNumTelegrams;                 
    UINT32 RcvNumRequests;                  
    UINT32 RcvNumResponses;                   
    UINT32 RcvNumPacketsWantAck;  
    UINT32 RcvAckPackets;  
    UINT32 RcvPacketsMissedByIndex;         

    UINT32 RcvResponsesWithSemaphore;       
                                            
    UINT32 RcvResponsesWithoutSemaphore;    

    UINT32 RcvDroppedPacketsQueueFull;      
    UINT32 RcvQueueErrors;                  
    
    UINT32 SntTelegrams;                    
    UINT32 SntRequests;                     
    UINT32 SntResponses;                    
    UINT32 SntAckPackets;                   

    UINT32 SntSocketErrors;                 
    UINT32 SntEncodingErrors;               
    
    UINT32 SntQueueErrors;                  
    UINT32 SntQueueFull;
    UINT32 BlockingCallResponseTimeout;
    UINT32 BlockingCallResponseReceivedOnTime;
    UINT32 BlockingCallRequestSent;

    UINT32 AckTimeout;
    
    NQ_TIMEVAL StartTime;                       

} NQ_STATISTICS;

typedef struct
{
    UINT16  requestid;
    HANDLE  semaphore_to_signal;
} NQ_WAITFORRESPONSE;
 // group nq_internal_defs

/*

  !pseudocode packet structure!

typedef struct
{
    // general packet header
    UINT16  packet_magic;
    UINT16  packet_size;
    UINT16  packet_version;
    UINT16  packet_special_bits;


    // specific packet header, ver2
    UINT32  authorisation_id;
    UINT16  packet_index;
    UINT16  request_id;
    UINT16  subsystem_device_id;
    UINT16  num_datablocks;

    UCHAR   physical_packet_type;
    UCHAR   logical_packet_type;

    UINT16  packet_type_param;  // for TRAP type: contains TRAP_ID
                                // for RESP type: contains error code

    // for packet header 2
    UCHAR   packet_data[MAX_MSG_SIZE-SIZE_MESSAGE_FILL_STUFF-SIZE_PACKET_FILL_STUFF];
    UINT16  packet_data_length; // in bytes



    UINT16  packet_tail;

    HANDLE  notifySemaphoreOnReceive; 
} PACKET;
*/



#endif //__DECLARATIONS_H_INCLUDED__

---