ILX::call

Description

Make a call to a method defined within the plugin extension referenced by the handle. Provide the method with the arguments listed in ARGS, do not continue processing the iRule until a response is received. If the node method returns a javascript array or dictionary then a Tcl list object is returned from

Warning

Deprecated in BIG-IP Next v20.0.1

ILX::call
, otherwise a Tcl string object is returned.
The default timeout value is 3000ms. Use the ‘-timeout’ flag to modify this.
Note: Whereas the ILX commands were introduced in 12.0, they were not available until 12.1 without an EA license.

Syntax

ILX::call <ILX handle> [-timeout n] <method> [optional arg]+

n is in milliseconds

Return Value

The return value is the argument passed to response.reply() call on the extension side (eg. an array, a string, etc).

Valid During

ANY_EVENT

Examples

when CLIENT_ACCEPTED {
     # Get a handle to the running extension instance to call into.
     set RPC_HANDLE [ILX::init my_plugin my_extension]
     # Make the call and store the response in $rpc_response
     set rpc_response [ILX::call $RPC_HANDLE my_js_function arg1 arg2]
 }

Change Log

  • Introduced: BIGIP-12.0
  • Deprecated: BIGIP-20.0.1

The BIG-IP API Reference documentation contains community-contributed content. F5 does not monitor or control community code contributions. We make no guarantees or warranties regarding the available code, and it may contain errors, defects, bugs, inaccuracies, or security vulnerabilities. Your access to and use of any code available in the BIG-IP API reference guides is solely at your own risk.