Glacier2.SessionControlPrx

class Glacier2.SessionControlPrx

Bases: ObjectPrx

Represents a router-provided object that allows an application-provided session manager to configure the routing constraints for a session.

Notes

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

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

Gets a proxy to the object that manages the allowable adapter identities for objects for this session.

Parameters:

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

Returns:

A proxy to a Glacier2.StringSetPrx object. This proxy is never null.

Return type:

StringSetPrx | None

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

Gets a proxy to the object that manages the allowable adapter identities for objects for this session.

Parameters:

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

Returns:

A proxy to a Glacier2.StringSetPrx object. This proxy is never null.

Return type:

Awaitable[StringSetPrx | None]

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

Gets a proxy to the object that manages the allowable categories for object identities for this session.

Parameters:

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

Returns:

A proxy to a Glacier2.StringSetPrx object. This proxy is never null.

Return type:

StringSetPrx | None

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

Gets a proxy to the object that manages the allowable categories for object identities for this session.

Parameters:

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

Returns:

A proxy to a Glacier2.StringSetPrx object. This proxy is never null.

Return type:

Awaitable[StringSetPrx | None]

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

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

Destroys the associated session.

Parameters:

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

Return type:

None

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

Destroys the associated session.

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]

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

Gets the session timeout.

Parameters:

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

Returns:

The timeout.

Return type:

int

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

Gets the session timeout.

Parameters:

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

Returns:

The timeout.

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

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

Gets a proxy to the object that manages the allowable object identities for this session.

Parameters:

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

Returns:

A proxy to an Glacier2.IdentitySetPrx object. This proxy is never null.

Return type:

IdentitySetPrx | None

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

Gets a proxy to the object that manages the allowable object identities for this session.

Parameters:

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

Returns:

A proxy to an Glacier2.IdentitySetPrx object. This proxy is never null.

Return type:

Awaitable[IdentitySetPrx | None]

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