C# Class ArtemisComm.Packet

Inheritance: IDisposable

Datei anzeigen Open project: russjudge/ArtemisSBS-ProtocolSharp Class Usage Examples

Private Properties

Property	Type	Description
BuildPackage	IPackage
FormatIt	string
GetLength	int
GetPackage	IPackage
GetRawData	System.IO.MemoryStream
SetOrigin	void
SetRawData	void

Public Methods

Method	Description
Dispose ( ) : void
OverrideSetOrigin ( OriginType origin ) : void	sets the origin. Origin is normally not accessible since it can be deduced from the Packet type. However, this allows setting the origin for reverse-engineering the protocol AND for future-compatibility: if a new packet is built into a later version of Artemis, this library might not need updated to continue to support it.
OverrideSetPacketType ( PacketType packetType ) : void
OverrideSetPacketType ( int packetType ) : void
Packet ( IPackage package ) : System
Packet ( Stream stream ) : System

Protected Methods

Method	Description
Dispose ( bool isDisposing ) : void

Private Methods

Method	Description
BuildPackage ( MemoryStream stream, int index, Type packageType ) : IPackage
FormatIt ( byte buffer ) : string
GetLength ( byte byteArray, int startIndex ) : int
GetPackage ( MemoryStream stream, int index, Type packageType ) : IPackage
GetRawData ( ) : MemoryStream
SetOrigin ( ) : void	Sets the origin. Origin is not set if the Packet type is not among the defined list--this is to assume that it is working with a newer version of Artemis than originally written for.
SetRawData ( ) : void

Method Details

Dispose() public method

public Dispose ( ) : void
return	void

Dispose() protected method

protected Dispose ( bool isDisposing ) : void
isDisposing	bool
return	void

OverrideSetOrigin() public method

sets the origin. Origin is normally not accessible since it can be deduced from the Packet type. However, this allows setting the origin for reverse-engineering the protocol AND for future-compatibility: if a new packet is built into a later version of Artemis, this library might not need updated to continue to support it.

public OverrideSetOrigin ( OriginType origin ) : void
origin	OriginType	The origin.
return	void

OverrideSetPacketType() public method

public OverrideSetPacketType ( PacketType packetType ) : void
packetType	PacketType
return	void

OverrideSetPacketType() public method

public OverrideSetPacketType ( int packetType ) : void
packetType	int
return	void

Packet() public method

public Packet ( IPackage package ) : System
package	IPackage
return	System

Packet() public method

public Packet ( Stream stream ) : System
stream	Stream
return	System