Gray C++ Libraries  0.0.2
A set of C++ libraries for MSVC, GNU on Windows, WinCE, Linux
GrayLib::cXProtocolBase Class Referenceabstract

#include <cXProtocol.h>

Inheritance diagram for GrayLib::cXProtocolBase:
GrayLib::cXProtocolClient GrayLib::cXProtocolServerStream GrayLib::cXProtocolServerStreamImpl

Public Member Functions

 cXProtocolBase (cXProtocolDataMgr *pProtocolDataMgr)
 
virtual ~cXProtocolBase ()
 
cXProtocolDataMgrget_DataMgr () const
 
virtual bool isClientSide () const =0
 
 STDMETHOD_ (cString, get_Name)() const =0
 
 STDMETHOD_ (PLEVEL_TYPE, get_PrivLevel)() const =0
 

Static Public Member Functions

static cStringA GRAYCALL GetMsgName (XPROTO_t bMsg)
 

Public Attributes

cXProtocolDataMgr *const m_pProtocolDataMgr
 Point back to the protocol singleton. More...
 
bool m_bUseHashPropName
 for stuff i send, should i hash the prop names ? XPROTO_HashProp More...
 
cFile m_FileWork
 The local file we are reading or writing for XPROTO_File. More...
 

Static Public Attributes

static const size_t k_Packet_Size_Max = cStream::k_FILE_BLOCK_SIZE + 16
 

Detailed Description

State info for the connection (both RX and TX). Abstract Base for both cXProtocolClient or cXProtocolServer tracking a single connection.

Note
Authentication and encryption are outside the scope of this class. Use cSecureChannel.

Constructor & Destructor Documentation

◆ cXProtocolBase()

GrayLib::cXProtocolBase::cXProtocolBase ( cXProtocolDataMgr pProtocolDataMgr)

◆ ~cXProtocolBase()

GrayLib::cXProtocolBase::~cXProtocolBase ( )
virtual

Member Function Documentation

◆ get_DataMgr()

cXProtocolDataMgr* GrayLib::cXProtocolBase::get_DataMgr ( ) const
inline

◆ GetMsgName()

cStringA GrayLib::cXProtocolBase::GetMsgName ( XPROTO_t  bMsg)
static

◆ isClientSide()

virtual bool GrayLib::cXProtocolBase::isClientSide ( ) const
pure virtual

◆ STDMETHOD_() [1/2]

GrayLib::cXProtocolBase::STDMETHOD_ ( cString  ,
get_Name   
) const
pure virtual

◆ STDMETHOD_() [2/2]

GrayLib::cXProtocolBase::STDMETHOD_ ( PLEVEL_TYPE  ,
get_PrivLevel   
) const
pure virtual

Member Data Documentation

◆ k_Packet_Size_Max

const size_t GrayLib::cXProtocolBase::k_Packet_Size_Max = cStream::k_FILE_BLOCK_SIZE + 16
static

◆ m_bUseHashPropName

bool GrayLib::cXProtocolBase::m_bUseHashPropName

for stuff i send, should i hash the prop names ? XPROTO_HashProp

◆ m_FileWork

cFile GrayLib::cXProtocolBase::m_FileWork

The local file we are reading or writing for XPROTO_File.

◆ m_pProtocolDataMgr

cXProtocolDataMgr* const GrayLib::cXProtocolBase::m_pProtocolDataMgr

Point back to the protocol singleton.


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