GXDN: Gurux Developer Network
GXPacket Class
NamespacesGurux.PacketGXPacket
GXPacket component includes a header, and a data field, of a data packet used in communication. It also includes the methods for modifying those fields. In addition, every packet can be set to have unique settings. For example, a certain single packet can be set to wait a shorter time in sending, than other packets sent by the system. Also, for example, the resend count can vary from packet to another.
Members
All Members Constructors Methods Properties Events



Icon Member Description
GXPacket(ByteOrder)
Initializes a new instance of the GXPacket class

GXPacket()()()
Initializes a new instance of the GXPacket class

AppendData(Object, VariantType)
Appends new data to the data part of the packet.

ByteOrder
Retrieves or sets the used byte order.

Copy(GXPacket, Boolean)
Copies the header, data, and settings, of the GXPacket object.

CountChecksum(Int32, Int32)
Computes the checksum for the contents of the packet.

DataSize
Retrieves or sets the size of the data part.

Dispose(Boolean)
Dispose()()()
Equals(Object)
Determines whether two objects are equal.
(Overrides Object.Equals(Object).)
ExtractData(Object%, VariantType, Int32, Int32)
Extracts the data of the packet into an object.

ExtractHeader(Object%, VariantType, Int32, Int32)
Extracts the header of the packet into an object.

ExtractPacket(Boolean)
Extracts the whole packet; header and data, as a byte array.

Finalize()()() (Overrides Object.Finalize()()().)
GetAvailableLocaleIdentifiers()()()
Retrieves collection of available locale identifiers.

GetBOP(Object%, VariantType%)
Gets the BOP (Beginning of the packet), and the BOP type.

GetChecksum()()()
Retrieves the checksum.

GetChecksumParameters(Int32%, Checksum%, Int32%, Int32%, Int32%, Int32%, Int32%, Int32%, Boolean%, Boolean%)
Gets the current checksum parameters.

GetCompression(Int32%, Int32%)
Returns information of used compression.

GetDataSizeInHeader(Int32%, VariantType%)
This method is reserved for future use, and should not be used.

GetEOP(Object%, VariantType%)
Gets the EOP (End of the packet), and the EOP type.

GetHashCode()()()
Serves as a hash function for a particular type.
(Overrides Object.GetHashCode()()().)
GetOcx()()()
Retrieves a reference to the underlying ActiveX control.

GetSize(PacketParts)
Retrieves the size of the selected packet parts.

GetType()()()
Gets the Type of the current instance.
(Inherited from Object.)
HeaderSize
Retrieves or sets the size of the header part.

Id
Object Identifier.

InsertData(Object, VariantType, Int32, Int32, Int32)
Inserts new data into the packets data part.

InsertHeader(Object, VariantType, Int32, Int32, Int32)
Inserts new data into the packets header part.

LocaleIdentifier
LocaleIdentifier is a 32-bit value that identifies the human language preferred by the user, region, or application. Use GetAvailableLocaleIdentifiers to query language support.

MemberwiseClone()()()
Creates a shallow copy of the current Object.
(Inherited from Object.)
OnCountChecksum
GXPacket component calls this method, when the checksum is counted.

PacketId
Retrieves or sets the ID of the packet.

ParsePacket(Object, Int32%, Int32%)
This method is used to parse packet from given data.

RemoveData(Int32, Int32)
Removes bytes from the data part of the packet.

RemoveHeader(Int32, Int32)
Removes bytes from the header part of the packet.

ReplyDelay
Retrieves the delivery time of the packet.

ResendCount
Retrieves or sets the resend count of the packet.

ResetData()()()
Clears the data part of the packet.

ResetHeader()()()
Clears the header part of the packet.

ResetPacket()()()
Resets the packet component.

SenderInfo
Retrieves or sets the sender information of the packet.

SetBOP(Object, VariantType)
Sets the BOP (Beginning of the packet), and the BOP type.

SetChecksum(Object)
Sets the checksum.

SetChecksumParameters(Int32, Checksum, Int32, Int32, Int32, Int32, Int32, Int32, Boolean, Boolean)
Sets the parameters needed to calculate the checksum. Note: Parameters CRCSize, CRCPolynomial, CRCInitialValue, CRCFinalXOR, CRCReverseData and/or CRCReflection can be used only, when ChkType is Custom (GX_CHK_CUSTOM).

SetCompression(CompressType, Int32, Int32)
Sets information of used compression.

SetDataSizeInHeader(Int32, VariantType)
This method is reserved for future use, and should not be used.

SetEOP(Object, VariantType)
Sets the EOP (End of the packet), and the EOP type.

Status
Retrieves or sets the status of the packet.

ToString()()()
Dumps the packet to a hex string.
(Overrides Object.ToString()()().)
WaitTime
Retrieves or sets waiting time of the packet.

Inheritance Hierarchy
Object
GXPacket

Assembly: Gurux.Client (Module: Gurux.Client) Version: 5.0.0.1