CHANGEIDENTIFIERTIMEOUT function

The CHANGEIDENTIFIERTIMEOUT function changes the timeout value associated with the reply identifier of a SOAPInput node or the request identifier of an HTTPInput node. The function returns a Boolean value to indicate the success or otherwise of the change.

Syntax

Read syntax diagramSkip visual syntax diagramCHANGEIDENTIFIERTIMEOUT( IdentifierExpression, TimeoutExpression )

The function returns TRUE if the given identifier is valid and the timeout was adjusted to the new value without the new value causing the identifier to timeout. It returns FALSE if the identifier passed to the function is invalid or, after the timeout adjustment, the identifier has expired. Note that if the function is passed an identifier that has already expired, the function always return FALSE. Note that for HTTPInput nodes, the function only processes identifiers that are associated with the embedded integration server listener.

The IdentifierExpression parameter is a BLOB expression that must resolve to a valid reply identifier (for a SOAPInput node) or request identifier (for an HTTPInput node). An identifier is unique to an individual message, therefore only the message associated with the identifier will be affected by this function.

The TimeoutExpression parameter is an INTEGER expression that represents a certain number of seconds to be added to or subtracted from the identifier's timeout value. Specifying a positive value will cause the timeout to be increased by the chosen amount, whilst specifying a negative value will cause the timeout to be decreased by the chosen amount. Passing a value of 0 allows an identifier to be tested for validity without changing it, because FALSE is returned if the identifier is invalid or has expired, whereas TRUE is returned if the identifier is valid and has not timed out.

If either parameter is NULL, the result is NULL.

Examples

The following example shows how to reduce the timeout of the specified SOAP reply identifier by 5 seconds. It returns TRUE if the identifier is valid and has not expired after changing the timeout duration:
ChangeIdentifierTimeout(
  LocalEnvironment.Destination.SOAP.Reply.ReplyIdentifier, -5);
The following example shows how to increase the timeout on the specified identifier by 30 seconds. It returns TRUE if the identifier is valid and has not expired after changing the timeout duration:
ChangeIdentifierTimeout(myReplyIdentifier, 30);