XFcCommunicationConstants.h File Reference

Main Page Class Hierarchy Alphabetical List Compound List File List Compound Members File Members

# XFcCommunicationConstants.h File Reference

This graph shows which files directly or indirectly include this file:

## Compounds

struct | CommunicationHeader

## Defines

#define | XFCNET_LOCALTIMELIMIT 10000
#define | XFCNET_HOSTCONNECTIONTIMELIMIT 50000
#define | XFCNET_HOSTREPLYTIMELIMIT 5000
#define | XFCNET_MAXBUFFERSIZE 0x000005aa
#define | XFCNET_LISTENBUFFERSIZE 1500
#define | XFCNET_MAGICSEQNUM 123
#define | XFCNET_NO_SEQ_NUM 0xffffffff
#define | XFCNET_DEFAULT_HEADER_SIZE 9
| default protocol header size
#define | XFCNET_DEFAULT_QUEUE_SIZE 150
| default client queue size
#define | XFCNET_UDP_HEADER_SIZE 28
| default udp header size
#define | XFCNET_COMMINUCATION_DEFAULT_PRIORITY 1000
#define | XFCNET_PACKETQUEUE_DEFAULT_SIZE 150
#define | XFCNET_DEFAULT_CLIENT_COUNT 10
#define | XFCNET_INADDR_ANY (UINT32)0x00000000
#define | XFCNET_ERROR -1
| Basic error argument.
#define | XFCNET_NOT_SUPPORTED -2
| Not supported error.

## Enumerations

enum

XFCNET_MESSAGE_SLOT {
XFCNET_NONGUARANTEED,
XFCNET_GUARANTEED,
XFCNET_RECENTSTATE,
XFCNET_QUICKGUARANTEED,
XFCNET_NOSLOT
}

enum | XFCNET_PACKET_PRIORITY { XFCNET_HIGH_PRIORITY = 0x00000032, XFCNET_LOW_PRIORITY = 0x00000064, XFCNET_NO_PRIORITY = 0x000003e8 }

enum

XFCNET_OBJECTQUEUE_STATUS {
XFCNET_QUEUE_ADD_OK = 0x00000000,
XFCNET_QUEUE_ADD_FAILD = 0x00000001,
XFCNET_QUEUE_EMPTY = 0x00000002,
XFCNET_QUEUE_NOT_EMPTY = 0x00000004,
XFCNET_QUEUE_FULL = 0x00000008,
XFCNET_QUEUE_NOT_FULL = 0x00000010,
XFCNET_QUEUE_UNKNOWN_PACKET = 0x00000020,
XFCNET_QUEUE_ALL_FLAGS = 0xffffffff
}

enum | XFCNET_PACKET_STATUS { XFCNET_ALONE, XFCNET_MULTI, XFCNET_AUTO }
| Packet handling type. More...
enum | XFCNET_SCHEDULER_ERROR { XFCNET_SCHEDULER_RUN = -1, XFCNET_CLIENTADD_ERROR = -2, XFCNET_COMMHANDLERADD_ERROR = -3 }
enum | XFCNET_INET_VALUE { XFCNET_UNKNOWN_CLIENT = -1 }
enum | XFCNET_CONNECTIONTYPE { XFCNET_CONNECTIONTYPE_INET = 1, XFCNET_CONNECTIONTYPE_IRDA = 2, XFCNET_CONNECTIONTYPE_BLUETOOTH = 3 }
| Connection types. More...
enum | XFCNET_CLIENT_ACTIVE { XFCNET_CLIENT_ACTIVE = 1, XFCNET_CLIENT_NOTACTIVE = -2, XFCNET_CLIENT_ACTIVE_ERROR = -3 }

## Detailed Description

X-Forge Core
Copyright 2000-2003 Fathammer Ltd

Id
  XFcCommunicationConstants.h,v 1.9 2003/09/05 07:42:26 slehti Exp

Date
  2003/09/05 07:42:26

Revision
  1.9

## Define Documentation

#define XFCNET_COMMINUCATION_DEFAULT_PRIORITY 1000

#define XFCNET_DEFAULT_CLIENT_COUNT 10

#define XFCNET_DEFAULT_HEADER_SIZE 9

| default protocol header size

#define XFCNET_DEFAULT_QUEUE_SIZE 150

| default client queue size

#define XFCNET_ERROR -1

| Basic error argument.

#define XFCNET_HOSTCONNECTIONTIMELIMIT 50000

#define XFCNET_HOSTREPLYTIMELIMIT 5000

#define XFCNET_INADDR_ANY (UINT32)0x00000000

#define XFCNET_LISTENBUFFERSIZE 1500

#define XFCNET_LOCALTIMELIMIT 10000

#define XFCNET_MAGICSEQNUM 123

#define XFCNET_MAXBUFFERSIZE 0x000005aa

#define XFCNET_NO_SEQ_NUM 0xffffffff

#define XFCNET_NOT_SUPPORTED -2

| Not supported error.

#define XFCNET_PACKETQUEUE_DEFAULT_SIZE 150

#define XFCNET_UDP_HEADER_SIZE 28

| default udp header size

## Enumeration Type Documentation

enum XFCNET_CLIENT_ACTIVE

Enumeration values:

  XFCNET_CLIENT_ACTIVE | Client is active.
  XFCNET_CLIENT_NOTACTIVE | Client is not active.
  XFCNET_CLIENT_ACTIVE_ERROR | Client activity check failed.

enum XFCNET_CONNECTIONTYPE

Connection types.

Enumeration values:

  XFCNET_CONNECTIONTYPE_INET | Connection type is inet.
  XFCNET_CONNECTIONTYPE_IRDA |
  XFCNET_CONNECTIONTYPE_BLUETOOTH | Connection type is bluetooth.

enum XFCNET_INET_VALUE

Enumeration values:

  XFCNET_UNKNOWN_CLIENT | Client is unrecognized.

enum XFCNET_MESSAGE_SLOT

Enumeration values:

  XFCNET_NONGUARANTEED |
  XFCNET_GUARANTEED |
  XFCNET_RECENTSTATE |
  XFCNET_QUICKGUARANTEED |
  XFCNET_NOSLOT |

enum XFCNET_OBJECTQUEUE_STATUS

Enumeration values:

  XFCNET_QUEUE_ADD_OK |
  XFCNET_QUEUE_ADD_FAILD |
  XFCNET_QUEUE_EMPTY |
  XFCNET_QUEUE_NOT_EMPTY |
  XFCNET_QUEUE_FULL |
  XFCNET_QUEUE_NOT_FULL |
  XFCNET_QUEUE_UNKNOWN_PACKET |
  XFCNET_QUEUE_ALL_FLAGS |

enum XFCNET_PACKET_PRIORITY

Enumeration values:

  XFCNET_HIGH_PRIORITY |
  XFCNET_LOW_PRIORITY |
  XFCNET_NO_PRIORITY |

enum XFCNET_PACKET_STATUS

Packet handling type.

Enumeration values:

  XFCNET_ALONE | Packets are send alone, one frame/sent packet.
  XFCNET_MULTI | Packets are send on chunks, multiple frames/sent packet.
  XFCNET_AUTO | Engine decides how to send packets.

enum XFCNET_SCHEDULER_ERROR

Enumeration values:

  XFCNET_SCHEDULER_RUN |
  XFCNET_CLIENTADD_ERROR |
  XFCNET_COMMHANDLERADD_ERROR |

|  | X-Forge Documentation Confidential Copyright © 2002-2003 Fathammer |  | Documentation generated with doxygen by Dimitri van Heesch