Glacier2.RouterPrx

class Glacier2.RouterPrx

Bases: RouterPrx

The Glacier2 specialization of the Ice.RouterPrx interface.

Notes

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

static checkedCast(proxy: ObjectPrx | None, facet: str | None = None, context: dict[str, str] | None = None) → RouterPrx | 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, optional) – A facet name.

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

Returns:

A new proxy with the requested type, or None if the source proxy is None or if the target object 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[RouterPrx | 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, optional) – A facet name.

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

Returns:

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

Return type:

ObjectPrx | None

createSession(userId: str, password: str, context: dict[str, str] | None = None) → SessionPrx | None

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 (str) – The user ID.

• password (str) – The password.

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

Returns:

A proxy for the newly created session, or null if no Glacier2.SessionManagerPrx is configured.

Return type:

SessionPrx | None

Raises:

• CannotCreateSessionException – Thrown when the session cannot be created.

• PermissionDeniedException – Thrown when an authentication or authorization failure occurs.

createSessionAsync(userId: str, password: str, context: dict[str, str] | None = None) → Awaitable[SessionPrx | None]

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 (str) – The user ID.

• password (str) – The password.

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

Returns:

A proxy for the newly created session, or null if no Glacier2.SessionManagerPrx is configured.

Return type:

Awaitable[SessionPrx | None]

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

Creates a per-client session with the router. The user is authenticated through the SSL certificate(s) associated with the connection. If an Glacier2.SSLSessionManagerPrx 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:

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

Returns:

A proxy for the newly created session, or null if no Glacier2.SSLSessionManagerPrx is configured.

Return type:

SessionPrx | None

Raises:

• CannotCreateSessionException – Thrown when the session cannot be created.

• PermissionDeniedException – Thrown when an authentication or authorization failure occurs.

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

Creates a per-client session with the router. The user is authenticated through the SSL certificate(s) associated with the connection. If an Glacier2.SSLSessionManagerPrx 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:

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

Returns:

A proxy for the newly created session, or null if no Glacier2.SSLSessionManagerPrx is configured.

Return type:

Awaitable[SessionPrx | None]

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

Destroys the session of the caller with this router.

Parameters:

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

Raises:

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

Return type:

None

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

Destroys the session of the caller with this router.

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]

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

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

Parameters:

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

Returns:

The idle timeout (in seconds).

Return type:

int

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

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

Parameters:

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

Returns:

The idle timeout (in seconds).

Return type:

Awaitable[int]

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

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:

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

Returns:

The category. It’s an empty string when Glacier2.Server.Endpoints is not configured.

Return type:

str

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

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:

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

Returns:

The category. It’s an empty string when Glacier2.Server.Endpoints is not configured.

Return type:

Awaitable[str]

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

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

Parameters:

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

Returns:

The idle timeout (in seconds).

Return type:

int

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

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

Parameters:

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

Returns:

The idle timeout (in seconds).

Return type:

Awaitable[int]

static ice_staticId() → str

Gets the Slice type ID of the interface associated with this proxy.

Returns:

The type ID, “::Ice::Object”.

Return type:

str

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

Keeps the session with this router alive.

Parameters:

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

Raises:

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

Return type:

None

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

Keeps the session with this router alive.

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 uncheckedCast(proxy: ObjectPrx, facet: str | None = None) → RouterPrx

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, optional) – A facet name.

Returns:

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

Return type:

ObjectPrx | None