ST_IotFunctionsRequest

The data type contains detailed information about the underlying request object.

Syntax

(* request Id *)
nRequestId    : ULINT;

(* cycle in which this request was created *)
nCycleCreated : ULINT;

(* time passed since creation (in milliseconds) *)
nAge          : ULINT;

(* time until request expires (timeout) (in milliseconds) *)
nTimeToLive   : ULINT;

(* count of currently pending messages in this request *)
nPendingCount : UDINT;

(* count of currently contained messages in this request *)
nTotalCount   : UINT;

(* indicates if the corresponding internal object has been removed *)
bIsRemoved    : BOOL;

(* indicates if any contained message has timed out *)
bIsTimedOut   : BOOL;

(* indicates if all contained messages have been processed (regardless of success, error or timeout states) *)
bIsCompleted  : BOOL;

Parameter

Name	Type	Description
nRequestId	ULINT	ID of this request.
nCycleCreated	ULINT	Cycle in which this request was created.
nAge	ULINT	Elapsed time since this request was created in milliseconds.
nTimeToLive	ULINT	Remaining time until this request expires in milliseconds.
nPendingCount	UDINT	Number of currently pending messages for this request.
nTotalCount	UINT	Number of all messages contained in this request.
bIsRemoved	BOOL	Indicates whether the internal object of this request has already been removed.
bIsTimedOut	BOOL	Indicates whether any contained message has run into a timeout.
bIsCompleted	BOOL	Indicates whether all contained messages have been processed (regardless of the final processing status).