Classes | Typedefs | Enumerations | Enumerator | Variables

AESOP Base Types
[AESOP Core Libraries]


These headers define the core types and enums used in AESOP. More...

Collaboration diagram for AESOP Base Types:

Classes

class  aesop::AESOPIdSizer
class  aesop::AESOPTagSizer

Typedefs

typedef FixedBuffer
< AESOPIdSizer,
CommonFileValidator
aesop::AESOPIdBuffer
 smart object to hold and validate aesop ID strings
typedef FixedBuffer
< AESOPTagSizer,
CommonFileValidator
aesop::AESOPTagBuffer
 smart object to hold and validate aesop tag strings

Enumerations

enum  aesop::eConstants {
  aesop::eAESOP_MaxIdLength = 31,
  aesop::eAESOP_IdBufferSize = 32,
  aesop::eAESOP_MaxTagLength = 15,
  aesop::eAESOP_TagBufferSize = 16,
  aesop::eAESOP_Invalid = 0
}
 

important aesop constants

More...
enum  aesop::eProtocol {
  aesop::eProtocol_Major = 0,
  aesop::eProtocol_Minor = 1,
  aesop::eProtocol_Long = (eProtocol_Major << 16) + eProtocol_Minor
}
 

protocol version (basically, the version of the aesop-core.h file!)

More...
enum  aesop::eServerMode {
  aesop::eServerMode_Idle = 1,
  aesop::eServerMode_Game = 2,
  aesop::eServerMode_Invalid = 0
}
 

server's status

More...
enum  aesop::eHostMode {
  aesop::eHostMode_Connected = 1,
  aesop::eHostMode_Authorized = 2,
  aesop::eHostMode_Invalid = 0
}
 

server's view of host status

More...
enum  aesop::ePlayerMode {
  aesop::ePlayerMode_UnAuth = 1,
  aesop::ePlayerMode_Browse = 2,
  aesop::ePlayerMode_Game = 3,
  aesop::ePlayerMode_Invalid = 0
}
 

server's view of player status

More...

Variables

char aesop::AESOPIdSizer::buffer [eAESOP_IdBufferSize]
char aesop::AESOPTagSizer::buffer [eAESOP_TagBufferSize]

Detailed Description


These headers define the core types and enums used in AESOP.


Typedef Documentation

smart object to hold and validate aesop ID strings

Definition at line 139 of file aesop-base.h.

smart object to hold and validate aesop tag strings

Definition at line 142 of file aesop-base.h.


Enumeration Type Documentation

important aesop constants

Enumerator:
eAESOP_MaxIdLength 

max length of an ID, without null-term

eAESOP_IdBufferSize 

size of buffer to hold ID + null-term

eAESOP_MaxTagLength 

max length of a tag string

eAESOP_TagBufferSize 

buffer holds tag string + null-term

eAESOP_Invalid 

Definition at line 57 of file aesop-base.h.

protocol version (basically, the version of the aesop-core.h file!)

Enumerator:
eProtocol_Major 

non-backwards-compatible

eProtocol_Minor 

backwards-compatible

eProtocol_Long 

Definition at line 75 of file aesop-base.h.

server's status

Enumerator:
eServerMode_Idle 

server is running, no game

eServerMode_Game 

game is in session

eServerMode_Invalid 

Definition at line 85 of file aesop-base.h.

server's view of host status

Enumerator:
eHostMode_Connected 

server has token, provided keys

eHostMode_Authorized 

connected and authorized

eHostMode_Invalid 

Definition at line 96 of file aesop-base.h.

server's view of player status

Enumerator:
ePlayerMode_UnAuth 

player is not authorized

ePlayerMode_Browse 

authorized, not in game

ePlayerMode_Game 

player is in game

ePlayerMode_Invalid 

Definition at line 107 of file aesop-base.h.


Variable Documentation

char aesop::AESOPIdSizer::buffer[eAESOP_IdBufferSize] [inherited]

Definition at line 124 of file aesop-base.h.

char aesop::AESOPTagSizer::buffer[eAESOP_TagBufferSize] [inherited]

Definition at line 133 of file aesop-base.h.