session

session - manage a multiuser session

 SYNOPSIS

session sub-command options

 DESCRIPTION

The session command is used to login and logout of this TCL session. A user is not required to login to configure ports; however to take ownership of a group of ports in a multiuser environment, the user must log in. Session login is valid for the entire duration of a TCL window, regardless of how many times a package require IxTclHal or cleanUp is initiated or until the user logs out. Logging in as a different user name is the same as logging out and logging in again with a different login name.

 STANDARD OPTIONS
captureBufferSegmentSize

Sets the size of the capture buffer request, in MB. The capture buffer is delivered in a series of segments that are no larger than this setting. (default = 16)

Note: captureBufferSegmentSize sets this client's request size, but does not affect any other client sessions.

userName

Read-only. User name for this session. (default = "")

 COMMANDS

The session command is invoked with the following sub-commands. If no sub-command is specified, returns a list of all sub-commands available.

session config option value

Modify the configuration options of the session. If no option is specified, returns a list describing all of the available session options (see STANDARD OPTIONS).

session cget option

Returns the current value of the configuration option given by option. Option may have any of the values accepted by the session command.

session get option

Returns the current value of the configuration option given by option. Option may have any of the values accepted by the session command.

session login userName

Initiate a login to a new multiuser session. If already logged in as a different userName, log out existing user and log in new userName. Specific errors are:

session logout

Logs out current user.

session set option

Sets the current value of the configuration option given by option. Option may have any of the values accepted by the session command.

 EXAMPLES

package require IxTclHal

 

# Login for george

session login george

 

# See who's logged in

set userName [session cget -userName]

ixPuts "$userName is currently logged in"

 

# Logout

session logout

 

# And check again

set userName [session cget -userName]

ixPuts "$userName is currently logged in"

SEE ALSO

ixLogin, ixLogout.