RTI Connext C# API Version 7.2.0
Rti.Dds.Core.Policy.PublishMode Class Reference

Specifies whether a Publication.DataWriter<T> sends data synchronously or asynchronously. More...

Inherits IEquatable< PublishMode >.

Public Member Functions

PublishMode With (Action< PublishModeBuilder > build)
 Creates a new PublishMode with a set of changes specified in an Action More...
 
override int GetHashCode ()
 Gets the hash code More...
 
override bool Equals (object other)
 Compares for equality More...
 
bool Equals (PublishMode other)
 Compares for equality More...
 

Static Public Attributes

const string DefaultFlowControllerName = "DDS_DEFAULT_FLOW_CONTROLLER_NAME"
 Special value for FlowControllerName that refers to the built-in default flow controller. More...
 
const string FixedRateFlowControllerName = "DDS_FIXED_RATE_FLOW_CONTROLLER_NAME"
 Special value for FlowControllerName that refers to the built-in fixed-rate flow controller. More...
 

Properties

PublishModeKind Kind [get]
 Publishing mode More...
 
string FlowControllerName [get]
 Name of the associated flow controller More...
 
int Priority [get]
 Publication priority More...
 
static PublishMode Default [get]
 Singleton containing the default value of a PublishMode More...
 

Detailed Description

Specifies whether a Publication.DataWriter<T> sends data synchronously or asynchronously.

The full documentation is available in the C API: DDS_PublishModeQosPolicy

Member Function Documentation

◆ With()

PublishMode Rti.Dds.Core.Policy.PublishMode.With ( Action< PublishModeBuilder build)
inline

Creates a new PublishMode with a set of changes specified in an Action

Parameters
buildAn Action (typically a lambda function) that receives a modifiable object with the current values of this PublishMode.
Returns
A new PublishMode with the changes applied by the Action

◆ GetHashCode()

override int Rti.Dds.Core.Policy.PublishMode.GetHashCode ( )
inline

Gets the hash code

◆ Equals() [1/2]

override bool Rti.Dds.Core.Policy.PublishMode.Equals ( object  other)

Compares for equality

◆ Equals() [2/2]

bool Rti.Dds.Core.Policy.PublishMode.Equals ( PublishMode  other)
inline

Compares for equality

Field Documentation

◆ DefaultFlowControllerName

const string Rti.Dds.Core.Policy.PublishMode.DefaultFlowControllerName = "DDS_DEFAULT_FLOW_CONTROLLER_NAME"
static

Special value for FlowControllerName that refers to the built-in default flow controller.

The full documentation is available in the C API: DDSFlowControllerDEFAULT_FLOW_CONTROLLER_NAME

◆ FixedRateFlowControllerName

const string Rti.Dds.Core.Policy.PublishMode.FixedRateFlowControllerName = "DDS_FIXED_RATE_FLOW_CONTROLLER_NAME"
static

Special value for FlowControllerName that refers to the built-in fixed-rate flow controller.

The full documentation is available in the C API: DDSFlowControllerFIXED_RATE_FLOW_CONTROLLER_NAME

Property Documentation

◆ Kind

PublishModeKind Rti.Dds.Core.Policy.PublishMode.Kind
get

Publishing mode

The full documentation is available in the C API: DDS_PublishModeQosPolicy_kind

◆ FlowControllerName

string Rti.Dds.Core.Policy.PublishMode.FlowControllerName
get

Name of the associated flow controller

The full documentation is available in the C API: DDS_PublishModeQosPolicy_flow_controller_name

◆ Priority

int Rti.Dds.Core.Policy.PublishMode.Priority
get

Publication priority

See also
Rti.Dds.Core.Priority for special values

The full documentation is available in the C API: DDS_PublishModeQosPolicy_priority

◆ Default

PublishMode Rti.Dds.Core.Policy.PublishMode.Default
staticget

Singleton containing the default value of a PublishMode