PGE API 0.4
PR00F's Game Engine full documentation
Loading...
Searching...
No Matches
List of all members | Public Types | Static Public Member Functions | Static Public Attributes | Static Private Member Functions | Private Attributes | Friends
pge_network::MsgApp Struct Reference

Detailed Description

Definition at line 125 of file PgePacket.h.

#include <PgePacket.h>

Public Types

typedef uint32_t TMsgId
 
typedef uint8_t TMsgSize
 

Static Public Member Functions

static const TMsgId & getMsgAppMsgId (const MsgApp &msgApp)
 
static const TMsgSize & getMsgAppDataActualSizeBytes (const MsgApp &msgApp)
 
static const TMsgSize getMsgAppTotalActualSizeBytes (const MsgApp &msgApp)
 
static const TByte * getMsgAppData (const MsgApp &msgApp)
 
static TByte * getMsgAppData (MsgApp &msgApp)
 
static bool fillMsgApp (MsgApp &myAppMsg, const TMsgId &msgAppMsgId, const TByte *msgAppData, TMsgSize nMsgAppDataSize)
 

Static Public Attributes

static const PgePktId id = PgePktId::Application
 
static const TMsgSize nMaxMessageLengthBytes = 240
 

Static Private Member Functions

static TMsgId & getMsgAppMsgId (MsgApp &msgApp)
 
static TMsgSize & getMsgAppDataActualSizeBytes (MsgApp &msgApp)
 

Private Attributes

TMsgId m_msgId
 
TMsgSize m_nMsgSize
 
TByte m_cMsgData [nMaxMessageLengthBytes]
 

Friends

class PgePacketTest
 
struct PgePacket
 

Member Typedef Documentation

◆ TMsgId

uint32_t pge_network::MsgApp::TMsgId

Definition at line 131 of file PgePacket.h.

◆ TMsgSize

uint8_t pge_network::MsgApp::TMsgSize

Definition at line 132 of file PgePacket.h.

Member Function Documentation

◆ fillMsgApp()

bool pge_network::MsgApp::fillMsgApp ( pge_network::MsgApp & myAppMsg,
const TMsgId & msgAppMsgId,
const TByte * msgAppData,
MsgApp::TMsgSize nMsgAppDataSize )
static

Definition at line 349 of file PgePacket.cpp.

◆ getMsgAppData() [1/2]

const TByte * pge_network::MsgApp::getMsgAppData ( const MsgApp & msgApp)
static

Definition at line 339 of file PgePacket.cpp.

◆ getMsgAppData() [2/2]

TByte * pge_network::MsgApp::getMsgAppData ( MsgApp & msgApp)
static

Definition at line 344 of file PgePacket.cpp.

◆ getMsgAppDataActualSizeBytes() [1/2]

const MsgApp::TMsgSize & pge_network::MsgApp::getMsgAppDataActualSizeBytes ( const MsgApp & msgApp)
static

Definition at line 329 of file PgePacket.cpp.

◆ getMsgAppDataActualSizeBytes() [2/2]

MsgApp::TMsgSize & pge_network::MsgApp::getMsgAppDataActualSizeBytes ( MsgApp & msgApp)
staticprivate

Definition at line 324 of file PgePacket.cpp.

◆ getMsgAppMsgId() [1/2]

const MsgApp::TMsgId & pge_network::MsgApp::getMsgAppMsgId ( const MsgApp & msgApp)
static

Definition at line 314 of file PgePacket.cpp.

◆ getMsgAppMsgId() [2/2]

MsgApp::TMsgId & pge_network::MsgApp::getMsgAppMsgId ( MsgApp & msgApp)
staticprivate

Definition at line 319 of file PgePacket.cpp.

◆ getMsgAppTotalActualSizeBytes()

const MsgApp::TMsgSize pge_network::MsgApp::getMsgAppTotalActualSizeBytes ( const MsgApp & msgApp)
static

Definition at line 334 of file PgePacket.cpp.

Friends And Related Symbol Documentation

◆ PgePacket

friend struct PgePacket
friend

Definition at line 128 of file PgePacket.h.

◆ PgePacketTest

friend class PgePacketTest
friend

Definition at line 127 of file PgePacket.h.

Member Data Documentation

◆ id

const PgePktId pge_network::MsgApp::id = PgePktId::Application
static

Definition at line 134 of file PgePacket.h.

◆ m_cMsgData

TByte pge_network::MsgApp::m_cMsgData[nMaxMessageLengthBytes]
private

Definition at line 158 of file PgePacket.h.

◆ m_msgId

TMsgId pge_network::MsgApp::m_msgId
private

Definition at line 149 of file PgePacket.h.

◆ m_nMsgSize

TMsgSize pge_network::MsgApp::m_nMsgSize
private

Definition at line 150 of file PgePacket.h.

◆ nMaxMessageLengthBytes

const TMsgSize pge_network::MsgApp::nMaxMessageLengthBytes = 240
static

Definition at line 135 of file PgePacket.h.

The documentation for this struct was generated from the following files: