RTI Connext Java API  Version 5.3.1
 All Classes Namespaces Functions Variables Groups Pages
FlowController Interface Reference

<<interface>> A flow controller is the object responsible for shaping the network traffic by determining when attached asynchronous com.rti.dds.publication.DataWriter instances are allowed to write data. More...

Public Member Functions

String get_name ()
 Returns the name of the com.rti.dds.publication.FlowController.
 
DomainParticipant get_participant ()
 Returns the com.rti.dds.domain.DomainParticipant to which the com.rti.dds.publication.FlowController belongs.
 
void set_property (FlowControllerProperty_t prop)
 Sets the com.rti.dds.publication.FlowController property.
 
void get_property (FlowControllerProperty_t prop)
 Gets the com.rti.dds.publication.FlowController property.
 
void trigger_flow ()
 Provides an external trigger to the com.rti.dds.publication.FlowController.
 

Static Public Attributes

static final String DEFAULT_FLOW_CONTROLLER_NAME
 [default] Special value of com.rti.dds.infrastructure.PublishModeQosPolicy.flow_controller_name that refers to the built-in default flow controller.
 
static final String FIXED_RATE_FLOW_CONTROLLER_NAME
 Special value of com.rti.dds.infrastructure.PublishModeQosPolicy.flow_controller_name that refers to the built-in fixed-rate flow controller.
 
static final String ON_DEMAND_FLOW_CONTROLLER_NAME
 Special value of com.rti.dds.infrastructure.PublishModeQosPolicy.flow_controller_name that refers to the built-in on-demand flow controller.
 

Detailed Description

<<interface>> A flow controller is the object responsible for shaping the network traffic by determining when attached asynchronous com.rti.dds.publication.DataWriter instances are allowed to write data.

QoS:
com.rti.dds.publication.FlowControllerProperty_t

Member Function Documentation

String get_name ( )

Returns the name of the com.rti.dds.publication.FlowController.

Returns
The name of the com.rti.dds.publication.FlowController.
void set_property ( FlowControllerProperty_t  prop)

Sets the com.rti.dds.publication.FlowController property.

This operation modifies the property of the com.rti.dds.publication.FlowController.

Once a com.rti.dds.publication.FlowController has been instantiated, only the com.rti.dds.publication.FlowControllerProperty_t.token_bucket can be changed. The com.rti.dds.publication.FlowControllerProperty_t.scheduling_policy is immutable.

A new com.rti.dds.publication.FlowControllerTokenBucketProperty_t.period only takes effect at the next scheduled token distribution time (as determined by its previous value).

Parameters
prop<<in>> The new com.rti.dds.publication.FlowControllerProperty_t. Property must be consistent. Immutable fields cannot be changed after com.rti.dds.publication.FlowController has been created. The special value com.rti.dds.domain.DomainParticipant.FLOW_CONTROLLER_PROPERTY_DEFAULT can be used to indicate that the property of the com.rti.dds.publication.FlowController should be changed to match the current default com.rti.dds.publication.FlowControllerProperty_t set in the com.rti.dds.domain.DomainParticipant. Cannot be NULL.
Exceptions
Oneof the Standard Return Codes, com.rti.dds.infrastructure.RETCODE_IMMUTABLE_POLICY, or com.rti.dds.infrastructure.RETCODE_INCONSISTENT_POLICY.
See Also
com.rti.dds.publication.FlowControllerProperty_t for rules on consistency among property values.
void get_property ( FlowControllerProperty_t  prop)

Gets the com.rti.dds.publication.FlowController property.

Parameters
prop<<in>> com.rti.dds.publication.FlowController to be filled in. Cannot be NULL.
Exceptions
Oneof the Standard Return Codes
void trigger_flow ( )

Provides an external trigger to the com.rti.dds.publication.FlowController.

Typically, a com.rti.dds.publication.FlowController uses an internal trigger to periodically replenish its tokens. The period by which this trigger is called is determined by the com.rti.dds.publication.FlowControllerTokenBucketProperty_t.period property setting.

This function provides an additional, external trigger to the com.rti.dds.publication.FlowController. This trigger adds com.rti.dds.publication.FlowControllerTokenBucketProperty_t.tokens_added_per_period tokens each time it is called (subject to the other property settings of the com.rti.dds.publication.FlowController).

An on-demand com.rti.dds.publication.FlowController can be created with a com.rti.dds.infrastructure.Duration_t.DURATION_INFINITE as com.rti.dds.publication.FlowControllerTokenBucketProperty_t.period, in which case the only trigger source is external (i.e. the FlowController is solely triggered by the user on demand).

com.rti.dds.publication.FlowController.trigger_flow can be called on both strict on-demand FlowController and hybrid FlowController (internally and externally triggered).

Exceptions
Oneof the Standard Return Codes

RTI Connext Java API Version 5.3.1 Copyright © Mon Feb 19 2018 Real-Time Innovations, Inc