Defining a Workstation Listener (WSL) as a Server


	Corporate Info \| News \| Solutions \| Products \| Partners \| Services \| Events \| Download \| How To Buy
	http://www.oracle.com/technology/documentation/index.html \| Site Map \| Search \| PDF Files \| Contact \| Glossary

Tuxedo Doc Home \| Administration \| Topic List \| Previous \| Next \| Contents

Setting Up a BEA Tuxedo Application

Workstation clients access your application through a WSL process and one or more WSH processes. The WSL can support multiple workstation clients. It acts as the single point of contact for all the workstation clients connected to your application at the network address specified on the WSL command line. The listener schedules work for one or more workstation handler processes.

A WSH process acts as a surrogate within the administrative domain of your application for clients on remote workstations. The WSH uses a multiplexing scheme to support multiple Workstation clients concurrently.

To join Workstation clients to an application, you must specify the Workstation Listener (WSL) processes in the SERVERS section of the UBBCONFIG file. Use the same syntax you use to specify a server.

Passing Information to a WSL Process

To pass information to a WSL process, you can use the command-line option string, CLOPT. The format of the CLOPT parameter is as follows.

CLOPT="[ -A ] [servopts_options] -- -n netaddr [-d device]
       [-w WSHname][-t timeout_factor][-T Client_timeout]
       [-m minh][-M maxh][-x mpx_factor ]
       [-p minwshport][-P maxwshport]
       [-I init_timeout][-c compression_threshold]
       [-k compression_threshold]
       [-z bits][-Z bits][-H external_netaddr]
       [-N network_timeout][-K{client|handler|both|none}]"

The -A option requests that the WSL offer all its services when it is booted. This option is included by default, but it is shown here to emphasize the distinction between system-supplied servers and application servers. When application servers are booted, they sometimes offer only a subset of their available services.

The double-dash (--) marks the beginning of a list of parameters that is passed to the WSL after it has been booted.

Using Command-line Options Set with CLOPT

You can specify any of the following command-line options in the CLOPT string after the double-dash string (--).

Note: For a complete list of the CLOPT command-line options, see servopts(5) in BEA Tuxedo File Formats and Data Descriptions Reference.

Use This Command-line Option . . .
To specify . . .

-n netaddr

(required)

The network address used by WSCs to contact the listener. The WSC must set the appropriate environment variable (WSNADDR) to the value specified after -n.

[-d device]

(required for some transport interfaces)

Specify the network device name.

This is an optional parameter because only some transport interfaces require it. Sockets, for example, does not require this parameter.

[-t timeout]

The amount of time to allow for a client to connect to the WSH.

To calculate the total amount of time to allow for this purpose, the system multiplies the value of timeout by the value of the SCANUNIT parameter.

The default is 3 in a nonsecure application, and 6 in a secure application. In this context we refer to an application as secure if one of the following parameters is set:

USER_AUTH
ACL
MANDATORY_ACL
APP_PW

[-w name]

The name of the WSH process that should be booted for this listener. The default is WSH, which is the name of the handler provided. If another handler process is built with the buildwsh(1) command, that name is specified here.

[-m number]

The minimum number of handlers that should be booted and always available. The default is 0.

[-M number]

The maximum number of handlers that can be booted. The default is the value of MAXWSCLIENTS for the machine being configured, divided by the multiplexing value (specified with -x).

[-x number]

The maximum number of clients that a WSH can multiplex at one time. The value must be greater than 0. The default is 10.

[-T client_timeout]

The amount of time (in minutes) that a client can remain idle without being disconnected. If a client does not make any requests within this time period, the WSH disconnects the client. If this argument is not given or is set to 0, the time-out is infinite.

[-p minwshport] and [-P maxwshport]

The range for port numbers available for use by WSHs associated with this listener server. Port numbers must fall in the range between 0 and 65535. The default is 2048 for minwshport and 65535 for maxwshport.

[-z] and [-Z]

The range of bits that can be used, on the WSL side, for link-level encryption: use -z to specify the minimum number of bits, and -Z to specify the maximum number of bits.

[-N network_timeout]

The minimum amount of time (in seconds) that a workstation client is allowed to wait to receive a response from the WSL/WSH. A value of 0 indicates no network time-out.

[-K {client | handler | both | none}]

The viability of a network connection between the workstation handler and a workstation client if no traffic has occurred over that connection within a specified period of time.

Use This Command-line Option . . .	To specify . . .
-n netaddr (required)	The network address used by WSCs to contact the listener. The WSC must set the appropriate environment variable (WSNADDR) to the value specified after -n.
[-d device] (required for some transport interfaces)	Specify the network device name. This is an optional parameter because only some transport interfaces require it. Sockets, for example, does not require this parameter.
[-t timeout]	The amount of time to allow for a client to connect to the WSH. To calculate the total amount of time to allow for this purpose, the system multiplies the value of timeout by the value of the SCANUNIT parameter. The default is 3 in a nonsecure application, and 6 in a secure application. In this context we refer to an application as secure if one of the following parameters is set: USER_AUTH ACL MANDATORY_ACL APP_PW
[-w name]	The name of the WSH process that should be booted for this listener. The default is WSH, which is the name of the handler provided. If another handler process is built with the buildwsh(1) command, that name is specified here.
[-m number]	The minimum number of handlers that should be booted and always available. The default is 0.
[-M number]	The maximum number of handlers that can be booted. The default is the value of MAXWSCLIENTS for the machine being configured, divided by the multiplexing value (specified with -x).
[-x number]	The maximum number of clients that a WSH can multiplex at one time. The value must be greater than 0. The default is 10.
[-T client_timeout]	The amount of time (in minutes) that a client can remain idle without being disconnected. If a client does not make any requests within this time period, the WSH disconnects the client. If this argument is not given or is set to 0, the time-out is infinite.
[-p minwshport] and [-P maxwshport]	The range for port numbers available for use by WSHs associated with this listener server. Port numbers must fall in the range between 0 and 65535. The default is 2048 for minwshport and 65535 for maxwshport.
[-z] and [-Z]	The range of bits that can be used, on the WSL side, for link-level encryption: use -z to specify the minimum number of bits, and -Z to specify the maximum number of bits.
[-N network_timeout]	The minimum amount of time (in seconds) that a workstation client is allowed to wait to receive a response from the WSL/WSH. A value of 0 indicates no network time-out.
[-K {client \| handler \| both \| none}]	The viability of a network connection between the workstation handler and a workstation client if no traffic has occurred over that connection within a specified period of time.