C# Класс BonCodeAJP13Namespace.BonCodeAJP13Packet

abstract class, Represents the base class for all BonCodeAJP13 Server Packets, don't create an instance of this class directly

Показать файл Открыть проект Примеры использования класса

Защищенные свойства (Protected)

Свойство	Тип	Описание
m_PacketType	byte
m_UserDataLength	System.UInt16

Открытые методы

Метод	Описание
BonCodeAJP13Packet ( ) : System
BonCodeAJP13Packet ( byte Buffer ) : System	Initialize the packet from the buffer, this is the normal case, it sets the essential properties of the packet like type
GetDataBytes ( ) : byte[]	Returns the raw data of the packet in an array of bytes
GetPacket ( byte Buffer ) : BonCodeAJP13Packet	Analyze the provided buffer and returns suitable packet instance
GetPackets ( byte Buffer ) : BonCodeAJP13.BonCodeAJP13PacketCollection	Analyze the provided buffer and returns a collection of packets represented by the buffer
PrintPacket ( ) : string	Returns a string of the packet's properties and their values

Защищенные методы

Метод	Описание
FlipArray ( byte Data ) : byte[]	Flips the array to send it using the big endian convention
GetByte ( byte Data, byte &Value, int Pos ) : int	Get the byte value from the array starting from the position Pos
GetByteArray ( byte Data, byte &Value, int Pos, int ArrayLength ) : int	Get the byte array value from the Data array starting from the position Pos
GetDateTime ( byte Data, System.DateTime &Value, int Pos ) : int	Get the DateTime value from the array starting from the position Pos
GetDouble ( byte Data, double &Value, int Pos ) : int	Get the Double value from the array starting from the position Pos
GetInt16 ( byte Data, Int16 &Value, int Pos ) : int	Get the Int16 value from the array starting from the position Pos
GetInt32 ( byte Data, Int32 &Value, int Pos ) : int	Get the Int32 value from the array starting from the position Pos
GetInt64 ( byte Data, System.Int64 &Value, int Pos ) : int	Get the Int64 value from the array starting from the position Pos
GetString ( byte Data, string &Value, int Pos, int StrLength ) : int	Get the String value from the array starting from the position Pos
GetUInt16 ( byte Data, UInt16 &Value, int Pos ) : int	Get the UInt16 value from the array starting from the position Pos
GetUInt32 ( byte Data, UInt32 &Value, int Pos ) : int	Get the UInt32 value from the array starting from the position Pos
GetUInt64 ( byte Data, System.UInt64 &Value, int Pos ) : int	Get the UInt64 value from the array starting from the position Pos
SetByte ( byte Data, byte Value, int Pos ) : int	Set the byte value in the array starting from the position Pos
SetByteArray ( byte Data, byte Value, int Pos, int ArrayLength ) : int	Set the byte array in the Data array starting from the position Pos
SetDateTime ( byte Data, System.DateTime Value, int Pos ) : int	Set the DateTime value in the array starting from the position Pos
SetDouble ( byte Data, double Value, int Pos ) : int	Set the Double value in the array starting from the position Pos
SetInt16 ( byte Data, Int16 Value, int Pos ) : int	Set the Int16 value in the array starting from the position Pos
SetInt32 ( byte Data, Int32 Value, int Pos ) : int	Set the Int32 value in the array starting from the position Pos
SetInt64 ( byte Data, System.Int64 Value, int Pos ) : int	Set the Int64 value in the array starting from the position Pos
SetString ( byte Data, string Value, int Pos, int StrLength ) : int	Set the String value in the array starting from the position Pos String will be transmitted prefixed by length in bytes and terminated by zero byte
SetUInt16 ( byte Data, UInt16 Value, int Pos ) : int	Set the UInt16 value in the array starting from the position Pos
SetUInt32 ( byte Data, UInt32 Value, int Pos ) : int	Set the UInt32 value in the array starting from the position Pos
SetUInt64 ( byte Data, System.UInt64 Value, int Pos ) : int	Set the UInt64 value in the array starting from the position Pos
WriteBonCodeAJP13Header ( byte Data ) : int	Initialize the packet's header in the raw data.

Описание методов

BonCodeAJP13Packet() публичный метод

public BonCodeAJP13Packet ( ) : System
Результат	System

BonCodeAJP13Packet() публичный метод

Initialize the packet from the buffer, this is the normal case, it sets the essential properties of the packet like type

public BonCodeAJP13Packet ( byte Buffer ) : System
Buffer	byte
Результат	System

FlipArray() защищенный статический метод

Flips the array to send it using the big endian convention

protected static FlipArray ( byte Data ) : byte[]
Data	byte
Результат	byte[]

GetByte() защищенный статический метод

Get the byte value from the array starting from the position Pos

protected static GetByte ( byte Data, byte &Value, int Pos ) : int
Data	byte
Value	byte
Pos	int
Результат	int

GetByteArray() защищенный статический метод

Get the byte array value from the Data array starting from the position Pos

protected static GetByteArray ( byte Data, byte &Value, int Pos, int ArrayLength ) : int
Data	byte
Value	byte
Pos	int
ArrayLength	int
Результат	int

GetDataBytes() публичный абстрактный метод

Returns the raw data of the packet in an array of bytes

public abstract GetDataBytes ( ) : byte[]
Результат	byte[]

GetDateTime() защищенный статический метод

Get the DateTime value from the array starting from the position Pos

protected static GetDateTime ( byte Data, System.DateTime &Value, int Pos ) : int
Data	byte
Value	System.DateTime
Pos	int
Результат	int

GetDouble() защищенный статический метод

Get the Double value from the array starting from the position Pos

protected static GetDouble ( byte Data, double &Value, int Pos ) : int
Data	byte
Value	double
Pos	int
Результат	int

GetInt16() защищенный статический метод

Get the Int16 value from the array starting from the position Pos

protected static GetInt16 ( byte Data, Int16 &Value, int Pos ) : int
Data	byte
Value	System.Int16
Pos	int
Результат	int

GetInt32() защищенный статический метод

Get the Int32 value from the array starting from the position Pos

protected static GetInt32 ( byte Data, Int32 &Value, int Pos ) : int
Data	byte
Value	System.Int32
Pos	int
Результат	int

GetInt64() защищенный статический метод

Get the Int64 value from the array starting from the position Pos

protected static GetInt64 ( byte Data, System.Int64 &Value, int Pos ) : int
Data	byte
Value	System.Int64
Pos	int
Результат	int

GetPacket() публичный статический метод

Analyze the provided buffer and returns suitable packet instance

public static GetPacket ( byte Buffer ) : BonCodeAJP13Packet
Buffer	byte
Результат	BonCodeAJP13Packet

GetPackets() публичный статический метод

Analyze the provided buffer and returns a collection of packets represented by the buffer

public static GetPackets ( byte Buffer ) : BonCodeAJP13.BonCodeAJP13PacketCollection
Buffer	byte
Результат	BonCodeAJP13.BonCodeAJP13PacketCollection

GetString() защищенный статический метод

Get the String value from the array starting from the position Pos

protected static GetString ( byte Data, string &Value, int Pos, int StrLength ) : int
Data	byte
Value	string
Pos	int
StrLength	int
Результат	int

GetUInt16() защищенный статический метод

Get the UInt16 value from the array starting from the position Pos

protected static GetUInt16 ( byte Data, UInt16 &Value, int Pos ) : int
Data	byte
Value	System.UInt16
Pos	int
Результат	int

GetUInt32() защищенный статический метод

Get the UInt32 value from the array starting from the position Pos

protected static GetUInt32 ( byte Data, UInt32 &Value, int Pos ) : int
Data	byte
Value	System.UInt32
Pos	int
Результат	int

GetUInt64() защищенный статический метод

Get the UInt64 value from the array starting from the position Pos

protected static GetUInt64 ( byte Data, System.UInt64 &Value, int Pos ) : int
Data	byte
Value	System.UInt64
Pos	int
Результат	int

PrintPacket() публичный метод

Returns a string of the packet's properties and their values

public PrintPacket ( ) : string
Результат	string

SetByte() защищенный статический метод

Set the byte value in the array starting from the position Pos

protected static SetByte ( byte Data, byte Value, int Pos ) : int
Data	byte
Value	byte
Pos	int
Результат	int

SetByteArray() защищенный статический метод

Set the byte array in the Data array starting from the position Pos

protected static SetByteArray ( byte Data, byte Value, int Pos, int ArrayLength ) : int
Data	byte
Value	byte
Pos	int
ArrayLength	int
Результат	int

SetDateTime() защищенный статический метод

Set the DateTime value in the array starting from the position Pos

protected static SetDateTime ( byte Data, System.DateTime Value, int Pos ) : int
Data	byte
Value	System.DateTime
Pos	int
Результат	int

SetDouble() защищенный статический метод

Set the Double value in the array starting from the position Pos

protected static SetDouble ( byte Data, double Value, int Pos ) : int
Data	byte
Value	double
Pos	int
Результат	int

SetInt16() защищенный статический метод

Set the Int16 value in the array starting from the position Pos

protected static SetInt16 ( byte Data, Int16 Value, int Pos ) : int
Data	byte
Value	System.Int16
Pos	int
Результат	int

SetInt32() защищенный статический метод

Set the Int32 value in the array starting from the position Pos

protected static SetInt32 ( byte Data, Int32 Value, int Pos ) : int
Data	byte
Value	System.Int32
Pos	int
Результат	int

SetInt64() защищенный статический метод

Set the Int64 value in the array starting from the position Pos

protected static SetInt64 ( byte Data, System.Int64 Value, int Pos ) : int
Data	byte
Value	System.Int64
Pos	int
Результат	int

SetString() защищенный статический метод

Set the String value in the array starting from the position Pos String will be transmitted prefixed by length in bytes and terminated by zero byte

protected static SetString ( byte Data, string Value, int Pos, int StrLength ) : int
Data	byte
Value	string
Pos	int
StrLength	int
Результат	int

SetUInt16() защищенный статический метод

Set the UInt16 value in the array starting from the position Pos

protected static SetUInt16 ( byte Data, UInt16 Value, int Pos ) : int
Data	byte
Value	System.UInt16
Pos	int
Результат	int

SetUInt32() защищенный статический метод

Set the UInt32 value in the array starting from the position Pos

protected static SetUInt32 ( byte Data, UInt32 Value, int Pos ) : int
Data	byte
Value	System.UInt32
Pos	int
Результат	int

SetUInt64() защищенный статический метод

Set the UInt64 value in the array starting from the position Pos

protected static SetUInt64 ( byte Data, System.UInt64 Value, int Pos ) : int
Data	byte
Value	System.UInt64
Pos	int
Результат	int

WriteBonCodeAJP13Header() защищенный метод

Initialize the packet's header in the raw data.

protected WriteBonCodeAJP13Header ( byte Data ) : int
Data	byte
Результат	int

Описание свойств

m_PacketType защищенное свойство

protected byte m_PacketType
Результат	byte

m_UserDataLength защищенное свойство

protected UInt16,System m_UserDataLength
Результат	System.UInt16