Indy 9 | Content | Index | Reference

TReceiver
Hierarchy, Properties, Methods, See Also, Unit: IdTunnelCommon
Implements encapsulated tunnel message receipt and processing.

    TReceiver = class(TObject)

Unit
IdTunnelCommon
Description
TReceiver is a class that implements for receipt and processing of encapsulated tunnel messages for Indy Tunnel components. TIdTunnelMaster uses TReceiver to handle message types and data from tunnel client connections.

TReceiver.CRCFailed
TReceiver
Indicates an error in the CRC value for a message.

    property CRCFailed: Boolean;

Description
CRCFailed is a read-only Boolean property that indicates when the CRC checksum value for a tunnel message does not match the calculated CRC checksum value on receipt.

TReceiver.Data
TReceiver
Represents data for the encapsulated tunnel message.

    property Data: String;

Description
Data is a String property that represents the contents of an encapsulated Tunnel message. Changing the value in Data results in updating the pBuffer message buffer including recalculation of the CRC value and detecting the message type.

TReceiver.NewMessage
TReceiver
Indicates a change to the Data for the message.

    property NewMessage: Boolean;

Description
NewMessage is a read-only Boolean property that indicates when the message or header has been updated as a result of changes to Data.

TReceiver.Create
TReceiver
Constructor for the object instance.

    constructor Create;

Parameters
AOwner
Owner of the object instance.
Description
Create is the constructor for the object instance, and relies on the inherited Create method. Create also initializes object properties for the CRC calculator, HeaderLen, and MsgLen used by the object. Create allocates the buffers used for pBuffer and Msg.

TReceiver.Destroy
TReceiver
Free the object instance.

    destructor Destroy; override;

Description
Destroy is the destructor for the object instance. Destroy frees pBuffer and Msg, as well as the CRC calculator for the object instance prior to calling the inherited Destroy method.

TReceiver.ShiftData
TReceiver
Handles multiple messages in the message buffer.

    procedure ShiftData;

Description
ShiftData is a procedure used to access, align, and calculate CRC values for multiple messages in pBuffer.

Created with Doc-O-Matic 2 donated to Project JEDI. Commercial license available from the Doc-O-Matic site.