## On this page

  

 

 # ansys::dpf::RuntimeClientConfig Class Reference

 Last update: 16.07.2025 

`#include <dpf_api.h>`

Inherits ansys::dpf::RuntimeConfig.

## <a id="pub-methods" name="pub-methods"></a>Public Member Functions

<a id="a0ae5e33053e62969b2968019c869b693" name="a0ae5e33053e62969b2968019c869b693"></a> **RuntimeClientConfig** ([RuntimeClientConfig](classansys_1_1dpf_1_1RuntimeClientConfig.xhtml) const &amp;rhs) <a id="adec9994df2fb0d2b4717c300a69ed0c2" name="adec9994df2fb0d2b4717c300a69ed0c2"></a> **RuntimeClientConfig** ([RuntimeClientConfig](classansys_1_1dpf_1_1RuntimeClientConfig.xhtml) &amp;&amp;rhs) noexcept void [enableCache](classansys_1_1dpf_1_1RuntimeClientConfig.xhtml#ab83354eaf4d8646fd7d06e0f5dbdafaf) (bool use\_cache) bool [isCacheEnabled](classansys_1_1dpf_1_1RuntimeClientConfig.xhtml#aac0f20eaf4cb412d3ef03d787ac38f06) () const void [setStreamingBufferSize](classansys_1_1dpf_1_1RuntimeClientConfig.xhtml#a286701384f2b37237c61f20d1c24eae6) (int size) int [getStreamingBufferSize](classansys_1_1dpf_1_1RuntimeClientConfig.xhtml#a31e99b0bf8468a58ca3b5bcaa1412fe6) () const void [setStreamFloatsInsteadOfDoubles](classansys_1_1dpf_1_1RuntimeClientConfig.xhtml#a380e861289e9683a04ca84c250b0ecf7) (bool use\_float) bool [streamingFloatsInsteadOfDouble](classansys_1_1dpf_1_1RuntimeClientConfig.xhtml#a38db32f9104c3c2884a734a7cf606ed7) () const void [setMetadata](classansys_1_1dpf_1_1RuntimeClientConfig.xhtml#accdb5f4e700803b8bd6b6cf8cb8623d1) (std::map&lt; std::string, std::string &gt; const &amp;metadata) std::map&lt; std::string, std::string &gt; [getMetadata](classansys_1_1dpf_1_1RuntimeClientConfig.xhtml#afd80c6f61d3503fff0667191937dfae8) () const void [setSecureConnection](classansys_1_1dpf_1_1RuntimeClientConfig.xhtml#aff6f9df92453eff0bea05c9ce2c96a3b) (bool secure) bool [isConnectionSecure](classansys_1_1dpf_1_1RuntimeClientConfig.xhtml#adb4e00bb129ca912c50e719176d29e59) () const <a id="details" name="details"></a>## Detailed Description

enables to set runtime configuration options to DPF [Client](classansys_1_1dpf_1_1Client.xhtml).



## Member Function Documentation

<a id="ab83354eaf4d8646fd7d06e0f5dbdafaf" name="ab83354eaf4d8646fd7d06e0f5dbdafaf"></a>## [◆ ](#ab83354eaf4d8646fd7d06e0f5dbdafaf)enableCache()

 void ansys::dpf::RuntimeClientConfig::enableCache  ( bool  *use\_cache*) 

Sets whether gRPC calls should be intercepted to cache responses or not.





<a id="afd80c6f61d3503fff0667191937dfae8" name="afd80c6f61d3503fff0667191937dfae8"></a>## [◆ ](#afd80c6f61d3503fff0667191937dfae8)getMetadata()

 std::map&lt; std::string, std::string &gt; ansys::dpf::RuntimeClientConfig::getMetadata  ( )  const

Gets the custom metadata appended to gRPC packets.





<a id="a31e99b0bf8468a58ca3b5bcaa1412fe6" name="a31e99b0bf8468a58ca3b5bcaa1412fe6"></a>## [◆ ](#a31e99b0bf8468a58ca3b5bcaa1412fe6)getStreamingBufferSize()

 int ansys::dpf::RuntimeClientConfig::getStreamingBufferSize  ( )  const

Returnsthe chunk size (in bytes) used in gRPC streaming calls. 



<a id="aac0f20eaf4cb412d3ef03d787ac38f06" name="aac0f20eaf4cb412d3ef03d787ac38f06"></a>## [◆ ](#aac0f20eaf4cb412d3ef03d787ac38f06)isCacheEnabled()

 bool ansys::dpf::RuntimeClientConfig::isCacheEnabled  ( )  const

ReturnsWhether gRPC calls are intercepted to cache responses or not. 



<a id="adb4e00bb129ca912c50e719176d29e59" name="adb4e00bb129ca912c50e719176d29e59"></a>## [◆ ](#adb4e00bb129ca912c50e719176d29e59)isConnectionSecure()

 bool ansys::dpf::RuntimeClientConfig::isConnectionSecure  ( )  const

Returns if the gRPC communication is secured by using TLS.





<a id="accdb5f4e700803b8bd6b6cf8cb8623d1" name="accdb5f4e700803b8bd6b6cf8cb8623d1"></a>## [◆ ](#accdb5f4e700803b8bd6b6cf8cb8623d1)setMetadata()

 void ansys::dpf::RuntimeClientConfig::setMetadata  ( std::map&lt; std::string, std::string &gt; const &amp;  *metadata*) 

Sets the custom metadata appended to gRPC packets.





<a id="aff6f9df92453eff0bea05c9ce2c96a3b" name="aff6f9df92453eff0bea05c9ce2c96a3b"></a>## [◆ ](#aff6f9df92453eff0bea05c9ce2c96a3b)setSecureConnection()

 void ansys::dpf::RuntimeClientConfig::setSecureConnection  ( bool  *secure*) 

Sets the use of TLS for secure gRPC connections.





<a id="a380e861289e9683a04ca84c250b0ecf7" name="a380e861289e9683a04ca84c250b0ecf7"></a>## [◆ ](#a380e861289e9683a04ca84c250b0ecf7)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.





<a id="a286701384f2b37237c61f20d1c24eae6" name="a286701384f2b37237c61f20d1c24eae6"></a>## [◆ ](#a286701384f2b37237c61f20d1c24eae6)setStreamingBufferSize()

 void ansys::dpf::RuntimeClientConfig::setStreamingBufferSize  ( int  *size*) 

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





<a id="a38db32f9104c3c2884a734a7cf606ed7" name="a38db32f9104c3c2884a734a7cf606ed7"></a>## [◆ ](#a38db32f9104c3c2884a734a7cf606ed7)streamingFloatsInsteadOfDouble()

 bool ansys::dpf::RuntimeClientConfig::streamingFloatsInsteadOfDouble  ( )  const

ReturnsWhether double values (8 bytes) are converted and streamed as floats values (4 bytes) in gRPC streaming calls.