@zeroc/ice
    Preparing search index...

    Class RouterPrx

    The Glacier2 specialization of the Ice.RouterPrx interface.

    The Slice compiler generated this proxy class from Slice interface ::Glacier2::Router.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    • Constructs a new RouterPrx proxy.

      Parameters

      • communicator: Communicator

        The communicator for the new proxy.

      • proxyString: string

        The string representation of the proxy.

      Returns Glacier2.RouterPrx

      The new RouterPrx proxy.

      ParseException - Thrown if the proxyString is not a valid proxy string.

    Methods

    • Adds new proxy information to the router's routing table.

      Parameters

      • proxies: ObjectPrx[]

        The proxies to add. Adding a null proxy is an error.

      • Optionalcontext: Map<string, string>

        The Context map to send with the invocation.

      Returns AsyncResult<ObjectPrx[]>

      An Ice.AsyncResult object representing the result of the invocation, which resolves to:

      • (Ice.ObjectPrx | null)[] : Proxies discarded by the router. These proxies are all non-null.
    • Creates a session for the client (caller) with the router. If a Glacier2.SessionManagerPrx is configured, a proxy to a Glacier2.SessionPrx object is returned to the client. Otherwise, null is returned and only an internal session (i.e., not visible to the client) is created. If a non-null session proxy is returned, it must be configured to route through the router that created it. This occurs automatically when the router is configured as the client's default router at the time the session proxy is created in the client application; otherwise, the client must configure the session proxy explicitly.

      Parameters

      • userId: string

        The user ID.

      • password: string

        The password.

      • Optionalcontext: Map<string, string>

        The Context map to send with the invocation.

      Returns AsyncResult<SessionPrx>

      An Ice.AsyncResult object representing the result of the invocation, which resolves to:

      Glacier2.CannotCreateSessionException Thrown when the session cannot be created.

      Glacier2.PermissionDeniedException Thrown when an authentication or authorization failure occurs.

    • Destroys the session of the caller with this router.

      Parameters

      • Optionalcontext: Map<string, string>

        The Context map to send with the invocation.

      Returns AsyncResult<void>

      An Ice.AsyncResult object representing the result of the invocation.

      Glacier2.SessionNotExistException Thrown when no session exists for the caller (client).

    • Checks whether the specified object is equal to this object.

      Parameters

      Returns boolean

      true if the specified object is equal to this object, false otherwise.

    • Gets the idle timeout used by the server-side of the connection.

      Parameters

      • Optionalcontext: Map<string, string>

        The Context map to send with the invocation.

      Returns AsyncResult<number>

      An Ice.AsyncResult object representing the result of the invocation, which resolves to:

      • number : The idle timeout (in seconds).
    • Gets a unique category that identifies the client (caller) in the router. This category must be used in the identities of all the client's callback objects.

      Parameters

      • Optionalcontext: Map<string, string>

        The Context map to send with the invocation.

      Returns AsyncResult<string>

      An Ice.AsyncResult object representing the result of the invocation, which resolves to:

      • string : The category. It's an empty string when Glacier2.Server.Endpoints is not configured.
    • Gets the router's client proxy, i.e. the proxy to use for forwarding requests from the client to the router. If a null proxy is returned, the client will forward requests to the router's endpoints.

      Parameters

      • Optionalcontext: Map<string, string>

        The Context map to send with the invocation.

      Returns AsyncResult<[ObjectPrx, boolean]>

      An Ice.AsyncResult object representing the result of the invocation, which resolves to an array with the following entries:

      • Ice.ObjectPrx | null : The router's client proxy.
      • boolean | undefined : Indicates whether or not the router supports a routing table. If true, the Ice runtime will call Ice.RouterPrx.addProxies to populate the routing table. The Ice runtime assumes the router has a routing table when hasRoutingTable is not set.

      Introduced in Ice 3.7.

    • Gets the router's server proxy, i.e. the proxy to use for forwarding requests from the server to the router. The Ice runtime uses the endpoints of this proxy as the published endpoints of bi-dir object adapters.

      Parameters

      • Optionalcontext: Map<string, string>

        The Context map to send with the invocation.

      Returns AsyncResult<ObjectPrx>

      An Ice.AsyncResult object representing the result of the invocation, which resolves to:

      • Ice.ObjectPrx | null : The router's server proxy.
    • Gets the idle timeout used by the server-side of the connection.

      Parameters

      • Optionalcontext: Map<string, string>

        The Context map to send with the invocation.

      Returns AsyncResult<bigint>

      An Ice.AsyncResult object representing the result of the invocation, which resolves to:

      • bigint : The idle timeout (in seconds).
    • Creates a proxy that is identical to this proxy, except for the adapter ID.

      Parameters

      • id: string

        The adapter ID for the new proxy.

      Returns this

      A proxy with the new adapter ID.

    • Creates a proxy that is identical to this proxy, but uses batch oneway invocations.

      Returns this

      A proxy that uses batch oneway invocations.

    • Creates a proxy that is identical to this proxy, except for connection caching.

      Parameters

      • cache: boolean

        true if the new proxy should cache connections, false otherwise.

      Returns this

      A proxy with the specified caching policy.

    • Creates a proxy that is identical to this proxy, except for its connection ID.

      Parameters

      • connectionId: string

        The connection ID for the new proxy. An empty string removes the connection ID.

      Returns this

      A proxy with the specified connection ID.

    • Creates a proxy that is identical to this proxy, except for the per-proxy context.

      Parameters

      • context: Map<string, string>

        The context for the new proxy.

      Returns this

      A proxy with the new per-proxy context.

    • Creates a proxy that is identical to this proxy, except for the endpoints.

      Parameters

      • endpoints: Endpoint[]

        The endpoints for the new proxy.

      Returns this

      A proxy with the new endpoints.

    • Creates a proxy that is identical to this proxy, except for the facet.

      Parameters

      • facet: string

        The facet for the new proxy.

      Returns this

      A proxy with the new facet.

    • Creates a proxy that is identical to this proxy, except it's a fixed proxy bound to the given connection.

      Parameters

      • connection: Connection

        The fixed proxy connection.

      Returns this

      A fixed proxy bound to the given connection.

    • Gets the adapter ID for this proxy.

      Returns string

      The adapter ID. If the proxy does not have an adapter ID, the return value is the empty string.

    • Gets the facet for this proxy.

      Returns string

      The facet for this proxy. If the proxy uses the default facet, the return value is the empty string.

    • Gets the type ID of the most-derived Slice interface supported by this object.

      Parameters

      • Optionalcontext: Map<string, string>

        The request context.

      Returns AsyncResult<string>

      An asynchronous result that resolves to the Slice type ID of the most-derived interface.

    • Gets the Slice interfaces supported by this object as a list of Slice type IDs.

      Parameters

      • Optionalcontext: Map<string, string>

        The request context.

      Returns AsyncResult<string[]>

      An asynchronous result that resolves to an array of the Slice type IDs of the interfaces supported by this object, in alphabetical order

    • Creates a proxy that is identical to this proxy, except for the invocation timeout.

      Parameters

      • timeout: number

        The new invocation timeout (in milliseconds).

      Returns this

      A proxy with the new timeout.

    • Tests whether this object supports a specific Slice interface.

      Parameters

      • typeId: string

        The type ID of the Slice interface to test against.

      • Optionalcontext: Map<string, string>

        The request context.

      Returns AsyncResult<boolean>

      An asynchronous result that resolves to true if the target object implements the Slice interface specified by typeId or implements a derived interface, false otherwise.

    • Determines whether this proxy is a fixed proxy.

      Returns boolean

      true if this proxy is a fixed proxy, false otherwise.

    • Determines whether this proxy uses oneway invocations.

      Returns boolean

      true if this proxy uses oneway invocations, false otherwise.

    • Determines whether this proxy uses twoway invocations.

      Returns boolean

      true if this proxy uses twoway invocations, false otherwise.

    • Creates a proxy that is identical to this proxy, except for the locator cache timeout.

      Parameters

      • timeout: number

        The new locator cache timeout (in seconds).

      Returns this

      A proxy with the new timeout.

    • Creates a proxy that is identical to this proxy, but uses oneway invocations.

      Returns this

      A proxy that uses oneway invocations.

    • Tests whether the target object of this proxy can be reached.

      Parameters

      • Optionalcontext: Map<string, string>

        The request context.

      Returns AsyncResult<void>

      An asynchronous result that resolves when the ping operation completes.

    • Creates a proxy that is identical to this proxy, but uses twoway invocations.

      Returns this

      A proxy that uses twoway invocations.

    • Keeps the session with this router alive.

      Parameters

      • Optionalcontext: Map<string, string>

        The Context map to send with the invocation.

      Returns AsyncResult<void>

      An Ice.AsyncResult object representing the result of the invocation.

      Glacier2.SessionNotExistException Thrown when no session exists for the caller (client).

      As of Ice 3.8, this operation does nothing.

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

      Parameters

      • prx: ObjectPrx

        The source proxy.

      • Optionalfacet: string

        An optional facet name.

      • Optionalcontext: Map<string, string>

        The request context.

      Returns AsyncResult<Glacier2.RouterPrx>

      A proxy with the requested type and facet, or null if the target object does not support the requested type.

    • Returns the Slice type ID associated with this type.

      Returns string

      The Slice type ID.