IceBox.ServiceManagerPrx

class IceBox.ServiceManagerPrx

Bases: ObjectPrx

Administers the services of an IceBox server.

Notes

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

startService(service: str, context: dict[str, str] | None = None) → None

Starts a service.

Parameters:

• service (str) – The service name.

• context (dict[str, str]) – The request context for the invocation.

Raises:

• AlreadyStartedException – Thrown when the service is already running.

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

Return type:

None

startServiceAsync(service: str, context: dict[str, str] | None = None) → Awaitable[None]

Starts a service.

Parameters:

• service (str) – The service name.

• context (dict[str, str]) – The request context for the invocation.

Returns:

An awaitable that is completed when the invocation completes.

Return type:

Awaitable[None]

stopService(service: str, context: dict[str, str] | None = None) → None

Stops a service.

Parameters:

• service (str) – The service name.

• context (dict[str, str]) – The request context for the invocation.

Raises:

• AlreadyStoppedException – Thrown when the service is already stopped.

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

Return type:

None

stopServiceAsync(service: str, context: dict[str, str] | None = None) → Awaitable[None]

Stops a service.

Parameters:

• service (str) – The service name.

• context (dict[str, str]) – The request context for the invocation.

Returns:

An awaitable that is completed when the invocation completes.

Return type:

Awaitable[None]

isServiceRunning(service: str, context: dict[str, str] | None = None) → bool

Returns whether a service is running.

Parameters:

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

• context (dict[str, str]) – The request context for the invocation.

Returns:

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

Return type:

bool

Raises:

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

isServiceRunningAsync(service: str, context: dict[str, str] | None = None) → Awaitable[bool]

Returns whether a service is running.

Parameters:

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

• context (dict[str, str]) – The request context for the invocation.

Returns:

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

Return type:

Awaitable[bool]

addObserver(observer: ServiceObserverPrx | None, context: dict[str, str] | None = None) → None

Registers a new observer with this service manager.

Parameters:

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

• context (dict[str, str]) – The request context for the invocation.

Return type:

None

addObserverAsync(observer: ServiceObserverPrx | None, context: dict[str, str] | None = None) → Awaitable[None]

Registers a new observer with this service manager.

Parameters:

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

• context (dict[str, str]) – The request context for the invocation.

Returns:

An awaitable that is completed when the invocation completes.

Return type:

Awaitable[None]

shutdown(context: dict[str, str] | None = None) → None

Shuts down all services.

Parameters:

context (dict[str, str]) – The request context for the invocation.

Return type:

None

shutdownAsync(context: dict[str, str] | None = None) → Awaitable[None]

Shuts down all services.

Parameters:

context (dict[str, str]) – The request context for the invocation.

Returns:

An awaitable that is completed when the invocation completes.

Return type:

Awaitable[None]

static checkedCast(proxy: ObjectPrx | None, facet: str | None = None, context: dict[str, str] | None = None) → ServiceManagerPrx | None

Creates a new proxy from an existing proxy after confirming the target object’s type via a remote invocation.

Parameters:

• proxy (ObjectPrx | None) – The source proxy.

• facet (str | None, optional) – A facet name.

• context (dict[str, str] | None, optional) – The request context.

Returns:

A new proxy with the requested facet, or None if the source proxy is None or if the target object/facet does not support the requested type.

Return type:

ObjectPrx | None

static checkedCastAsync(proxy: ObjectPrx | None, facet: str | None = None, context: dict[str, str] | None = None) → Awaitable[ServiceManagerPrx | None]

Creates a new proxy from an existing proxy after confirming the target object’s type via a remote invocation.

Parameters:

• proxy (ObjectPrx | None) – The source proxy.

• facet (str | None, optional) – A facet name.

• context (dict[str, str] | None, optional) – The request context.

Returns:

A new proxy with the requested facet, or None if the source proxy is None or if the target object/facet does not support the requested type.

Return type:

ObjectPrx | None

static uncheckedCast(proxy: ObjectPrx, facet: str | None = None) → ServiceManagerPrx

static uncheckedCast(proxy: None, facet: str | None = None) → None

Creates a new proxy from an existing proxy.

Parameters:

• proxy (ObjectPrx | None) – The source proxy.

• facet (str | None, optional) – A facet name.

Returns:

A new proxy with the requested facet, or None if the source proxy is None.

Return type:

ObjectPrx | None

static ice_staticId() → str

Returns the Slice type ID associated with this type.

Returns:

The Slice type ID.

Return type:

str