RTI Connext C# API
7.0.0
|
QoS policies supported by a Publisher. More...
Inherits IEquatable< PublisherQos >.
Public Member Functions | |
PublisherQos | WithPresentation (Presentation policy) |
Creates an instance with a new Presentation policy. More... | |
PublisherQos | WithPresentation (Action< PresentationBuilder > build) |
Creates a new instance with a new Presentation policy as configured by a build action More... | |
PublisherQos | WithPartition (Partition policy) |
Creates an instance with a new Partition policy. More... | |
PublisherQos | WithPartition (Action< ImmutableList< string >.Builder > build) |
Creates a new instance with a new Partition policy as configured by a build action More... | |
PublisherQos | WithGroupData (GroupData policy) |
Creates an instance with a new GroupData policy. More... | |
PublisherQos | WithGroupData (Action< ImmutableList< byte >.Builder > build) |
Creates a new instance with a new GroupData policy as configured by a build action More... | |
PublisherQos | WithEntityFactory (EntityFactory policy) |
Creates an instance with a new EntityFactory policy. More... | |
PublisherQos | WithAsynchronousPublisher (AsynchronousPublisher policy) |
Creates an instance with a new AsynchronousPublisher policy. More... | |
PublisherQos | WithAsynchronousPublisher (Action< AsynchronousPublisherBuilder > build) |
Creates a new instance with a new AsynchronousPublisher policy as configured by a build action More... | |
PublisherQos | WithExclusiveArea (ExclusiveArea policy) |
Creates an instance with a new ExclusiveArea policy. More... | |
PublisherQos | WithExclusiveArea (Action< ExclusiveAreaBuilder > build) |
Creates a new instance with a new ExclusiveArea policy as configured by a build action More... | |
PublisherQos | WithPublisherName (EntityName policy) |
Creates an instance with a new PublisherName policy. More... | |
PublisherQos | WithPublisherName (Action< EntityNameBuilder > build) |
Creates a new instance with a new PublisherName policy as configured by a build action More... | |
bool | Equals (PublisherQos other) |
Compares all the policies for equality More... | |
override int | GetHashCode () |
Returns the hash code by combining that of each policy More... | |
override bool | Equals (object obj) |
Compares all the policies for equality More... | |
override string | ToString () |
Returns an XML representation of the QoS object. More... | |
string | ToString (QosPrintFormat format) |
Returns an XML representation of the QoS object. More... | |
string | ToString (PublisherQos baseQos, QosPrintFormat format=null) |
Returns an XML representation of the QoS object. More... | |
string | ToString (QosPrintAll baseQos, QosPrintFormat format=null) |
Returns an XML representation of the QoS object. More... | |
Properties | |
static PublisherQos | Default [get] |
Singleton containing the documented default value of a PublisherQos More... | |
Presentation | Presentation [get] |
Gets the Presentation policy. More... | |
Partition | Partition [get] |
Gets the Partition policy. More... | |
GroupData | GroupData [get] |
Gets the GroupData policy. More... | |
EntityFactory | EntityFactory [get] |
Gets the EntityFactory policy. More... | |
AsynchronousPublisher | AsynchronousPublisher [get] |
Gets the AsynchronousPublisher policy. More... | |
ExclusiveArea | ExclusiveArea [get] |
Gets the ExclusiveArea policy. More... | |
EntityName | PublisherName [get] |
Gets the EntityName policy. More... | |
QoS policies supported by a Publisher.
The full documentation is available in the C API: DDS_PublisherQos
override bool Equals | ( | object | obj | ) |
Compares all the policies for equality
bool Equals | ( | PublisherQos | other | ) |
Compares all the policies for equality
override int GetHashCode | ( | ) |
Returns the hash code by combining that of each policy
override string ToString | ( | ) |
Returns an XML representation of the QoS object.
The output is formatted using the default values for the QosPrintFormat and only QoS policies which differ from the documented default are included.
string ToString | ( | PublisherQos | baseQos, |
QosPrintFormat | format = null |
||
) |
Returns an XML representation of the QoS object.
baseQos | The baseQos profile. |
format | the format used to configure the output. If not supplied the output is formatted using the default format. |
This overload accepts a value for the baseQos. Only the differences between the PublisherQos object being printed and the baseQos are included in the output.
string ToString | ( | QosPrintAll | baseQos, |
QosPrintFormat | format = null |
||
) |
Returns an XML representation of the QoS object.
baseQos | Used to indicate that the entire QoS object should be included in the output. The only value which should be provided for this argument is QosPrintAll.Value |
format | The format used to configure the output. If not supplied, the output is formatted using the default format. |
This overload accepts a parameter of type QosPrintAll. Unlike the other ToString overloads, the entire QoS object will be included in the output.
string ToString | ( | QosPrintFormat | format | ) |
Returns an XML representation of the QoS object.
format | The baseQos profile. |
This overload accepts a value for the baseQos. Only the differences between the PublisherQos object being printed and the baseQos are included in the output.
PublisherQos WithAsynchronousPublisher | ( | Action< AsynchronousPublisherBuilder > | build | ) |
Creates a new instance with a new AsynchronousPublisher policy as configured by a build action
build | A function receiving the current values of the policy as an argument. The changes performed by this build function will be used to create the new policy. |
PublisherQos WithAsynchronousPublisher | ( | AsynchronousPublisher | policy | ) |
Creates an instance with a new AsynchronousPublisher policy.
policy | The new policy |
PublisherQos WithEntityFactory | ( | EntityFactory | policy | ) |
Creates an instance with a new EntityFactory policy.
policy | The new policy |
PublisherQos WithExclusiveArea | ( | Action< ExclusiveAreaBuilder > | build | ) |
Creates a new instance with a new ExclusiveArea policy as configured by a build action
build | A function receiving the current values of the policy as an argument. The changes performed by this build function will be used to create the new policy. |
PublisherQos WithExclusiveArea | ( | ExclusiveArea | policy | ) |
Creates an instance with a new ExclusiveArea policy.
policy | The new policy |
PublisherQos WithGroupData | ( | Action< ImmutableList< byte >.Builder > | build | ) |
Creates a new instance with a new GroupData policy as configured by a build action
build | A function receiving the current values of the policy as an argument. The changes performed by this build function will be used to create the new policy. |
PublisherQos WithGroupData | ( | GroupData | policy | ) |
Creates an instance with a new GroupData policy.
policy | The new policy |
PublisherQos WithPartition | ( | Action< ImmutableList< string >.Builder > | build | ) |
Creates a new instance with a new Partition policy as configured by a build action
build | A function receiving the current values of the policy as an argument. The changes performed by this build function will be used to create the new policy. |
PublisherQos WithPartition | ( | Partition | policy | ) |
Creates an instance with a new Partition policy.
policy | The new policy |
PublisherQos WithPresentation | ( | Action< PresentationBuilder > | build | ) |
Creates a new instance with a new Presentation policy as configured by a build action
build | A function receiving the current values of the policy as an argument. The changes performed by this build function will be used to create the new policy. |
PublisherQos WithPresentation | ( | Presentation | policy | ) |
Creates an instance with a new Presentation policy.
policy | The new policy |
PublisherQos WithPublisherName | ( | Action< EntityNameBuilder > | build | ) |
Creates a new instance with a new PublisherName policy as configured by a build action
build | A function receiving the current values of the policy as an argument. The changes performed by this build function will be used to create the new policy. |
PublisherQos WithPublisherName | ( | EntityName | policy | ) |
Creates an instance with a new PublisherName policy.
policy | The new policy |
Gets the AsynchronousPublisher policy.
|
staticget |
Singleton containing the documented default value of a PublisherQos
This is a static value containing the documented default values for each policy. Use Domain.DomainParticipant.DefaultPublisherQos for the runtime default value that takes into consideration the current configuration.
Gets the EntityFactory policy.
Gets the ExclusiveArea policy.
Gets the Presentation policy.
|
get |
Gets the EntityName policy.