OxYD Socket
Class COxYDSocketHelper

COxYDSocket
   |
   +--COxYDSocketHelper

class COxYDSocketHelper

extends COxYDSocket

m_nLastError

private int m_nLastError;

m_nPacketNumber

public int m_nPacketNumber;

COxYDSocketHelper

public COxYDSocketHelper();

The constructor. Initializes all variables to their default value.

~COxYDSocketHelper

public ~COxYDSocketHelper();

The destructor.

ConvDataToHex

public int ConvDataToHex( LPSTR szData, int nDataLength, CString& strHex );

Convert data to hexa string.

Parameters:

szData - LPSTR : Data

nDataLength - int : Data length

strHex - CString& : Data converted to hexa string

Returns:

int

ConvHexToData

public int ConvHexToData( CString strHex, LPSTR szData, int nDataLengthMax =-1 );

Convert hexa string to data.

Parameters:

strHex - CString : Hexa string

szData - LPSTR : Hexa string converted to data

nDataLengthMax - int : Data buffer length

Returns:

int

Decode

public BOOL Decode( CString strTmp, LPSTR szData, int& nDataLength, int& nMessage, int& nPacketNumber );

Help to decode hexa string with extra parameters to data.

Parameters:

strTmp - CString : Hexa string to decode

szData - LPSTR : Data buffer

nDataLength - int : Data buffer length

nMessage - int : Message number

nPacketNumber - int : Packet number

Returns:

BOOL

Encode

public BOOL Encode( const LPSTR szData, int nDataLength, int nMessage, int nPacketNumber, CString& strPacket );

Help to encode data to hexa string with extra parameters.

Parameters:

szData - const LPSTR : Data to encode

nDataLength - int : Data length

nMessage - int : Message number

nPacketNumber - int : Packet number

strPacket - CString& : Data encoded/converted to hexa string

Returns:

BOOL

FormatMessage

public CString FormatMessage( int nLastError =-1 );

Get last error string from error number.

Parameters:

nLastError - int : Error number (-1 = last error)

Returns:

CString : Last error (string format)

Receive

public BOOL Receive( LPSTR szData, int& nDataLength, int& nMessage, int& nPacketNumber );

Receive hexa string and decode it.

Parameters:

szData - LPSTR : Data

nDataLength - int : Data buffer length

nMessage - int : Message number

nPacketNumber - int : Packet number

Returns:

BOOL

Send

public BOOL Send( const LPSTR szData, int nDataLength =-1, int nMessage =-1, int nPacketNumber =-1 );

Encode data and send it.

Parameters:

szData - const LPSTR : Data to send

nDataLength - int : Data length

nMessage - int : Message number

nPacketNumber - int : Packet number

Returns:

BOOL