@zeroc/ice
    Preparing search index...

    Class LoggerAdminAbstract

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

    Hierarchy (View Summary)

    Index

    Constructors

    Methods

    • Attaches a Ice.RemoteLoggerPrx object to the local logger. This operation calls Ice.RemoteLoggerPrx.init on prx.

      Parameters

      • prx: RemoteLoggerPrx

        A proxy to the remote logger.

      • messageTypes: LogMessageType[]

        The list of message types that the remote logger wishes to receive. An empty list means no filtering (send all message types).

      • traceCategories: string[]

        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: number

        The maximum number of log messages (of all types) to be provided to Ice.RemoteLoggerPrx.init. A negative value requests all messages available.

      • current: Current

        The Current object for the dispatch.

      Returns void | PromiseLike<void>

      A promise like object representing the result of the dispatch.

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

    • Detaches a Ice.RemoteLoggerPrx object from the local logger.

      Parameters

      Returns boolean | PromiseLike<boolean>

      A promise like object representing the result of the dispatch, which resolves to:

      • boolean : true if the provided remote logger proxy was detached, and false otherwise.
    • Dispatches an incoming request to one of the methods of this generated class, based on the operation name carried by the request.

      Parameters

      Returns OutgoingResponse | PromiseLike<OutgoingResponse>

      The outgoing response (when the selected method returns a value), or a promise with the outgoing response (when the selected method returns a promise).

      Ice marshals any exception thrown by this method into the response.

    • Retrieves recently logged log messages.

      Parameters

      • messageTypes: LogMessageType[]

        The list of message types that the caller wishes to receive. An empty list means no filtering (send all message types).

      • traceCategories: string[]

        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: number

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

      • current: Current

        The Current object for the dispatch.

      Returns [LogMessage[], string] | PromiseLike<[LogMessage[], string]>

      A promise like object representing the result of the dispatch, which resolves to an array with the following entries:

      • Ice.LogMessage[] : The Log messages.
      • string : The prefix of the associated local logger.
    • Returns the Slice type ID of the most-derived interface supported by this object.

      Parameters

      • current: Current

        The Current object for the invocation.

      Returns string | PromiseLike<string>

      The Slice type ID of the most-derived interface.

    • Returns the Slice type IDs of the interfaces supported by this object.

      Parameters

      • current: Current

        The Current object for the invocation.

      Returns string[] | PromiseLike<string[]>

      The Slice type IDs of the interfaces supported by this object, in alphabetical order.

    • Tests whether this object supports a specific Slice interface.

      Parameters

      • typeID: string

        The type ID of the Slice interface to test against.

      • current: Current

        The Current object for the invocation.

      Returns boolean | PromiseLike<boolean>

      True if this object has the interface specified by typeID or derives from the interface specified by typeID.

    • Tests whether this object can be reached.

      Parameters

      • current: Current

        The Current object for the invocation.

      Returns void | PromiseLike<void>

    • Obtains the Slice type ID of this type.

      Returns string

      The return value is always "::Ice::LoggerAdmin".