RTI Connext .Net APIs  Version 5.2.0
 All Classes Namespaces Functions Variables Enumerations Properties Groups Pages
DDS::FlowControllerProperty_t Class Reference

Determines the flow control characteristics of the DDS::FlowController. More...

#include <managed_flowcontroller.h>

Public Attributes

FlowControllerSchedulingPolicy scheduling_policy
 Scheduling policy.
FlowControllerTokenBucketProperty_t token_bucket
 Settings for the token bucket.

Detailed Description

Determines the flow control characteristics of the DDS::FlowController.

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

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

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_t::DURATION_INFINITE as DDS::FlowControllerTokenBucketProperty_t::period is strictly used to create an on-demand DDS::FlowController. 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

FlowControllerSchedulingPolicy DDS::FlowControllerProperty_t::scheduling_policy

Scheduling policy.

Determines the scheduling policy for servicing the DDS::DataWriter instances associated with the DDS::FlowController.

[default] ::DDS::FlowControllerSchedulingPolicy::EDF_FLOW_CONTROLLER_SCHED_POLICY

FlowControllerTokenBucketProperty_t DDS::FlowControllerProperty_t::token_bucket

Settings for the token bucket.

RTI Connext .Net APIs Version 5.2.0 Copyright © Sun Jun 21 2015 Real-Time Innovations, Inc