RTI Connext C# API
6.1.1
|
The base of a typed DataWriter<T>. Provides type-independent methods and properties. More...
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... | |
The base of a typed DataWriter<T>. Provides type-independent methods and properties.
void AssertLiveliness | ( | ) |
This operation manually asserts the liveliness of this DataWriter
The full documentation is available in the C API: DDS_DataWriter_assert_liveliness
void DisposeInstance | ( | in InstanceHandle | instanceHandle | ) |
Requests the middleware to delete the instance.
The full documentation is available in the C API: FooDataWriter_dispose
void DisposeInstance | ( | WriteParams | parameters | ) |
Requests the middleware to delete the instance.
The full documentation is available in the C API: FooDataWriter_dispose
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
|
pure virtual |
Allows calling DataWriter<T>.GetKeyValue in a context where the type is not known.
IEnumerable<SubscriptionBuiltinTopicData> GetMatchedSubscriptionData | ( | ) |
Retrieves the information on all subscriptions that are currently "associated" with this DataWriter.
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
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
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
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
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
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
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
|
pure virtual |
Allows calling DataWriter<T>.LookupInstance in a context where the type is not known.
Implemented in DataWriter< T >.
|
pure virtual |
Calls DataWriter<T>.RegisterInstance(T), but allows doing so in a context where T
is not known.
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 >.
|
pure virtual |
Calls DataWriter<T>.RegisterInstance(T, WriteParams), but allows doing so in a context where T
is not known.
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 >.
|
virtual |
Stop notifying of certain events and remove their event handlers
eventsToRemove | Selects which events will stop receiving notifications. Use StatusMask.All to remove all event handlers. |
Implements Entity.
void UnregisterInstance | ( | in InstanceHandle | instanceHandle | ) |
Reverses the action of RegisterInstanceUntyped(object).
The full documentation is available in the C API: FooDataWriter_unregister_instance
void UnregisterInstance | ( | WriteParams | parameters | ) |
Provides additional parameters to UnregisterInstance(in InstanceHandle).
The full documentation is available in the C API: FooDataWriter_unregister_instance
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
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
|
pure virtual |
Calls DataWriter<T>.Write(T), but allows doing so in a context where T
is not known.
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 >.
|
pure virtual |
Calls DataWriter<T>.Write(T, WriteParams), but allows doing so in a context where T
is not known.
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 >.
|
addremove |
Event triggered when the Rti.Dds.Core.Status.StatusMask.DataWriterApplicationAcknowledgementReceived status changes.
Retrieve the StatusMask.DataWriterCache status.
The full documentation is available in the C API: DDS_DataWriter_get_datawriter_cache_status
Retrieve the StatusMask.DataWriterProtocol status.
The full documentation is available in the C API: DDS_DataWriter_get_datawriter_protocol_status
|
addremove |
Event triggered when the Rti.Dds.Core.Status.StatusMask.DataWriterInstanceReplaced status changes.
|
addremove |
Event triggered when the Rti.Dds.Core.Status.StatusMask.LivelinessLost status changes.
Accesses the StatusMask.LivelinessLost status.
The full documentation is available in the C API: DDS_DataWriter_get_liveliness_lost_status
|
get |
Retrieves the list of subscriptions currently "associated" with this DataWriter.
The full documentation is available in the C API: DDS_DataWriter_get_matched_subscriptions
|
addremove |
Event triggered when the Rti.Dds.Core.Status.StatusMask.OfferedDeadlineMissed status changes.
Accesses the StatusMask.PublicationMatched status.
The full documentation is available in the C API: DDS_DataWriter_get_offered_deadline_missed_status
|
addremove |
Event triggered when the Rti.Dds.Core.Status.StatusMask.OfferedIncompatibleQos status changes.
Accesses the StatusMask.OfferedIncompatibleQos status.
The full documentation is available in the C API: DDS_DataWriter_get_offered_incompatible_qos_status
|
addremove |
Event triggered when the Rti.Dds.Core.Status.StatusMask.PublicationMatched status changes
Accesses the StatusMask.PublicationMatched status.
The full documentation is available in the C API: DDS_DataWriter_get_publication_matched_status
This operation returns the Publisher to which the DataWriter belongs.
The full documentation is available in the C API: DDS_DataWriter_get_publisher
|
getset |
Gets or sets the writer QoS.
The full documentation is available in the C API: DDS_DataWriter_set_qos
|
addremove |
Event triggered when the Rti.Dds.Core.Status.StatusMask.ReliableReaderActivityChanged status changes.
Retrieve the StatusMask.ReliableReaderActivityChanged status.
The full documentation is available in the C API: DDS_DataWriter_get_reliable_reader_activity_changed_status
|
addremove |
Event triggered when the Rti.Dds.Core.Status.StatusMask.ReliableWriterCacheChanged status changes.
Retrieve the StatusMask.ReliableWriterCacheChanged status.
The full documentation is available in the C API: DDS_DataWriter_get_reliable_writer_cache_changed_status
|
addremove |
Event triggered when the Rti.Dds.Core.Status.StatusMask.DataWriterSampleRemoved status changes.
|
addremove |
Event triggered when the Rti.Dds.Core.Status.StatusMask.ServiceRequestAccepted status changes.
Retrieve the StatusMask.ServiceRequestAccepted status.
The full documentation is available in the C API: DDS_DataWriter_get_service_request_accepted_status
|
get |
Returns the type-erased Topic<T> associated with this DataWriter.
Returns DataWriter<T>.Topic