QoS policies supported by a Subscriber.
More...
Inherits IEquatable< SubscriberQos >.
QoS policies supported by a Subscriber.
The full documentation is available in the C API: DDS_SubscriberQos
◆ WithPresentation() [1/2]
Creates an instance with a new Presentation policy.
- Parameters
-
- Returns
- A new instance with the same policies as the current instance, except for the one being set
◆ WithPresentation() [2/2]
Creates a new instance with a new Presentation policy as configured by a build action
- Parameters
-
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. |
- Returns
- A new instance with the sames policies as the current instance, except for the policy being modified
◆ WithPartition() [1/2]
Creates an instance with a new Partition policy.
- Parameters
-
- Returns
- A new instance with the same policies as the current instance, except for the one being set
◆ WithPartition() [2/2]
SubscriberQos Rti.Dds.Subscription.SubscriberQos.WithPartition |
( |
Action< ImmutableList< string >.Builder > |
build | ) |
|
Creates a new instance with a new Partition policy as configured by a build action
- Parameters
-
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. |
- Returns
- A new instance with the sames policies as the current instance, except for the policy being modified
◆ WithGroupData() [1/2]
Creates an instance with a new GroupData policy.
- Parameters
-
- Returns
- A new instance with the same policies as the current instance, except for the one being set
◆ WithGroupData() [2/2]
SubscriberQos Rti.Dds.Subscription.SubscriberQos.WithGroupData |
( |
Action< ImmutableList< byte >.Builder > |
build | ) |
|
Creates a new instance with a new GroupData policy as configured by a build action
- Parameters
-
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. |
- Returns
- A new instance with the sames policies as the current instance, except for the policy being modified
◆ WithEntityFactory()
Creates an instance with a new EntityFactory policy.
- Parameters
-
- Returns
- A new instance with the same policies as the current instance, except for the one being set
◆ WithExclusiveArea() [1/2]
Creates an instance with a new ExclusiveArea policy.
- Parameters
-
- Returns
- A new instance with the same policies as the current instance, except for the one being set
◆ WithExclusiveArea() [2/2]
Creates a new instance with a new ExclusiveArea policy as configured by a build action
- Parameters
-
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. |
- Returns
- A new instance with the sames policies as the current instance, except for the policy being modified
◆ WithSubscriberName() [1/2]
Creates an instance with a new SubscriberName policy.
- Parameters
-
- Returns
- A new instance with the same policies as the current instance, except for the one being set
◆ WithSubscriberName() [2/2]
Creates a new instance with a new SubscriberName policy as configured by a build action
- Parameters
-
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. |
- Returns
- A new instance with the sames policies as the current instance, except for the policy being modified
◆ Equals() [1/2]
bool Rti.Dds.Subscription.SubscriberQos.Equals |
( |
SubscriberQos |
other | ) |
|
|
inline |
Compares all the policies for equality
◆ GetHashCode()
override int Rti.Dds.Subscription.SubscriberQos.GetHashCode |
( |
| ) |
|
|
inline |
Returns the hash code by combining that of each policy
◆ Equals() [2/2]
override bool Rti.Dds.Subscription.SubscriberQos.Equals |
( |
object |
obj | ) |
|
Compares all the policies for equality
◆ ToString() [1/4]
override string Rti.Dds.Subscription.SubscriberQos.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.
◆ ToString() [2/4]
string Rti.Dds.Subscription.SubscriberQos.ToString |
( |
QosPrintFormat |
format | ) |
|
Returns an XML representation of the QoS object.
- Parameters
-
format | The baseQos profile. |
This overload accepts a value for the baseQos. Only the differences between the SubscriberQos object being printed and the baseQos are included in the output.
◆ ToString() [3/4]
Returns an XML representation of the QoS object.
- Parameters
-
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 SubscriberQos object being printed and the baseQos are included in the output.
◆ ToString() [4/4]
Returns an XML representation of the QoS object.
- Parameters
-
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.
◆ Default
◆ Presentation
Presentation Rti.Dds.Subscription.SubscriberQos.Presentation |
|
get |
◆ Partition
Partition Rti.Dds.Subscription.SubscriberQos.Partition |
|
get |
◆ GroupData
GroupData Rti.Dds.Subscription.SubscriberQos.GroupData |
|
get |
◆ EntityFactory
◆ ExclusiveArea
◆ SubscriberName
EntityName Rti.Dds.Subscription.SubscriberQos.SubscriberName |
|
get |
Gets the EntityName policy.