ENVIServer

This function creates an ENVIServer object so that you can run multiple, concurrent ENVI processes in the background, in parallel, or distributed among different computers. See the ENVI Server help topic for more information.

Example

This example creates an ENVIServer object on a local computer using the default "localhost" URL that is created after installing GSF on that computer.

; Start the application

e = ENVI(/HEADLESS)

; Create an ENVIServer

server = ENVIServer('localhost')

Syntax

Result = ENVIServer(URL [, Properties=value] [, ERROR=value])

Return Value

This routine returns a reference to an ENVIServer object.

Methods

Arguments

URL

Specify the URL of the computer to be used as an ENVI Server. Both ENVI and Geospatial Services Framework (GSF) must be installed on that computer.

Properties

NAME (Get, Set)

Specify a string with the custom name of the ENVI Server.

URL (Get, Set)

Specify the URL of the ENVI Server.

VERSION (Get)

A string with the version of GSF that is running behind the ENVI Server.

WORKSPACE (Get, Set)

Specify a fully qualified URI with the GSF workspace to be used for the ENVI Server. You must also configure the GSF workspace by editing the "root" value in the config.json file. See the ENVI Servers topic for instructions.

Keywords

ERROR

Set this keyword to a named variable that will contain any error message issued during execution of this routine. If no error occurs, the ERROR variable will be set to a null string (''). If an error occurs and the routine is a function, then the function result will be undefined.

When this keyword is not set and an error occurs, ENVI returns to the caller and execution halts. In this case, the error message is contained within !ERROR_STATE and can be caught using IDL's CATCH routine. See IDL Help for more information on !ERROR_STATE and CATCH.

See Manage Errors for more information on error handling in ENVI programming.

Version History

ENVI 5.6	Introduced
ENVI 5.6.1	Added VERSION property

API Version

4.2