Class IceBoxDescriptor

constructor

• new IceBoxDescriptor(
      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,
      services?: ServiceInstanceDescriptor[],
  ): IceBoxDescriptor

  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.

  • Optionalservices: ServiceInstanceDescriptor[]

    The service instances.

  Returns IceBoxDescriptor

services