getAllClients

Description

getAllClients gets the IP addresses of all client machines which corresponds to the active sessions that are opened for the specified application in the specified Appeon Server.

Syntax for .NET component

proxyobject.of_execinterface ( "getAllClients", ref any paralist[] )

Table 6. 

Argument

Description

proxyobject

The instance of the proxy object generated for AppeonDotNetComponent.

paralist[]

Arrays of Any type. Specifies the parameter arrays for the component function.

paralist[1] - The name of the Appeon Server in which the active sessions are created. The value should be IP address or IP address with port number, for example, 192.0.0.123, or 192.0.0.123:8080, and separated with semicolons (;) if there are multiple servers (for example in an Appeon Server cluster). If paralist[1] is NULL or an empty string (""), getAllClients returns the IP address of all clients for the specified application in all servers in an Appeon Server cluster (you will need to configure the cluster in AEM first).

paralist[2] - The name of the application that is deployed to the specified Appeon Server. If paralist[2] is NULL or empty string (""), getAllClients returns the IP address of clients for all applications in the specified Appeon Server.

paralist[3] - The return value of getAllClients function: the IP address of all clients. This parameter must be declared, but need not to be assigned with values, as it is used to hold the return value.


Return value of of_execinterface

Returns 1 if the of_execinterface function succeeds and one of the following negative values if an error occurs.

-1: function fails to execute

-2: the specified Appeon Server is not found

-3: the specified application is not found

Return value of getAllClients

Returns the IP address if the getAllClients function succeeds and returns an empty string if an error occurs.

The return value is stored in the paralist[3] parameter of the of_execinterface function.

Code example

Any la_l[] 
Long lRet 
...
la_l[1] = ls_servername                  
la_l[2] = ls_appname 
la_l[3] = ls_clientcontent   

lRet = loadDBList.of_ExecInterface ("getAllClients", la_l) //result is returned to la_l[3]

Syntax for EJB component

io_ejb.regstring ( String serverName )

io_ejb.regstring ( String appName )

io_ejb.Invokeretstring ( long objid, "getAllClients", true, ref string retval )

Table 7. 

Argument

Description

io_ejb

A reference of Appeon EJBobject.

serverName

The name of the Appeon Server in which the active sessions are created. The value should be IP address or IP address with port number, for example, 192.0.0.123, or 192.0.0.123:8080, and separated with semicolons (;) if there are multiple servers (for example in an Appeon Server cluster). If serverName is NULL or an empty string (""), getAllClients returns the IP address of all clients for the specified application in all servers in an Appeon Server cluster (you will need to configure the cluster in AEM first).

appName

The name of the application that is deployed to the specified Appeon Server. If appName is NULL or empty string (""), getAllClients returns the IP address of clients for all applications in the specified Appeon Server.

objid

The handle to the component method.

retval

The return value of getAllClients function: the IP address of all clients. This parameter must be declared, but need not to be assigned with values, as it is used to hold the return value.

Return value of Invokeretstring

Returns 1 if the Invokeretstring function succeeds and one of the following negative values if an error occurs.

-1: function fails to execute

-2: the specified Appeon Server is not found

-3: the specified application is not found

Return value of getAllClients

Returns the IP address if the getAllClients function succeeds and returns an empty string if an error occurs.

The return value is stored in the retval parameter of Invokeretstring function.

Code example

Note that invokeretstring function is called because the return value is a string.

string retval01 
string ls_msg
...
io_ejb.regstring (ls_servername) 
io_ejb.regstring (ls_appname) 

ls_msg = io_ejb.invokeretstring (il_bean1, "getAllClients", true, ref retval01) //result is returned to retval01

Syntax for Web Service

getAllClients ( string serverName, string appName )

Table 8. 

Argument

Description

serverName

The name of the Appeon Server in which the active sessions are created. The value should be IP address or IP address with port number, for example, 192.0.0.123, or 192.0.0.123:8080, and separated with semicolons (;) if there are multiple servers (for example in an Appeon Server cluster). If serverName is NULL or an empty string (""), getAllClients returns the IP address of all clients for the specified application in all servers in an Appeon Server cluster (you will need to configure the cluster in AEM first).

appName

The name of the application that is deployed to the specified Appeon Server. If appName is NULL or empty string (""), getAllClients returns the IP address of clients for all applications in the specified Appeon Server.

Return value

Returns the IP address if the function succeeds and returns an empty string if an error occurs.

Code example

string ls_return,ls_server,ls_app
ieon_soap.createinstance (ieon_ws, 'wsappeonservice')
ieon_head.username = 'admin'
ieon_head.password = 'admin'
ieon_ws.setauthsoapheadervalue (ieon_head)
ls_return = ieon_ws.getAllClients (ls_server, ls_app)