Ice.LoggerAdminPrx

class Ice.LoggerAdminPrx

Bases: ObjectPrx

Represents the admin facet that allows an Ice application to attach its Ice.RemoteLoggerPrx to the local logger of an Ice communicator.

Notes

The Slice compiler generated this proxy class from Slice interface ::Ice::LoggerAdmin.

attachRemoteLogger(prx: RemoteLoggerPrx | None, messageTypes: Sequence[LogMessageType], traceCategories: Sequence[str], messageMax: int, context: dict[str, str] | None = None) → None

Attaches a Ice.RemoteLoggerPrx object to the local logger. This operation calls Ice.RemoteLoggerPrx.initAsync() on prx.

Parameters:

  • prx (RemoteLoggerPrx | None) – A proxy to the remote logger.

  • messageTypes (Sequence[LogMessageType]) – The list of message types that the remote logger wishes to receive. An empty list means no filtering (send all message types).

  • traceCategories (Sequence[str]) – The categories of traces that the remote logger wishes to receive. This parameter is ignored if messageTypes is not empty and does not include trace. An empty list means no filtering (send all trace categories).

  • messageMax (int) – The maximum number of log messages (of all types) to be provided to Ice.RemoteLoggerPrx.initAsync(). A negative value requests all messages available.

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

Raises:

RemoteLoggerAlreadyAttachedException – Thrown if this remote logger is already attached to this admin object.

Return type:

None

attachRemoteLoggerAsync(prx: RemoteLoggerPrx | None, messageTypes: Sequence[LogMessageType], traceCategories: Sequence[str], messageMax: int, context: dict[str, str] | None = None) → Awaitable[None]

Attaches a Ice.RemoteLoggerPrx object to the local logger. This operation calls Ice.RemoteLoggerPrx.initAsync() on prx.

Parameters:

  • prx (RemoteLoggerPrx | None) – A proxy to the remote logger.

  • messageTypes (Sequence[LogMessageType]) – The list of message types that the remote logger wishes to receive. An empty list means no filtering (send all message types).

  • traceCategories (Sequence[str]) – The categories of traces that the remote logger wishes to receive. This parameter is ignored if messageTypes is not empty and does not include trace. An empty list means no filtering (send all trace categories).

  • messageMax (int) – The maximum number of log messages (of all types) to be provided to Ice.RemoteLoggerPrx.initAsync(). A negative value requests all messages available.

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

Returns:

An awaitable that is completed when the invocation completes.

Return type:

Awaitable[None]

detachRemoteLogger(prx: RemoteLoggerPrx | None, context: dict[str, str] | None = None) → bool

Detaches a Ice.RemoteLoggerPrx object from the local logger.

Parameters:

  • prx (RemoteLoggerPrx | None) – A proxy to the remote logger.

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

Returns:

true if the provided remote logger proxy was detached, and false otherwise.

Return type:

bool

detachRemoteLoggerAsync(prx: RemoteLoggerPrx | None, context: dict[str, str] | None = None) → Awaitable[bool]

Detaches a Ice.RemoteLoggerPrx object from the local logger.

Parameters:

  • prx (RemoteLoggerPrx | None) – A proxy to the remote logger.

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

Returns:

true if the provided remote logger proxy was detached, and false otherwise.

Return type:

Awaitable[bool]

getLog(messageTypes: Sequence[LogMessageType], traceCategories: Sequence[str], messageMax: int, context: dict[str, str] | None = None) → tuple[list[LogMessage], str]

Retrieves recently logged log messages.

Parameters:

  • messageTypes (Sequence[LogMessageType]) – The list of message types that the caller wishes to receive. An empty list means no filtering (send all message types).

  • traceCategories (Sequence[str]) – The categories of traces that caller wish to receive. This parameter is ignored if messageTypes is not empty and does not include trace. An empty list means no filtering (send all trace categories).

  • messageMax (int) – The maximum number of log messages (of all types) to be returned. A negative value requests all messages available.

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

Returns:

A tuple containing:

  • list[LogMessage] The Log messages.

  • str The prefix of the associated local logger.

Return type:

tuple[list[LogMessage], str]

getLogAsync(messageTypes: Sequence[LogMessageType], traceCategories: Sequence[str], messageMax: int, context: dict[str, str] | None = None) → Awaitable[tuple[list[LogMessage], str]]

Retrieves recently logged log messages.

Parameters:

  • messageTypes (Sequence[LogMessageType]) – The list of message types that the caller wishes to receive. An empty list means no filtering (send all message types).

  • traceCategories (Sequence[str]) – The categories of traces that caller wish to receive. This parameter is ignored if messageTypes is not empty and does not include trace. An empty list means no filtering (send all trace categories).

  • messageMax (int) – The maximum number of log messages (of all types) to be returned. A negative value requests all messages available.

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

Returns:

A tuple containing:

  • list[LogMessage] The Log messages.

  • str The prefix of the associated local logger.

Return type:

Awaitable[tuple[list[LogMessage], str]]

static checkedCast(proxy: ObjectPrx | None, facet: str | None = None, context: dict[str, str] | None = None) → LoggerAdminPrx | 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[LoggerAdminPrx | 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) → LoggerAdminPrx
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