RTI Connext Traditional C++ API Version 7.3.0
DDS_FlowControllerProperty_t Struct Reference

Determines the flow control characteristics of the DDSFlowController. More...

Public Attributes

DDS_FlowControllerSchedulingPolicy scheduling_policy
 Scheduling policy. More...
 
struct DDS_FlowControllerTokenBucketProperty_t token_bucket
 Settings for the token bucket. More...
 

Detailed Description

Determines the flow control characteristics of the DDSFlowController.

The flow control characteristics shape the network traffic by determining how often and in what order associated asynchronous DDSDataWriter instances are serviced and how much data they are allowed to send.

Note that these settings apply directly to the DDSFlowController, and do not depend on the number of DDSDataWriter instances the DDSFlowController is servicing. For instance, the specified flow rate does not double simply because two DDSDataWriter instances are waiting to write.

Entity:
DDSFlowController
Properties:
RxO = N/A

Changeable = NO for DDS_FlowControllerProperty_t::scheduling_policy, YES for DDS_FlowControllerProperty_t::token_bucket. However, the special value of DDS_DURATION_INFINITE as DDS_FlowControllerTokenBucketProperty_t::period is strictly used to create an on-demand DDSFlowController. The token period cannot toggle from an infinite to finite value (or vice versa). It can, however, change from one finite value to another.

Member Data Documentation

◆ scheduling_policy

DDS_FlowControllerSchedulingPolicy DDS_FlowControllerProperty_t::scheduling_policy

Scheduling policy.

Determines the scheduling policy for servicing the DDSDataWriter instances associated with the DDSFlowController.

[default] DDS_EDF_FLOW_CONTROLLER_SCHED_POLICY

◆ token_bucket

struct DDS_FlowControllerTokenBucketProperty_t DDS_FlowControllerProperty_t::token_bucket

Settings for the token bucket.