RuntimeClientConfig

class ansys.dpf.core.runtime_config.RuntimeClientConfig(data_tree, server=None)

Bases: _RuntimeConfig

Enable accessing and setting runtime configuration options to gRPC client.

Mostly used to configure gRPC streaming and calls options.

Parameters:

• data_tree (ctypes.cvoid_p) – DataTree pointer describing the existing parameters configuration of DataprocessingCore.

• server (BaseServer, optional) – Server with channel connected to the remote or local instance. The default is None, in which case an attempt is made to use the global server.

Notes

Available from 4.0 server version.

Overview

Methods

copy_config

Add config to data tree.

Properties

cache_enabled	Whether gRPC requests and responses are intercepted to cache them and retrieve them when appropriate.
streaming_buffer_size	Sets the chunk size (in bytes) used in gRPC streaming calls.
stream_floats_instead_of_doubles	Sets whether double values (8 bytes) should be converted and streamed as float values (4 bytes) in gRPC streaming calls.
return_arrays	All methods will return ansys.dpf.core.DPFArray (instead of lists) when possible.
grpc_mode	Returns current value for the key ‘grpc_mode’ setting.
grpc_certs_dir	Returns the current value for the ‘grpc_certs_dir’ setting, can be empty.

Import detail

from ansys.dpf.core.runtime_config import RuntimeClientConfig

Property detail

property RuntimeClientConfig.cache_enabled

Whether gRPC requests and responses are intercepted to cache them and retrieve them when appropriate.

Return type:

bool

Notes

Can only be used for a gRPC communication.

property RuntimeClientConfig.streaming_buffer_size

Sets the chunk size (in bytes) used in gRPC streaming calls.

Return type:

int

Notes

Can only be used for a gRPC communication.

property RuntimeClientConfig.stream_floats_instead_of_doubles

Sets whether double values (8 bytes) should be converted and streamed as float values (4 bytes) in gRPC streaming calls.

Return type:

bool

Notes

Can only be used for a gRPC communication.

property RuntimeClientConfig.return_arrays

All methods will return ansys.dpf.core.DPFArray (instead of lists) when possible.

Default is True. See for example, ansys.dpf.core.Scoping.ids().

Return type:

bool

property RuntimeClientConfig.grpc_mode

Returns current value for the key ‘grpc_mode’ setting.

property RuntimeClientConfig.grpc_certs_dir

Returns the current value for the ‘grpc_certs_dir’ setting, can be empty.

Method detail

RuntimeClientConfig.copy_config(config)

Add config to data tree.