Indy 9 | Content | Index | Reference

TReplyStatus
See Also, Unit: IdIcmpClient
Response to an echo request.

    TReplyStatus = record
      BytesReceived: integer;
      FromIpAddress: string;
      MsgType: byte;
      SequenceId: word;
      MsRoundTripTime: longword;
      TimeToLive: byte;
      ReplyStatusType: TReplyStatusTypes;
      end;

Unit
IdIcmpClient
Members
BytesReceived: integer;
BytesReceived is an Integer value in TReplyStaus used to store the number of bytes received in the response to an echo request. BytesReceived can be 0 to indicate an error condition, or when a time-out occurs prior to receiving a response to an echo request.
FromIpAddress: string;
FromIpAddress is String value in TReplyStatus used to store the IP address received in a Ping response. FromIPAddress identifies the host responding to the ping request.

FromIPAddress can have the value '0.0.0.0' to indicate an error condition, or when a time-out occurs prior to receiving a response to an echo request.

MsgType: byte;
MsgType is a byte value in TReplyStatus that identifies the message type received in response to an echo request. MsgType can have the following values:

0 - net unreachable

1 - host unreachable

2 - protocol unreachable

3 - port unreachable

4 - fragmentation needed

5 - source route failed

MsgType can have the value 0 when a time-out occurs prior to receiving a response to an echo request.

SequenceId: word;
SequenceId is a Word value in TReplyStatus that identifies the sequence identifier of the response to an echo request.

SequenceId can be assigned the internal sequence number of TIdIcmpClient when a time-out occurs prior to receiving a response to an echo request.

MsRoundTripTime: longword;
MsRoundTripTime is a LongWord value in TReplyStatus that indicates the total number of milliseconds required to return the response to the echo request.

MsRoundTripTime is calculated using the originate timestamp in the echo request and the number of milliseconds since midnight on the local computer.

TimeToLive: byte;
TimeToLive is a Byte value in TReplyStatus used to indicate the Time to Live, in seconds, returned in the response to an echo request. TimeToLive is decremented at each machine in which the datagram is processed. TimeToLive is updated when TIdIcmpClient decodes the TIdIcmpClient.ReplyData response to an echo request.
ReplyStatusType: TReplyStatusTypes;
ReplyStatusType is a TReplyStatusType member variable that contains the type of replay decoded in the response to a TIdICMPClient echo request.
Description
TReplyStatus is a record structure used to store the response to an echo request in the Ping method of TIdIcmpClient.

TReplyStatus contains diagnostic information received as a result of the Ping request. TReplyStatus is also provided as a parameter to OnReply event handler in TIdIcmpClient.

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