Class ServerDescriptor

Describes an Ice server.

Remarks

The Slice compiler generated this class from Slice class ::IceGrid::ServerDescriptor.

Hierarchy (View Summary)

CommunicatorDescriptor
- ServerDescriptor
  - IceBoxDescriptor

Index

Constructors

constructor

new ServerDescriptor(
    adapters?: AdapterDescriptor[],
    propertySet?: PropertySetDescriptor,
    dbEnvs?: DbEnvDescriptor[],
    logs?: string[],
    description?: string,
    id?: string,
    exe?: string,
    iceVersion?: string,
    pwd?: string,
    options?: string[],
    envs?: string[],
    activation?: string,
    activationTimeout?: string,
    deactivationTimeout?: string,
    applicationDistrib?: boolean,
    distrib?: DistributionDescriptor,
    allocatable?: boolean,
    user?: string,
): ServerDescriptor
One-shot constructor to initialize all data members.
Parameters
- Optionaladapters: AdapterDescriptor[]
  The indirect object adapters.
- OptionalpropertySet: PropertySetDescriptor
  The property set.
- OptionaldbEnvs: DbEnvDescriptor[]
  The database environments.
- Optionallogs: string[]
  The path of each log file.
- Optionaldescription: string
  A description of this descriptor.
- Optionalid: string
  The server ID.
- Optionalexe: string
  The path of the server executable.
- OptionaliceVersion: string
  The Ice version used by this server.
- Optionalpwd: string
  The path to the server working directory.
- Optionaloptions: string[]
  The command line options to pass to the server executable.
- Optionalenvs: string[]
  The server environment variables.
- Optionalactivation: string
  The server activation mode.
- OptionalactivationTimeout: string
  The activation timeout.
- OptionaldeactivationTimeout: string
  The deactivation timeout.
- OptionalapplicationDistrib: boolean
  Specifies if the server depends on the application distribution.
- Optionaldistrib: DistributionDescriptor
  The distribution descriptor.
- Optionalallocatable: boolean
  Specifies if the server is allocatable.
- Optionaluser: string
  The user account used to run the server.
Returns ServerDescriptor
Overrides CommunicatorDescriptor.constructor

Properties

activation

activation: string

The server activation mode. Possible values are "on-demand" and "manual".

activationTimeout

activationTimeout: string

The activation timeout. It's an integer (in string format) that represents the number of seconds to wait for activation.

adapters

adapters: AdapterDescriptor[]

The indirect object adapters.

allocatable

allocatable: boolean

Specifies if the server is allocatable.

applicationDistrib

applicationDistrib: boolean

Specifies if the server depends on the application distribution.

Deprecated

dbEnvs

dbEnvs: DbEnvDescriptor[]

The database environments.

Deprecated

deactivationTimeout

deactivationTimeout: string

The deactivation timeout. It's an integer (in string format) that represents the number of seconds to wait for deactivation.

description

description: string

A description of this descriptor.

distrib

distrib: DistributionDescriptor

The distribution descriptor.

Deprecated

envs

envs: string[]

The server environment variables.

exe

exe: string

The path of the server executable.

iceVersion

iceVersion: string

The Ice version used by this server. This is only required if backward compatibility with servers using old Ice versions is needed (otherwise the registry assumes the server is using the same Ice version as the registry itself). For example "3.7.5".

id

id: string

The server ID.

logs

logs: string[]

The path of each log file.

options

options: string[]

The command line options to pass to the server executable.

propertySet

propertySet: PropertySetDescriptor

The property set.

pwd

pwd: string

The path to the server working directory.

user

user: string

The user account used to run the server.

Methods

ice_getSlicedData

ice_getSlicedData(): SlicedData
Obtains the sliced data associated with this instance.

Returns SlicedData
The sliced data if the value has a preserved-slice base class and has been sliced during unmarshaling of the value, nil otherwise.

Inherited from CommunicatorDescriptor.ice_getSlicedData

ice_id

ice_id(): string
Obtains the Slice type ID of the most-derived class supported by this object.

Returns string
The type ID.

Inherited from CommunicatorDescriptor.ice_id

ice_postUnmarshal

ice_postUnmarshal(): void
The Ice run time invokes this method after unmarshaling an object's data members. This allows a subclass to override this method in order to perform additional initialization.

Returns void
Inherited from CommunicatorDescriptor.ice_postUnmarshal

ice_preMarshal

ice_preMarshal(): void
The Ice run time invokes this method prior to marshaling an object's data members. This allows a subclass to override this method in order to validate its data members.

Returns void
Inherited from CommunicatorDescriptor.ice_preMarshal

`Static`ice_staticId

ice_staticId(): string
Obtains the Slice type ID of this type.

Returns string
The return value is always "::Ice::Object".

Inherited from CommunicatorDescriptor.ice_staticId

Class ServerDescriptor

Remarks

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns ServerDescriptor

Properties

activation

activationTimeout

adapters

allocatable

applicationDistrib

Deprecated

dbEnvs

Deprecated

deactivationTimeout

description

distrib

Deprecated

envs

exe

iceVersion

id

logs

options

propertySet

pwd

user

Methods

ice_getSlicedData

Returns SlicedData

ice_id

Returns string

ice_postUnmarshal

Returns void

ice_preMarshal

Returns void

Staticice_staticId

Returns string

Settings

On This Page

`Static`ice_staticId