The base of a typed DataWriter<T>. Provides type-independent methods and properties. More...

Inheritance diagram for AnyDataWriter:

Public Member Functions
abstract void	WriteUntyped (object sample)
	Calls DataWriter<T>.Write(T), but allows doing so in a context where `T` is not known. More...

abstract void	WriteUntyped (object sample, WriteParams writeParams)
	Calls DataWriter<T>.Write(T, WriteParams), but allows doing so in a context where `T` is not known. More...

abstract InstanceHandle	RegisterInstanceUntyped (object sample)
	Calls DataWriter<T>.RegisterInstance(T), but allows doing so in a context where `T` is not known. More...

abstract InstanceHandle	RegisterInstanceUntyped (object sample, WriteParams parameters)
	Calls DataWriter<T>.RegisterInstance(T, WriteParams), but allows doing so in a context where `T` is not known. More...

void	DisposeInstance (in InstanceHandle instanceHandle)
	Requests the middleware to delete the instance. More...

void	DisposeInstance (WriteParams parameters)
	Requests the middleware to delete the instance. More...

void	UnregisterInstance (in InstanceHandle instanceHandle)
	Reverses the action of RegisterInstanceUntyped(object). More...

void	UnregisterInstance (WriteParams parameters)
	Provides additional parameters to UnregisterInstance(in InstanceHandle). More...

abstract InstanceHandle	LookupInstanceUntyped (object keyHolder)
	Allows calling DataWriter<T>.LookupInstance in a context where the type is not known. More...

abstract object	GetKeyValueUntyped (object keyHolder, in InstanceHandle InstanceHandle)
	Allows calling DataWriter<T>.GetKeyValue in a context where the type is not known. More...

SubscriptionBuiltinTopicData	GetMatchedSubscriptionData (in InstanceHandle subscriptionHandle)
	Retrieves the information on a subscription that is currently "associated" with this DataWriter. More...

IEnumerable< SubscriptionBuiltinTopicData >	GetMatchedSubscriptionData ()
	Retrieves the information on all subscriptions that are currently "associated" with this DataWriter. More...

ParticipantBuiltinTopicData	GetMatchedSubscriptionParticipantData (in InstanceHandle subscriptionHandle)
	Retrieves the information on the discovered Domain.DomainParticipant associated with the subscription that is currently matching with the DataWriter<T> More...

bool	IsMatchedSubscriptionActive (in InstanceHandle subscriptionHandle)
	Check if a subscription currently matched with a DataWriter<T> is active. More...

IEnumerable< Locator >	GetMatchedSubscriptionLocators ()
	Retrieves a list of Locator for subscriptions currently matched with the DataWriter<T>. More...

void	WaitForAcknowledgments (Duration maxWait)
	Blocks the calling thread until all data written by a reliable writer is acknowledged, or until the maxWait expires. More...

void	WaitForAsynchronousPublishing (Duration maxWait)
	Blocks the calling thread until asynchronous sending is completed. More...

bool	IsSampleAppAcknowledged (in SampleIdentity sampleId)
	Indicates if a sample has been acknowledged by the subscribing applications. More...

void	AssertLiveliness ()
	This operation manually asserts the liveliness of this DataWriter More...

DataWriterProtocolStatus	GetMatchedSubscriptionDataWriterProtocolStatus (in InstanceHandle subscriptionHandle)
	Get the protocol status for this DataWriter, per matched subscription identified by the subscriptionHandle. More...

DataWriterProtocolStatus	GetMatchedSubscriptionDataWriterProtocolStatus (Locator subscriptionLocator)
	Get the protocol status for this DataWriter, per matched subscription identified by the locator. More...

void	Flush ()
	Flushes the batch in progress in the context of the calling thread. More...

override void	ResetEvents (StatusMask eventsToRemove=StatusMask.All)
	Stop notifying of certain events and remove their event handlers More...

Public Member Functions inherited from Entity
void	Enable ()
	Enables this Entity (by default entities are automatically enabled after creation) More...

EntityLock	Lock ()
	Locks the Entity using its internal lock. More...

void	Dispose ()
	Releases the resources used by this Entity and disposes its contained entities as well (if any). More...

Properties
abstract IAnyTopic	TopicUntyped `[get]`
	Returns the type-erased Topic<T> associated with this DataWriter. More...

DataWriterQos	Qos `[get, set]`
	Gets or sets the writer QoS. More...

abstract Publisher	Publisher `[get]`
	This operation returns the Publisher to which the DataWriter belongs. More...

IEnumerable< InstanceHandle >	MatchedSubscriptions `[get]`
	Retrieves the list of subscriptions currently "associated" with this DataWriter. More...

LivelinessLostStatus	LivelinessLostStatus `[get]`
	Accesses the StatusMask.LivelinessLost status. More...

OfferedDeadlineMissedStatus	OfferedDeadlineMissedStatus `[get]`
	Accesses the StatusMask.PublicationMatched status. More...

OfferedIncompatibleQosStatus	OfferedIncompatibleQosStatus `[get]`
	Accesses the StatusMask.OfferedIncompatibleQos status. More...

PublicationMatchedStatus	PublicationMatchedStatus `[get]`
	Accesses the StatusMask.PublicationMatched status. More...

DataWriterProtocolStatus	DataWriterProtocolStatus `[get]`
	Retrieve the StatusMask.DataWriterProtocol status. More...

DataWriterCacheStatus	DataWriterCacheStatus `[get]`
	Retrieve the StatusMask.DataWriterCache status. More...

ReliableReaderActivityChangedStatus	ReliableReaderActivityChangedStatus `[get]`
	Retrieve the StatusMask.ReliableReaderActivityChanged status. More...

ReliableWriterCacheChangedStatus	ReliableWriterCacheChangedStatus `[get]`
	Retrieve the StatusMask.ReliableWriterCacheChanged status. More...

ServiceRequestAcceptedStatus	ServiceRequestAcceptedStatus `[get]`
	Retrieve the StatusMask.ServiceRequestAccepted status. More...

LivelinessLostEventHandler	LivelinessLost
	Event triggered when the Rti.Dds.Core.Status.StatusMask.LivelinessLost status changes. More...

OfferedIncompatibleQosEventHandler	OfferedIncompatibleQos
	Event triggered when the Rti.Dds.Core.Status.StatusMask.OfferedIncompatibleQos status changes. More...

OfferedDeadlineMissedEventHandler	OfferedDeadlineMissed
	Event triggered when the Rti.Dds.Core.Status.StatusMask.OfferedDeadlineMissed status changes. More...

PublicationMatchedEventHandler	PublicationMatched
	Event triggered when the Rti.Dds.Core.Status.StatusMask.PublicationMatched status changes More...

ReliableReaderActivityChangedEventHandler	ReliableReaderActivityChanged
	Event triggered when the Rti.Dds.Core.Status.StatusMask.ReliableReaderActivityChanged status changes. More...

ReliableWriterCacheChangedEventHandler	ReliableWriterCacheChanged
	Event triggered when the Rti.Dds.Core.Status.StatusMask.ReliableWriterCacheChanged status changes. More...

ServiceRequestAcceptedEventHandler	ServiceRequestAccepted
	Event triggered when the Rti.Dds.Core.Status.StatusMask.ServiceRequestAccepted status changes. More...

ApplicationAcknowledgementReceivedEventHandler	ApplicationAcknowledgementReceived
	Event triggered when the Rti.Dds.Core.Status.StatusMask.DataWriterApplicationAcknowledgementReceived status changes. More...

InstanceReplacedEventHandler	InstanceReplaced
	Event triggered when the Rti.Dds.Core.Status.StatusMask.DataWriterInstanceReplaced status changes. More...

SampleRemovedEventHandler	SampleRemoved
	Event triggered when the Rti.Dds.Core.Status.StatusMask.DataWriterSampleRemoved status changes. More...

Properties inherited from Entity
InstanceHandle	InstanceHandle `[get]`
	Gets the InstanceHandle that identifies this Entity More...

StatusMask	StatusChanges `[get]`
	Retrieves the list of communication statuses in this Entity that are triggered. More...

StatusCondition	StatusCondition `[get]`
	Gets the StatusCondition associated with this Entity. More...

bool	Enabled `[get]`
	Indicates whether this Entity is enabled. More...

bool	Disposed `[get]`
	Indicates whether this Entity has already been disposed. More...

Detailed Description

The base of a typed DataWriter<T>. Provides type-independent methods and properties.

Member Function Documentation

◆ AssertLiveliness()

void AssertLiveliness ( )

This operation manually asserts the liveliness of this DataWriter

The full documentation is available in the C API: DDS_DataWriter_assert_liveliness

◆ DisposeInstance() [1/2]

void DisposeInstance ( in InstanceHandle instanceHandle )

Requests the middleware to delete the instance.

The full documentation is available in the C API: FooDataWriter_dispose

◆ DisposeInstance() [2/2]

void DisposeInstance ( WriteParams parameters )

Requests the middleware to delete the instance.

The full documentation is available in the C API: FooDataWriter_dispose

◆ Flush()

void Flush ( )

Flushes the batch in progress in the context of the calling thread.

The full documentation is available in the C API: DDS_DataWriter_flush

◆ GetKeyValueUntyped()

abstract object GetKeyValueUntyped	(	object	keyHolder,
		in InstanceHandle	InstanceHandle
	)

pure virtual

Allows calling DataWriter<T>.GetKeyValue in a context where the type is not known.

Returns: The key values corresponding to the provided instance handle.

◆ GetMatchedSubscriptionData() [1/2]

IEnumerable<SubscriptionBuiltinTopicData> GetMatchedSubscriptionData ( )

Retrieves the information on all subscriptions that are currently "associated" with this DataWriter.

◆ GetMatchedSubscriptionData() [2/2]

SubscriptionBuiltinTopicData GetMatchedSubscriptionData ( in InstanceHandle subscriptionHandle )

Retrieves the information on a subscription that is currently "associated" with this DataWriter.

The full documentation is available in the C API: DDS_DataWriter_get_matched_subscription_data

◆ GetMatchedSubscriptionDataWriterProtocolStatus() [1/2]

DataWriterProtocolStatus GetMatchedSubscriptionDataWriterProtocolStatus ( in InstanceHandle subscriptionHandle )

Get the protocol status for this DataWriter, per matched subscription identified by the subscriptionHandle.

The full documentation is available in the C API: DDS_DataWriter_get_matched_subscription_datawriter_protocol_status

◆ GetMatchedSubscriptionDataWriterProtocolStatus() [2/2]

DataWriterProtocolStatus GetMatchedSubscriptionDataWriterProtocolStatus ( Locator subscriptionLocator )

Get the protocol status for this DataWriter, per matched subscription identified by the locator.

The full documentation is available in the C API: DDS_DataWriter_get_matched_subscription_datawriter_protocol_status_by_locator

◆ GetMatchedSubscriptionLocators()

IEnumerable<Locator> GetMatchedSubscriptionLocators ( )

Retrieves a list of Locator for subscriptions currently matched with the DataWriter<T>.

The full documentation is available in the C API: DDS_DataWriter_get_matched_subscription_locators

◆ GetMatchedSubscriptionParticipantData()

ParticipantBuiltinTopicData GetMatchedSubscriptionParticipantData ( in InstanceHandle subscriptionHandle )

Retrieves the information on the discovered Domain.DomainParticipant associated with the subscription that is currently matching with the DataWriter<T>

The full documentation is available in the C API: DDS_DataWriter_get_matched_subscription_participant_data

◆ IsMatchedSubscriptionActive()

bool IsMatchedSubscriptionActive ( in InstanceHandle subscriptionHandle )

Check if a subscription currently matched with a DataWriter<T> is active.

The full documentation is available in the C API: DDS_DataWriter_is_matched_subscription_active

◆ IsSampleAppAcknowledged()

bool IsSampleAppAcknowledged ( in SampleIdentity sampleId )

Indicates if a sample has been acknowledged by the subscribing applications.

The full documentation is available in the C API: DDS_DataWriter_is_sample_app_acknowledged

◆ LookupInstanceUntyped()

abstract InstanceHandle LookupInstanceUntyped ( object keyHolder )

pure virtual

Allows calling DataWriter<T>.LookupInstance in a context where the type is not known.

Returns: The InstanceHandle corresponding to the provided keyholder. The runtime type of the keyholder must match that of the actual DataWriter<T> otherwise this operation throws InvalidCastException.

Implemented in DataWriter< T >.

◆ RegisterInstanceUntyped() [1/2]

abstract InstanceHandle RegisterInstanceUntyped ( object sample )

pure virtual

Calls DataWriter<T>.RegisterInstance(T), but allows doing so in a context where T is not known.

Parameters

sample The instance to register. Its runtime type must be the type of the actual DataWriter<T>. Otherwise this operation throws InvalidCastException.

Implemented in DataWriter< T >.

◆ RegisterInstanceUntyped() [2/2]

abstract InstanceHandle RegisterInstanceUntyped	(	object	sample,
		WriteParams	parameters
	)

pure virtual

Calls DataWriter<T>.RegisterInstance(T, WriteParams), but allows doing so in a context where T is not known.

Parameters

sample	The instance to register. Its runtime type must be the type of the actual DataWriter<T>. Otherwise this operation throws InvalidCastException.
parameters	Configures the register operation

Implemented in DataWriter< T >.

◆ ResetEvents()

override void ResetEvents ( StatusMask eventsToRemove = StatusMask.All )

virtual

Stop notifying of certain events and remove their event handlers

Parameters

eventsToRemove Selects which events will stop receiving notifications. Use StatusMask.All to remove all event handlers.

Implements Entity.

◆ UnregisterInstance() [1/2]

void UnregisterInstance ( in InstanceHandle instanceHandle )

Reverses the action of RegisterInstanceUntyped(object).

The full documentation is available in the C API: FooDataWriter_unregister_instance

◆ UnregisterInstance() [2/2]

void UnregisterInstance ( WriteParams parameters )

Provides additional parameters to UnregisterInstance(in InstanceHandle).

The full documentation is available in the C API: FooDataWriter_unregister_instance

◆ WaitForAcknowledgments()

void WaitForAcknowledgments ( Duration maxWait )

Blocks the calling thread until all data written by a reliable writer is acknowledged, or until the maxWait expires.

The full documentation is available in the C API: DDS_DataWriter_wait_for_acknowledgments

◆ WaitForAsynchronousPublishing()

void WaitForAsynchronousPublishing ( Duration maxWait )

Blocks the calling thread until asynchronous sending is completed.

The full documentation is available in the C API: DDS_DataWriter_wait_for_asynchronous_publishing

◆ WriteUntyped() [1/2]

abstract void WriteUntyped ( object sample )

pure virtual

Calls DataWriter<T>.Write(T), but allows doing so in a context where T is not known.

Parameters

sample The data to write. Its runtime type must be the type of the actual DataWriter<T>. Otherwise this operation throws InvalidCastException.

Implemented in DataWriter< T >.

◆ WriteUntyped() [2/2]

abstract void WriteUntyped	(	object	sample,
		WriteParams	writeParams
	)

pure virtual

Calls DataWriter<T>.Write(T, WriteParams), but allows doing so in a context where T is not known.

Parameters

sample	The data to write. Its runtime type must be the type of the actual DataWriter<T>. Otherwise this operation throws InvalidCastException.
writeParams	Configures the write operation

Implemented in DataWriter< T >.