IceGrid.AdapterDescriptor¶

class IceGrid.AdapterDescriptor(name: str = '', description: str = '', id: str = '', replicaGroupId: str = '', priority: str = '', registerProcess: bool = False, serverLifetime: bool = False, objects: list[ObjectDescriptor] = <factory>, allocatables: list[ObjectDescriptor] = <factory>)¶

Bases: object

Describes an indirect object adapter.

Parameters:

name (str)
description (str)
id (str)
replicaGroupId (str)
priority (str)
registerProcess (bool)
serverLifetime (bool)
objects (list[ObjectDescriptor])
allocatables (list[ObjectDescriptor])

name¶

The object adapter name.

Type:: str

description¶

A description of this object adapter.

Type:: str

id¶

The adapter ID.

Type:: str

replicaGroupId¶

The replica group ID. It’s empty when the adapter is not part of a replica group.

Type:: str

priority¶

The adapter priority. Only relevant when the adapter is in a replica group.

Type:: str

registerProcess¶

When true, the object adapter registers a process object.

Type:: bool

serverLifetime¶

When true, the lifetime of this object adapter is the same of the server lifetime. This information is used by the IceGrid node to figure out the server state: the server is active when all its “server lifetime” adapters are active.

Type:: bool

objects¶

The descriptors of well-known objects.

Type:: list[ObjectDescriptor]

allocatables¶

The descriptors of allocatable objects.

Type:: list[ObjectDescriptor]

Notes

The Slice compiler generated this dataclass from Slice struct ::IceGrid::AdapterDescriptor.