Salesforce

RqRtInf (Magic xpa 3.x)

« Go Back

Information

 
Created ByKnowledge Migration User
Approval Process StatusPublished
Objective
Description

RqRtInf (Magic xpa 3.x)

Gives information about a specific enterprise server associated with a broker.

Syntax:

RqRtInf(service/server name, runtime engine number)

Parameters:

service/server name: An Alpha variable or constant with a server or service name.

runtime engine number: Numeric value indicating the internal number of the Runtime engine, within all Runtime engines associated with the RqRts list (the RqRts must be called before).

Returns:

String with the following comma-delimited information:

Host name – The host where the Runtime engine is activated.

Port number – The port that the Runtime engine is monitoring.

Dotted address – In the form of nnn.nnn.nnn.nnn

Process ID – The process ID of the Runtime engine in the host.

Status – A numeric value indicating the following:

1 – Available for the current request type

3 – Unavailable for the current request type

4 – In Studio mode

5 – Unresponsive

8 – Unreachable (A Magic xpa server could not be connected, either since it is aborting or due to network problems.)

9 – License limit reached (A Magic xpa server executed with DeploymentMode=R that was restricted to a predefined number of requests has reached the limit and cannot serve subsequent requests.)

14 – Shutting down

15 – Waiting (as a client, waiting to get control, such as while performing a remote call or a call dll)

16 – Blocked (all requests to the engine are blocked)

17 – Externally blocked (only external requests are blocked - requests from the engine to itself are allowed)

Open Application: The name of the opened application.

Running threads: The number of running threads.

Threads peak: The maximum number of open threads that was reached.

Allowed threads: The maximum number of allowed threads.
If the engine setting is zero, then it should return the maximum allowed according to the given license.

Average request time: The average time in seconds that a request was processed by an enterprise server.

Request served: The number of requests processed.

Running users: The number of running users (when using the RIA license).

Users peak: The maximum number of users that was reached (when using the RIA license).

Allowed users: The maximum number of allowed users (when using the RIA license).

Example:

RqRtInf('Data Server',BA) where the virtual numeric variable BA temporarily stores the Runtime engine number. This number is returned from the execution of the RqRts function.

Note:

If an invalid service name or Runtime engine number is sent in the current application, the function returns an empty string.

Exceptions:

This function is supported only when using the Broker as a middleware.

See also:

The Online and Rich Client Samples projects (program ES02 and RES02)

Reference
Attachment 
Attachment