dds_c_flowcontroller.h File Reference

DDS Flow Controller. More...

#include "netio/netio_flowcontroller.h"
#include "dds_c/dds_c_common.h"
#include "dds_c/dds_c_infrastructure.h"

Data Structures
struct	DDS_FlowControllerTokenBucketProperty_t
	DDS_FlowController uses the popular token bucket approach for open loop network flow control. The flow control characteristics are determined by the token bucket properties. More...
struct	DDS_FlowControllerProperty_t
	Determines the flow control characteristics of the DDS_FlowController. More...

Typedefs
typedef struct DDS_FlowController	DDS_FlowController
	<<interface>> A flow controller is the object responsible for shaping the network traffic by determining when attached asynchronous DDS_DataWriter instances are allowed to write data.

Enumerations
enum	DDS_FlowControllerSchedulingPolicy { DDS_RR_FLOW_CONTROLLER_SCHED_POLICY , DDS_EDF_FLOW_CONTROLLER_SCHED_POLICY , DDS_HPF_FLOW_CONTROLLER_SCHED_POLICY }
	Kinds of flow controller scheduling policy. More...

Functions
DDSCDllExport const char *	DDS_FlowController_get_name (DDS_FlowController *self)
	Returns the name of the DDS_FlowController.
DDSCDllExport DDS_DomainParticipant *	DDS_FlowController_get_participant (DDS_FlowController *self)
	Returns the DDS_DomainParticipant to which the DDS_FlowController belongs.
DDSCDllExport DDS_ReturnCode_t	DDS_FlowController_set_property (DDS_FlowController *self, const struct DDS_FlowControllerProperty_t *prop)
	Sets the DDS_FlowController property.
DDSCDllExport DDS_ReturnCode_t	DDS_FlowController_get_property (DDS_FlowController *self, struct DDS_FlowControllerProperty_t *prop)
	Gets the DDS_FlowController property.
DDSCDllExport DDS_ReturnCode_t	DDS_FlowController_trigger_flow (DDS_FlowController *self)
	Provides an external trigger to the DDS_FlowController.
DDSCDllExport DDS_ReturnCode_t	DDS_DomainParticipant_get_default_flowcontroller_property (DDS_DomainParticipant *self, struct DDS_FlowControllerProperty_t *prop)
	<<eXtension>> Copies the default DDS_FlowControllerProperty_t values for this domain participant into the given DDS_FlowControllerProperty_t instance.
DDSCDllExport DDS_ReturnCode_t	DDS_DomainParticipant_set_default_flowcontroller_property (DDS_DomainParticipant *self, const struct DDS_FlowControllerProperty_t *prop)
	<<eXtension>> Set the default DDS_FlowControllerProperty_t values for this domain participant.
DDSCDllExport DDS_FlowController *	DDS_DomainParticipant_create_flowcontroller (DDS_DomainParticipant *self, const char *name, const struct DDS_FlowControllerProperty_t *prop)
	<<eXtension>> Creates a DDS_FlowController with the desired property.
DDSCDllExport DDS_ReturnCode_t	DDS_DomainParticipant_delete_flowcontroller (DDS_DomainParticipant *self, DDS_FlowController *fc)
	<<eXtension>> Deletes an existing DDS_FlowController.
DDSCDllExport DDS_FlowController *	DDS_DomainParticipant_lookup_flowcontroller (DDS_DomainParticipant *self, const char *name)
	<<eXtension>> Looks up an existing locally-created DDS_FlowController, based on its name.

Variables
DDSCDllVariable const char *const	DDS_DEFAULT_FLOW_CONTROLLER_NAME
	[default] Special value of DDS_PublishModeQosPolicy::flow_controller_name that refers to the built-in default flow controller.
DDSCDllVariable const char *const	DDS_FIXED_RATE_FLOW_CONTROLLER_NAME
	Special value of DDS_PublishModeQosPolicy::flow_controller_name that refers to the built-in fixed-rate flow controller.
DDSCDllVariable const char *const	DDS_ON_DEMAND_FLOW_CONTROLLER_NAME
	Special value of DDS_PublishModeQosPolicy::flow_controller_name that refers to the built-in on-demand flow controller.
DDSCDllVariable const struct DDS_FlowControllerProperty_t	DDS_FLOW_CONTROLLER_PROPERTY_DEFAULT
	<<eXtension>> Special value for creating a DDS_FlowController with default property.

Detailed Description

DDS Flow Controller.