Sign in Join
FPDoc Onlineexperiment

TIPCClient.PeekResponse function

Member of TIPCClientpublicIn unit AdvancedIPC

Retrieve response from server for a request

Declaration

pascal
function PeekResponse(const aStream: TStream; 
 out outMsgType: TMessageType): Boolean; overload
function PeekResponse(const aStream: TStream; 
 out outMsgType: TMessageType; 
 const aTimeOut: Integer): Boolean; overload
function PeekResponse(const aRequestID: Integer; 
 const aStream: TStream; 
 out outMsgType: TMessageType): Boolean; overload
function PeekResponse(const aRequestID: Integer; 
 const aStream: TStream; 
 out outMsgType: TMessageType; 
 const aTimeOut: Integer): Boolean; overload

Arguments

aStream

Stream to receive response data

outMsgType

Returns the response message type

aTimeOut

Timeout in milliseconds

aRequestID

Request ID to retrieve response for

Function result

True if response was available

Description

The PeekResponse function retrieves the server response for a previously sent request. Multiple overloads support immediate checking or waiting with timeout. Can retrieve response for specific request ID or the last request from this client.

See also

An experiment, built from development snapshots. Not the official Free Pascal or Lazarus documentation.