Class ansys::dpf::RuntimeClientConfig
Last update: 25.03.2026
enables to set runtime configuration options to DPF Client.
Inherits from:
- ansys::dpf::RuntimeConfig
Members
- enableCache
- getAvailableOptions
- getBoolValue
- getDoubleValue
- getIntValue
- getMetadata
- getStreamingBufferSize
- getStringValue
- isCacheEnabled
- isConnectionSecure
- RuntimeClientConfig
- RuntimeClientConfig
- RuntimeConfig
- RuntimeConfig
- set
- set
- set
- set
- setMetadata
- setSecureConnection
- setStreamFloatsInsteadOfDoubles
- setStreamingBufferSize
- setSubOption
- streamingFloatsInsteadOfDouble
Friends
Public functions
Function RuntimeClientConfig
ansys::dpf::RuntimeClientConfig::RuntimeClientConfig(RuntimeClientConfig const &rhs)
Parameters:
- RuntimeClientConfig const & rhs
Return type:
Function RuntimeClientConfig
ansys::dpf::RuntimeClientConfig::RuntimeClientConfig(RuntimeClientConfig &&rhs) noexcept
Parameters:
- RuntimeClientConfig && rhs
Return type:
Function enableCache
void ansys::dpf::RuntimeClientConfig::enableCache(bool use_cache)
Sets whether gRPC calls should be intercepted to cache responses or not.
Parameters:
- bool use_cache
Return type: void
Function isCacheEnabled
bool ansys::dpf::RuntimeClientConfig::isCacheEnabled() const
Returns:
Whether gRPC calls are intercepted to cache responses or not.
Return type: bool
Function setStreamingBufferSize
void ansys::dpf::RuntimeClientConfig::setStreamingBufferSize(int size)
Sets the chunk size (in bytes) used in gRPC streaming calls.
Parameters:
- int size
Return type: void
Function getStreamingBufferSize
int ansys::dpf::RuntimeClientConfig::getStreamingBufferSize() const
Returns:
the chunk size (in bytes) used in gRPC streaming calls.
Return type: int
Function setStreamFloatsInsteadOfDoubles
void ansys::dpf::RuntimeClientConfig::setStreamFloatsInsteadOfDoubles(bool use_float)
Sets whether double values (8 bytes) should be converted and streamed as floats values (4 bytes) in gRPC streaming calls.
Parameters:
- bool use_float
Return type: void
Function streamingFloatsInsteadOfDouble
bool ansys::dpf::RuntimeClientConfig::streamingFloatsInsteadOfDouble() const
Returns:
Whether double values (8 bytes) are converted and streamed as floats values (4 bytes) in gRPC streaming calls.
Return type: bool
Function setMetadata
void ansys::dpf::RuntimeClientConfig::setMetadata(std::map< std::string, std::string > const &metadata)
Sets the custom metadata appended to gRPC packets.
Parameters:
- std::map< std::string, std::string > const & metadata
Return type: void
Function getMetadata
std::map< std::string, std::string > ansys::dpf::RuntimeClientConfig::getMetadata() const
Gets the custom metadata appended to gRPC packets.
Return type: std::map< std::string, std::string >
Function setSecureConnection
void ansys::dpf::RuntimeClientConfig::setSecureConnection(bool secure)
Sets the use of TLS for secure gRPC connections.
Parameters:
- bool secure
Return type: void
Function isConnectionSecure
bool ansys::dpf::RuntimeClientConfig::isConnectionSecure() const
Returns if the gRPC communication is secured by using TLS.
Return type: bool