Class CommunicatorDescriptor

Describes an Ice communicator.

Remarks

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

Hierarchy (View Summary)

Value
- CommunicatorDescriptor
  - ServerDescriptor
  - ServiceDescriptor

Index

Constructors

Properties

adapters dbEnvs description logs propertySet

Methods

ice_getSlicedData ice_id ice_postUnmarshal ice_preMarshal ice_staticId

Constructors

constructor

new CommunicatorDescriptor(
    adapters?: AdapterDescriptor[],
    propertySet?: PropertySetDescriptor,
    dbEnvs?: DbEnvDescriptor[],
    logs?: string[],
    description?: string,
): CommunicatorDescriptor
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.
Returns CommunicatorDescriptor
Overrides Value.constructor

Properties

adapters

adapters: AdapterDescriptor[]

The indirect object adapters.

dbEnvs

dbEnvs: DbEnvDescriptor[]

The database environments.

Deprecated

description

description: string

A description of this descriptor.

logs

logs: string[]

The path of each log file.

propertySet

propertySet: PropertySetDescriptor

The property set.

Methods

ice_getSlicedData

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

Returns SlicedData | null
The sliced data if this value was sliced during unmarshaling, null otherwise. Unknown slices are preserved only when the sender uses the sliced format.

Inherited from Value.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 Value.ice_id

ice_postUnmarshal

ice_postUnmarshal(): void
The Ice runtime 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 Value.ice_postUnmarshal

ice_preMarshal

ice_preMarshal(): void
The Ice runtime 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 Value.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 Value.ice_staticId