IceBox.ServiceManager

class IceBox.ServiceManager

Bases: Object, ABC

Administers the services of an IceBox server.

Notes

The Slice compiler generated this skeleton class from Slice interface ::IceBox::ServiceManager.

abstractmethod addObserver(observer: ServiceObserverPrx | None, current: Current) → None | Awaitable[None]

Registers a new observer with this service manager.

Parameters:

• observer (ServiceObserverPrx | None) – The new observer.

• current (Ice.Current) – The Current object for the dispatch.

Returns:

None or an awaitable that completes when the dispatch completes.

Return type:

None | Awaitable[None]

static ice_staticId() → str

Obtain the type ID of the Slice interface.

Returns:

The type ID.

Return type:

str

abstractmethod isServiceRunning(service: str, current: Current) → bool | Awaitable[bool]

Returns whether a service is running.

Parameters:

• service (str) – The name of the service to check.

• current (Ice.Current) – The Current object for the dispatch.

Returns:

true if the service was started and not stopped; otherwise false.

Return type:

bool | Awaitable[bool]

Raises:

NoSuchServiceException – Thrown when IceBox does not know a service named service.

abstractmethod shutdown(current: Current) → None | Awaitable[None]

Shuts down all services.

Parameters:

current (Ice.Current) – The Current object for the dispatch.

Returns:

None or an awaitable that completes when the dispatch completes.

Return type:

None | Awaitable[None]

abstractmethod startService(service: str, current: Current) → None | Awaitable[None]

Starts a service.

Parameters:

• service (str) – The service name.

• current (Ice.Current) – The Current object for the dispatch.

Returns:

None or an awaitable that completes when the dispatch completes.

Return type:

None | Awaitable[None]

Raises:

• AlreadyStartedException – Thrown when the service is already running.

• NoSuchServiceException – Thrown when IceBox does not know a service named service.

abstractmethod stopService(service: str, current: Current) → None | Awaitable[None]

Stops a service.

Parameters:

• service (str) – The service name.

• current (Ice.Current) – The Current object for the dispatch.

Returns:

None or an awaitable that completes when the dispatch completes.

Return type:

None | Awaitable[None]

Raises:

• AlreadyStoppedException – Thrown when the service is already stopped.

• NoSuchServiceException – Thrown when IceBox does not know a service named service.