Params ex-client
You can use the higher-level IParamsClientEx, which provides convenient caching, synchronization, and simplified parameter access.
After that, you can read all parameters and cache them locally:
You can read or write individual parameters:
Subscribe to received parameter values:
Check synchronization status:
ParamsClientExConfig
Extends ParameterClientConfig with cache update batching.
Property | Type | Default | Description |
|---|---|---|---|
|
|
| Total number of request attempts, including the first attempt. |
|
|
| Timeout for each request attempt, in milliseconds. |
|
|
| Cache update batching interval in milliseconds. Non-positive values disable batching. |
IParamsClientEx
Exposes members to interact with parameters.
Property | Type | Description |
|---|---|---|
|
| Base parameter client interface from which this extension interface is derived. |
|
| Emits each processed incoming parameter value, even if the value is unchanged. |
|
| Indicates if parameters are synchronized with remote device. |
|
| Collection of cached parameters from the remote device. |
|
| Number of parameters reported by the remote device; initially |
|
| Number of parameters in the local cache. |
Method | Return Type | Description |
|---|---|---|
|
| Reads all parameters from remote device and populates cache. |
|
| Reads a parameter from remote device and updates local cache. |
|
| Writes a parameter to remote device and updates local cache. |
|
| Filters parameter changes for a specific parameter name. |
|
| Gets parameter from cache or reads it from remote device. |
IParamsClientEx.ReadAll
Parameter | Type | Description |
|---|---|---|
|
| Optional progress tracker (reports 0.0 to 1.0). |
|
| If true, reads missed parameters individually after bulk read. |
|
| Optional cancellation token. |
IParamsClientEx.ReadOnce
Parameter | Type | Description |
|---|---|---|
|
| Parameter name. |
|
| (Optional) The cancellation token. |
IParamsClientEx.WriteOnce
Parameter | Type | Description |
|---|---|---|
|
| Parameter name (max 16 chars). |
|
| Parameter value to write. |
|
| (Optional) The cancellation token. |
IParamsClientEx.Filter
Parameter | Type | Description |
|---|---|---|
|
| Parameter name to filter for. |
IParamsClientEx.GetFromCacheOrReadOnce
Parameter | Type | Description |
|---|---|---|
|
| Parameter name. |
|
| (Optional) The cancellation token. |