Ice.ImplicitContext

final class Ice.ImplicitContext(impl: ImplicitContext)

Bases: object

Represents the request context associated with a communicator. When you make a remote invocation without an explicit request context parameter, Ice uses the per-proxy request context (if any) combined with the ImplicitContext associated with your communicator.

The property Ice.ImplicitContext controls if your communicator has an associated implicit context, and when it does, whether this implicit context is per-thread or shared by all threads:

  • None (default):

    No implicit context at all.

  • PerThread:

    The implementation maintains a context per thread.

  • Shared:

    The implementation maintains a single context shared by all threads.

Parameters:

impl (ImplicitContext)

getContext() → dict[str, str]

Gets a copy of the request context maintained by this object.

Returns:

A copy of the request context.

Return type:

dict[str, str]

setContext(newContext: dict[str, str])

Sets the request context.

Parameters:

newContext (dict[str, str]) – The new request context.

containsKey(key: str) → bool

Checks if the specified key has an associated value in the request context.

Parameters:

key (str) – The key.

Returns:

True if the key has an associated value, False otherwise.

Return type:

bool

get(key: str) → str

Gets the value associated with the specified key in the request context.

Parameters:

key (str) – The key.

Returns:

The value associated with the key, or the empty string if no value is associated with the key. containsKey() allows you to distinguish between an empty-string value and no value at all.

Return type:

str

put(key: str, value: str) → str | None

Creates or updates a key/value entry in the request context.

Parameters:

  • key (str) – The key.

  • value (str) – The value.

Returns:

The previous value associated with the key, if any.

Return type:

str | None

remove(key: str) → str | None

Removes the entry for the specified key in the request context.

Parameters:

key (str) – The key.

Returns:

The value associated with the key, if any.

Return type:

str | None