Rti.Dds.Core.Status.DataWriterProtocolStatus Class Reference

The status of a writer's internal protocol related metrics, like the number of samples pushed and pulled; and status of wire protocol traffic. More...

Inherits IEquatable< DataWriterProtocolStatus >.

Public Member Functions
override int	GetHashCode ()
	Gets the hash code More...
override bool	Equals (object other)
	Compares for equality More...
bool	Equals (DataWriterProtocolStatus other)
	Compares for equality More...
override string	ToString ()
	Returns a readable summary of the status More...

Properties
EventCount< long >	PushedSampleCount [get]
	The number of user samples pushed on write from a local DataWriter to a matching remote DataReader. More...
EventCount< long >	PushedSampleBytes [get]
	The number of bytes of user samples pushed on write from a local DataWriter to a matching remote DataReader. More...
EventCount< long >	SentHeartbeatCount [get]
	The number of Heartbeats sent between a local DataWriter and matching remote DataReader. More...
EventCount< long >	SentHeartbeatBytes [get]
	The number of bytes of Heartbeats sent between a local DataWriter and matching remote DataReader. More...
EventCount< long >	PulledSampleCount [get]
	The number of user samples pulled from local DataWriter by matching DataReaders. More...
EventCount< long >	PulledSampleBytes [get]
	The number of bytes of user samples pulled from local DataWriter by matching DataReaders. More...
EventCount< long >	ReceivedAckCount [get]
	The number of ACKs from a remote DataReader received by a local DataWriter. More...
EventCount< long >	ReceivedAckBytes [get]
	The number of bytes of ACKs from a remote DataReader received by a local DataWriter. More...
EventCount< long >	ReceivedNackCount [get]
	The number of NACKs from a remote DataReader received by a local DataWriter. More...
EventCount< long >	ReceivedNackBytes [get]
	The number of bytes of NACKs from a remote DataReader received by a local DataWriter. More...
EventCount< long >	SentGapCount [get]
	The number of GAPs sent from local DataWriter to matching remote DataReaders. More...
EventCount< long >	SentGapBytes [get]
	The number of bytes of GAPs sent from local DataWriter to matching remote DataReaders. More...
EventCount< long >	RejectedSampleCount [get]
	Not supported More...
int	SendWindowSize [get]
	Current maximum number of outstanding samples allowed in the DataWriter's queue. More...
long	FirstAvailableSampleSequenceNumber [get]
	The sequence number of the first available sample currently queued in the local DataWriter. More...
long	LastAvailableSampleSequenceNumber [get]
	The sequence number of the last available sample currently queued in the local DataWriter. More...
long	FirstUnacknowledgedSampleSequenceNumber [get]
	The sequence number of the first unacknowledged sample currently queued in the local DataWriter. More...
long	FirstAvailableSampleVirtualSequenceNumber [get]
	The virtual sequence number of the first available sample currently queued in the local DataWriter. More...
long	LastAvailableSampleVirtualSequenceNumber [get]
	The virtual sequence number of the last available sample currently queued in the local DataWriter. More...
long	FirstUnacknowledgedSampleVirtualSequenceNumber [get]
	The virtual sequence number of the first unacknowledged sample currently queued in the local DataWriter. More...
InstanceHandle	FirstUnacknowledgedSampleSubscriptionHandle [get]
	The handle of a remote DataReader that has not acknowledged the first unacknowledged sample of the local DataWriter. More...
long	FirstUnelapsedKeepDurationSampleSequenceNumber [get]
	The sequence number of the first sample whose keep duration has not yet elapsed. More...
long	PushedFragmentCount [get]
	The number of DATA_FRAG messages that have been pushed by this DataWriter. More...
long	PushedFragmentBytes [get]
	The number of bytes of DATA_FRAG messages that have been pushed by this DataWriter. More...
long	PulledFragmentCount [get]
	The number of DATA_FRAG messages that have been pulled from this DataWriter. More...
long	PulledFragmentBytes [get]
	The number of bytes of DATA_FRAG messages that have been pulled from this DataWriter. More...
long	ReceivedNackFragmentCount [get]
	The number of NACK_FRAG messages that have been received by this DataWriter. More...
long	ReceivedNackFragmentBytes [get]
	The number of bytes of NACK_FRAG messages that have been received by this DataWriter. More...

Detailed Description

The status of a writer's internal protocol related metrics, like the number of samples pushed and pulled; and status of wire protocol traffic.

The full documentation is available in the C API: DDS_DataWriterProtocolStatus

Member Function Documentation

GetHashCode()

override int Rti.Dds.Core.Status.DataWriterProtocolStatus.GetHashCode ( )

inline

Gets the hash code

Equals() [1/2]

override bool Rti.Dds.Core.Status.DataWriterProtocolStatus.Equals

(

object

other

)

Compares for equality

Equals() [2/2]

bool Rti.Dds.Core.Status.DataWriterProtocolStatus.Equals ( DataWriterProtocolStatus  other )

inline

Compares for equality

ToString()

override string Rti.Dds.Core.Status.DataWriterProtocolStatus.ToString

(

)

Returns a readable summary of the status

Property Documentation

PushedSampleCount

EventCount<long> Rti.Dds.Core.Status.DataWriterProtocolStatus.PushedSampleCount

get

The number of user samples pushed on write from a local DataWriter to a matching remote DataReader.

The full documentation is available in the C API: DDS_DataWriterProtocolStatus_pushed_sample_count

PushedSampleBytes

EventCount<long> Rti.Dds.Core.Status.DataWriterProtocolStatus.PushedSampleBytes

get

The number of bytes of user samples pushed on write from a local DataWriter to a matching remote DataReader.

The full documentation is available in the C API: DDS_DataWriterProtocolStatus_pushed_sample_bytes

SentHeartbeatCount

EventCount<long> Rti.Dds.Core.Status.DataWriterProtocolStatus.SentHeartbeatCount

get

The number of Heartbeats sent between a local DataWriter and matching remote DataReader.

The full documentation is available in the C API: DDS_DataWriterProtocolStatus_sent_heartbeat_count

SentHeartbeatBytes

EventCount<long> Rti.Dds.Core.Status.DataWriterProtocolStatus.SentHeartbeatBytes

get

The number of bytes of Heartbeats sent between a local DataWriter and matching remote DataReader.

The full documentation is available in the C API: DDS_DataWriterProtocolStatus_sent_heartbeat_bytes

PulledSampleCount

EventCount<long> Rti.Dds.Core.Status.DataWriterProtocolStatus.PulledSampleCount

get

The number of user samples pulled from local DataWriter by matching DataReaders.

The full documentation is available in the C API: DDS_DataWriterProtocolStatus_pulled_sample_count

PulledSampleBytes

EventCount<long> Rti.Dds.Core.Status.DataWriterProtocolStatus.PulledSampleBytes

get

The number of bytes of user samples pulled from local DataWriter by matching DataReaders.

The full documentation is available in the C API: DDS_DataWriterProtocolStatus_pulled_sample_bytes

ReceivedAckCount

EventCount<long> Rti.Dds.Core.Status.DataWriterProtocolStatus.ReceivedAckCount

get

The number of ACKs from a remote DataReader received by a local DataWriter.

The full documentation is available in the C API: DDS_DataWriterProtocolStatus_received_ack_count

ReceivedAckBytes

EventCount<long> Rti.Dds.Core.Status.DataWriterProtocolStatus.ReceivedAckBytes

get

The number of bytes of ACKs from a remote DataReader received by a local DataWriter.

The full documentation is available in the C API: DDS_DataWriterProtocolStatus_received_ack_bytes

ReceivedNackCount

EventCount<long> Rti.Dds.Core.Status.DataWriterProtocolStatus.ReceivedNackCount

get

The number of NACKs from a remote DataReader received by a local DataWriter.

The full documentation is available in the C API: DDS_DataWriterProtocolStatus_received_nack_count

ReceivedNackBytes

EventCount<long> Rti.Dds.Core.Status.DataWriterProtocolStatus.ReceivedNackBytes

get

The number of bytes of NACKs from a remote DataReader received by a local DataWriter.

The full documentation is available in the C API: DDS_DataWriterProtocolStatus_received_nack_bytes

SentGapCount

EventCount<long> Rti.Dds.Core.Status.DataWriterProtocolStatus.SentGapCount

get

The number of GAPs sent from local DataWriter to matching remote DataReaders.

The full documentation is available in the C API: DDS_DataWriterProtocolStatus_sent_gap_count

SentGapBytes

EventCount<long> Rti.Dds.Core.Status.DataWriterProtocolStatus.SentGapBytes

get

The number of bytes of GAPs sent from local DataWriter to matching remote DataReaders.

The full documentation is available in the C API: DDS_DataWriterProtocolStatus_sent_gap_bytes

RejectedSampleCount

EventCount<long> Rti.Dds.Core.Status.DataWriterProtocolStatus.RejectedSampleCount

get

Not supported

The full documentation is available in the C API: DDS_DataWriterProtocolStatus_rejected_sample_count

SendWindowSize

int Rti.Dds.Core.Status.DataWriterProtocolStatus.SendWindowSize

get

Current maximum number of outstanding samples allowed in the DataWriter's queue.

The full documentation is available in the C API: DDS_DataWriterProtocolStatus_send_window_size

FirstAvailableSampleSequenceNumber

long Rti.Dds.Core.Status.DataWriterProtocolStatus.FirstAvailableSampleSequenceNumber

get

The sequence number of the first available sample currently queued in the local DataWriter.

The full documentation is available in the C API: DDS_DataWriterProtocolStatus_first_available_sample_sequence_number

LastAvailableSampleSequenceNumber

long Rti.Dds.Core.Status.DataWriterProtocolStatus.LastAvailableSampleSequenceNumber

get

The sequence number of the last available sample currently queued in the local DataWriter.

The full documentation is available in the C API: DDS_DataWriterProtocolStatus_last_available_sample_sequence_number

FirstUnacknowledgedSampleSequenceNumber

long Rti.Dds.Core.Status.DataWriterProtocolStatus.FirstUnacknowledgedSampleSequenceNumber

get

The sequence number of the first unacknowledged sample currently queued in the local DataWriter.

The full documentation is available in the C API: DDS_DataWriterProtocolStatus_first_unacknowledged_sample_sequence_number

FirstAvailableSampleVirtualSequenceNumber

long Rti.Dds.Core.Status.DataWriterProtocolStatus.FirstAvailableSampleVirtualSequenceNumber

get

The virtual sequence number of the first available sample currently queued in the local DataWriter.

The full documentation is available in the C API: DDS_DataWriterProtocolStatus_first_available_sample_virtual_sequence_number

LastAvailableSampleVirtualSequenceNumber

long Rti.Dds.Core.Status.DataWriterProtocolStatus.LastAvailableSampleVirtualSequenceNumber

get

The virtual sequence number of the last available sample currently queued in the local DataWriter.

The full documentation is available in the C API: DDS_DataWriterProtocolStatus_last_available_sample_virtual_sequence_number

FirstUnacknowledgedSampleVirtualSequenceNumber

long Rti.Dds.Core.Status.DataWriterProtocolStatus.FirstUnacknowledgedSampleVirtualSequenceNumber

get

The virtual sequence number of the first unacknowledged sample currently queued in the local DataWriter.

The full documentation is available in the C API: DDS_DataWriterProtocolStatus_first_unacknowledged_sample_virtual_sequence_number

FirstUnacknowledgedSampleSubscriptionHandle

InstanceHandle Rti.Dds.Core.Status.DataWriterProtocolStatus.FirstUnacknowledgedSampleSubscriptionHandle

get

The handle of a remote DataReader that has not acknowledged the first unacknowledged sample of the local DataWriter.

The full documentation is available in the C API: DDS_DataWriterProtocolStatus_first_unacknowledged_sample_subscription_handle

FirstUnelapsedKeepDurationSampleSequenceNumber

long Rti.Dds.Core.Status.DataWriterProtocolStatus.FirstUnelapsedKeepDurationSampleSequenceNumber

get

The sequence number of the first sample whose keep duration has not yet elapsed.

The full documentation is available in the C API: DDS_DataWriterProtocolStatus_first_unelapsed_keep_duration_sample_sequence_number

PushedFragmentCount

long Rti.Dds.Core.Status.DataWriterProtocolStatus.PushedFragmentCount

get

The number of DATA_FRAG messages that have been pushed by this DataWriter.

The full documentation is available in the C API: DDS_DataWriterProtocolStatus_pushed_fragment_count

PushedFragmentBytes

long Rti.Dds.Core.Status.DataWriterProtocolStatus.PushedFragmentBytes

get

The number of bytes of DATA_FRAG messages that have been pushed by this DataWriter.

The full documentation is available in the C API: DDS_DataWriterProtocolStatus_pushed_fragment_bytes

PulledFragmentCount

long Rti.Dds.Core.Status.DataWriterProtocolStatus.PulledFragmentCount

get

The number of DATA_FRAG messages that have been pulled from this DataWriter.

The full documentation is available in the C API: DDS_DataWriterProtocolStatus_pulled_fragment_count

PulledFragmentBytes

long Rti.Dds.Core.Status.DataWriterProtocolStatus.PulledFragmentBytes

get

The number of bytes of DATA_FRAG messages that have been pulled from this DataWriter.

The full documentation is available in the C API: DDS_DataWriterProtocolStatus_pulled_fragment_bytes

ReceivedNackFragmentCount

long Rti.Dds.Core.Status.DataWriterProtocolStatus.ReceivedNackFragmentCount

get

The number of NACK_FRAG messages that have been received by this DataWriter.

The full documentation is available in the C API: DDS_DataWriterProtocolStatus_received_nack_fragment_count

ReceivedNackFragmentBytes

long Rti.Dds.Core.Status.DataWriterProtocolStatus.ReceivedNackFragmentBytes

get

The number of bytes of NACK_FRAG messages that have been received by this DataWriter.

The full documentation is available in the C API: DDS_DataWriterProtocolStatus_received_nack_fragment_bytes