Sign in Join
FPDoc Onlineexperiment

TIPCServer.PeekRequest function

Member of TIPCServerpublicIn unit AdvancedIPC

Peek at incoming requests from clients

Declaration

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

Arguments

aStream

Stream to receive request data

outMsgType

Returns the request message type

outRequestID

Returns the request ID

aTimeOut

Timeout in milliseconds

Function result

True if request was available

Description

The PeekRequest function retrieves incoming requests from clients. Multiple overloads support immediate checking or waiting with timeout. Some overloads read the message content directly, others only peek and require ReadRequest to get the content.

See also

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