rustdds 0.1.0

Rust DDS implementation with RTPS
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
use chrono::Duration as chronoDuration;
use enumflags2::BitFlags;
use log::{debug, error, warn};
use speedy::{Writable, Endianness};
//use time::Timespec;
//use time::get_time;
use mio_extras::channel::{self as mio_channel, SyncSender};
use mio::Token;
use std::{
  //time::{Instant, Duration},
  sync::{RwLock, Arc},
  collections::{HashSet, HashMap, BTreeMap, hash_map::DefaultHasher},
};
use std::hash::Hasher;

//use crate::messages::submessages::info_destination::InfoDestination;
use crate::{
  serialization::MessageBuilder,
  messages::submessages::{
    submessage::EntitySubmessage,
    info_timestamp::InfoTimestamp,
    submessage_elements::{parameter::Parameter, parameter_list::ParameterList},
    submessage_elements::serialized_payload::RepresentationIdentifier,
    submessage_flag::*,
  },
  structure::parameter_id::ParameterId,
};
use crate::messages::submessages::data::Data;
use crate::structure::time::Timestamp;
use crate::structure::duration::Duration;
use crate::messages::protocol_version::ProtocolVersion;
use crate::messages::{header::Header, vendor_id::VendorId, protocol_id::ProtocolId};
use crate::structure::guid::{GuidPrefix, EntityId, GUID};
use crate::structure::sequence_number::{SequenceNumber};
use crate::{
  messages::submessages::submessages::{
    Heartbeat, SubmessageHeader, SubmessageKind, InterpreterSubmessage, AckNack, InfoDestination,
  },
  structure::cache_change::{CacheChange, ChangeKind},
  serialization::{SubMessage, Message, SubmessageBody},
};

use crate::dds::{ddsdata::DDSData, qos::HasQoSPolicy};
use crate::{
  network::{constant::TimerMessageType, udp_sender::UDPSender},
  structure::{
    entity::{Entity, EntityAttributes},
    endpoint::{EndpointAttributes, Endpoint},
    locator::LocatorKind,
    dds_cache::DDSCache,
  },
  common::timed_event_handler::{TimedEventHandler},
};
use super::{
  qos::{policy, QosPolicies},
  rtps_reader_proxy::RtpsReaderProxy,
  util::writer_util::WriterUtil,
  values::result::OfferedDeadlineMissedStatus,
  values::result::StatusChange,
};
use policy::{History, Reliability};
//use crate::messages::submessages::submessage_elements::serialized_payload::SerializedPayload;

pub(crate) struct Writer {
  source_version: ProtocolVersion,
  source_vendor_id: VendorId,
  pub endianness: Endianness,
  pub heartbeat_message_counter: i32,
  /// Configures the mode in which the
  ///Writer operates. If
  ///pushMode==true, then the Writer
  /// will push changes to the reader. If
  /// pushMode==false, changes will
  /// only be announced via heartbeats
  ///and only be sent as response to the
  ///request of a reader
  pub push_mode: bool,
  ///Protocol tuning parameter that
  ///allows the RTPS Writer to
  ///repeatedly announce the
  ///availability of data by sending a
  ///Heartbeat Message.
  pub heartbeat_period: Option<Duration>,
  /// duration to launch cahche change remove from DDSCache
  pub cahce_cleaning_perioid: Duration,
  ///Protocol tuning parameter that
  ///allows the RTPS Writer to delay
  ///the response to a request for data
  ///from a negative acknowledgment.
  pub nack_respose_delay: Duration,
  ///Protocol tuning parameter that
  ///allows the RTPS Writer to ignore
  ///requests for data from negative
  ///acknowledgments that arrive ‘too
  ///soon’ after the corresponding
  ///change is sent.
  pub nack_suppression_duration: Duration,
  ///Internal counter used to assign
  ///increasing sequence number to
  ///each change made by the Writer
  pub last_change_sequence_number: SequenceNumber,
  ///If samples are available in the Writer, identifies the first (lowest)
  ///sequence number that is available in the Writer.
  ///If no samples are available in the Writer, identifies the lowest
  ///sequence number that is yet to be written by the Writer
  pub first_change_sequence_number: SequenceNumber,
  ///Optional attribute that indicates
  ///the maximum size of any
  ///SerializedPayload that may be
  ///sent by the Writer
  pub data_max_size_serialized: u64,
  endpoint_attributes: EndpointAttributes,
  entity_attributes: EntityAttributes,
  writer_command_receiver: mio_channel::Receiver<WriterCommand>,
  ///The RTPS ReaderProxy class represents the information an RTPS StatefulWriter maintains on each matched
  ///RTPS Reader
  pub readers: Vec<RtpsReaderProxy>,
  message: Option<Message>,
  udp_sender: UDPSender,
  // This writer can read/write to only one of this DDSCache topic caches identified with my_topic_name
  dds_cache: Arc<RwLock<DDSCache>>,
  /// Writer can only read/write to this topic DDSHistoryCache.
  my_topic_name: String,
  /// Maps this writers local sequence numbers to DDSHistodyCache instants.
  /// Useful when negative acknack is recieved.
  sequence_number_to_instant: BTreeMap<SequenceNumber, Timestamp>,
  //// Maps this writers local sequence numbers to DDSHistodyCache instants.
  /// Useful when datawriter dispose is recieved.
  key_to_instant: HashMap<u128, Timestamp>,
  /// Set of disposed samples.
  /// Useful when reader requires some sample with acknack.
  disposed_sequence_numbers: HashSet<SequenceNumber>,
  //When dataWriter sends cacheChange message with cacheKind is NotAlive_Disposed
  //this is set true. If Datawriter after disposing sends new cahceChanges this falg is then
  //turned true.
  //When writer is in disposed state it needs to send StatusInfo_t (PID_STATUS_INFO) with DisposedFlag
  // pub writer_is_disposed: bool,
  ///Contains timer that needs to be set to timeout with duration of self.heartbeat_perioid
  ///timed_event_handler sends notification when timer is up via miochannel to poll in Dp_eventWrapper
  ///this also handles writers cache cleaning timeouts.
  timed_event_handler: Option<TimedEventHandler>,

  qos_policies: QosPolicies,

  // Used for sending status info about messages sent
  status_sender: SyncSender<StatusChange>,
  offered_deadline_status: OfferedDeadlineMissedStatus,
}

pub(crate) enum WriterCommand {
  DDSData { data: DDSData },
  ResetOfferedDeadlineMissedStatus { writer_guid: GUID },
}

impl Writer {
  pub fn new(
    guid: GUID,
    writer_command_receiver: mio_channel::Receiver<WriterCommand>,
    dds_cache: Arc<RwLock<DDSCache>>,
    topic_name: String,
    qos_policies: QosPolicies,
    status_sender: SyncSender<StatusChange>,
  ) -> Writer {
    let entity_attributes = EntityAttributes::new(guid);

    let heartbeat_period = match &qos_policies.reliability {
      Some(r) => match r {
        Reliability::BestEffort => None,
        Reliability::Reliable {
          max_blocking_time: _,
        } => Some(Duration::from_secs(1)),
      },
      None => None,
    };

    let heartbeat_period = match heartbeat_period {
      Some(hbp) => match qos_policies.liveliness {
        Some(lv) => match lv {
          policy::Liveliness::Automatic { lease_duration: _ } => Some(hbp),
          policy::Liveliness::ManualByParticipant { lease_duration: _ } => Some(hbp),
          policy::Liveliness::ManualByTopic { lease_duration } => {
            let std_dur = Duration::from(lease_duration);
            Some(std_dur / 3)
          }
        },
        None => Some(hbp),
      },
      None => None,
    };

    Writer {
      source_version: ProtocolVersion::PROTOCOLVERSION_2_3,
      source_vendor_id: VendorId::THIS_IMPLEMENTATION,
      endianness: Endianness::LittleEndian,
      heartbeat_message_counter: 1,
      push_mode: true,
      heartbeat_period,
      cahce_cleaning_perioid: Duration::from_secs(2 * 60),
      nack_respose_delay: Duration::from_millis(200),
      nack_suppression_duration: Duration::from_millis(0),
      last_change_sequence_number: SequenceNumber::from(0),
      first_change_sequence_number: SequenceNumber::from(0),
      data_max_size_serialized: 999999999,
      entity_attributes,
      //enpoint_attributes: EndpointAttributes::default(),
      writer_command_receiver,
      readers: vec![
        /*
        RtpsReaderProxy::new_for_unit_testing(1000),
        RtpsReaderProxy::new_for_unit_testing(1001),
        RtpsReaderProxy::new_for_unit_testing(1002),*/
      ],
      message: None,
      endpoint_attributes: EndpointAttributes::default(),
      udp_sender: UDPSender::new_with_random_port(),
      dds_cache,
      my_topic_name: topic_name,
      sequence_number_to_instant: BTreeMap::new(),
      key_to_instant: HashMap::new(),
      disposed_sequence_numbers: HashSet::new(),
      timed_event_handler: None,
      qos_policies,
      status_sender,
      offered_deadline_status: OfferedDeadlineMissedStatus::new(),
    }
  }

  /// To know when token represents a writer we should look entity attribute kind
  /// this entity token can be used in DataWriter -> Writer miochannel.
  pub fn get_entity_token(&self) -> Token {
    let id = self.get_guid().as_usize();
    Token(id)
  }

  /// This token is used in timed event miochannel HearbeatHandler -> dpEventwrapper
  pub fn get_timed_event_entity_token(&self) -> Token {
    let mut hasher = DefaultHasher::new();
    let id = self.get_guid().as_usize() as u64;
    hasher.write(&id.to_le_bytes());
    let hashedID: u64 = hasher.finish();
    Token(hashedID as usize)
  }

  pub fn cache_change_receiver(&self) -> &mio_channel::Receiver<WriterCommand> {
    &self.writer_command_receiver
  }

  pub fn add_timed_event_handler(&mut self, time_handler: TimedEventHandler) {
    self.timed_event_handler = Some(time_handler);
    self.set_cache_cleaning_timer();
    self.set_heartbeat_timer();
  }

  pub fn is_reliable(&self) -> bool {
    match self.qos_policies.reliability {
      Some(Reliability::Reliable {
        max_blocking_time: _,
      }) => {
        return true;
      }
      _ => {
        return false;
      }
    }
  }

  /// this should be called everytime cacheCleaning message is received.
  pub fn handle_cache_cleaning(&mut self) {
    let mut removedChanges = vec![];
    match self.qos_policies.history {
      None => {
        removedChanges = self.remove_all_acked_changes_but_keep_depth(0);
      }
      Some(History::KeepAll) => {
        // TODO need to find a way to check if resource limit.
        // writer can only know the amount its own samples.
        //todo!("TODO keep all resource limit ???");
      }
      Some(History::KeepLast { depth: d }) => {
        removedChanges = self.remove_all_acked_changes_but_keep_depth(d);
      }
    }
    // This is needdd to be removed also if cahceChange is removed from DDSCache.
    for sq in removedChanges {
      self.sequence_number_to_instant.remove(&sq);
    }
    self.set_cache_cleaning_timer();
  }

  fn set_cache_cleaning_timer(&mut self) {
    self.timed_event_handler.as_mut().unwrap().set_timeout(
      &chronoDuration::from(self.cahce_cleaning_perioid),
      TimerMessageType::writer_cache_cleaning,
    )
  }

  fn create_heartbeat_message_wdata(
    message_header: Header,
    endianness: Endianness,
    seqnum: SequenceNumber,
    writer: &Writer,
    reader_guid: GUID,
  ) -> Result<Message, String> {
    MessageBuilder::new()
      .header(message_header)
      .dst_submessage(endianness, reader_guid.guidPrefix)
      .ts_msg(endianness, false)
      .data_msg(seqnum, writer, reader_guid)
      .heartbeat_msg(writer, reader_guid, false, false)
      .build()
  }

  /// this should be called everytime heartbeat message with token is recieved.
  pub fn handle_heartbeat_tick(&mut self) {
    // TODO Set some guidprefix if needed at all.
    // Not sure if DST submessage and TS submessage are needed when sending heartbeat.

    //TODO WHEN FINAL FLAG NEEDS TO BE SET?
    //TODO WHEN LIVELINESS FLAG NEEDS TO BE SET?
    let message_header: Header = self.create_message_header();
    let endianness = self.endianness;

    let mut seqnums: HashMap<GUID, HashSet<SequenceNumber>> = HashMap::new();
    let mut requested_seqnums: HashMap<GUID, HashSet<SequenceNumber>> = HashMap::new();

    for reader in self.readers.iter() {
      let mut rtps_messages = Vec::new();
      let reader_guid = reader.remote_reader_guid;
      seqnums.insert(reader.remote_reader_guid, HashSet::new());
      requested_seqnums.insert(reader.remote_reader_guid, HashSet::new());

      let unacked_changes = reader.unacked_changes(
        self.first_change_sequence_number,
        self.last_change_sequence_number,
      );

      let requested_changes = reader.requested_changes();

      let unsent_changes = reader.unsent_changes();

      let mut all_changes = HashSet::new();
      all_changes.extend(unacked_changes);
      all_changes.extend(requested_changes);
      all_changes.extend(unsent_changes);

      for &seqnum in itertools::sorted(all_changes.iter()) {
        match Writer::create_heartbeat_message_wdata(
          message_header.clone(),
          endianness,
          seqnum,
          &self,
          reader_guid,
        ) {
          Ok(m) => {
            // adding sequence number of change we're gonna send
            match seqnums.get_mut(&reader_guid) {
              Some(v) => {
                v.insert(seqnum);
              }
              None => (),
            };
            // adding the generated message
            rtps_messages.push(m)
          }
          _ => (),
        };
      }

      // updating deadline for added sequence numbers
      match seqnums.get(&reader_guid) {
        Some(sqs) => {
          for &seqnum in sqs.iter() {
            // checking previous sequence number for deadline
            let instant = self.sequence_number_to_instant(seqnum - SequenceNumber::from(1));

            match self.get_qos().deadline {
              Some(dl) => {
                if let Some(instant) = instant {
                  if dl.0 < Timestamp::now() - *instant {
                    self.offered_deadline_status.increase();
                    debug!(
                      "Trying to send status change {:?}",
                      self.offered_deadline_status
                    );
                    match self
                      .status_sender
                      .try_send(StatusChange::OfferedDeadlineMissedStatus(
                        self.offered_deadline_status,
                      )) {
                      Ok(_) => (),
                      Err(e) => error!("Failed to send new message status. {:?}", e),
                    };
                  }
                }
              }
              None => (),
            }
          }
        }
        None => (),
      }

      match requested_seqnums.get_mut(&reader_guid) {
        Some(v) => match seqnums.get(&reader_guid) {
          Some(sqs) => v.extend(sqs.intersection(requested_changes)),
          None => (),
        },
        None => (),
      };

      // finally sending the messages
      for rtps_message in rtps_messages.iter() {
        self.send_unicast_message_to_reader(rtps_message, reader);
        self.send_multicast_message_to_reader(rtps_message, reader);
      }
    }

    for (guid, seqnum_vec) in seqnums {
      self.increase_heartbeat_counter_and_remove_unsend_sequence_numbers(seqnum_vec, &Some(guid));
    }

    for (guid, seqnum_vec) in requested_seqnums {
      match self
        .readers
        .iter_mut()
        .find(|p| p.remote_reader_guid == guid)
      {
        Some(r) => seqnum_vec
          .iter()
          .for_each(|&seq| r.remove_requested_change(seq)),
        None => (),
      };
    }

    self.set_heartbeat_timer();
  }

  /// after heartbeat is handled timer should be set running again.
  fn set_heartbeat_timer(&mut self) {
    match self.heartbeat_period {
      Some(period) => self.timed_event_handler.as_mut().unwrap().set_timeout(
        &chronoDuration::from(period),
        TimerMessageType::writer_heartbeat,
      ),
      None => (),
    }
  }

  pub fn insert_to_history_cache(&mut self, data: DDSData) {
    WriterUtil::increment_writer_sequence_number(self);
    let new_cache_change = WriterUtil::create_cache_change_from_dds_data(self, data);
    let data_key = new_cache_change.key;

    // inserting to DDSCache
    let insta = Timestamp::now();
    self.dds_cache.write().unwrap().to_topic_add_change(
      &self.my_topic_name,
      &insta,
      new_cache_change,
    );

    // keeping table of instant sequence number pairs
    self
      .sequence_number_to_instant
      .insert(self.last_change_sequence_number, insta);
    self.key_to_instant.insert(data_key, insta);

    self.writer_set_unsent_changes();
  }

  /// This needs to be called when dataWriter does dispose.
  /// This does not remove anything from datacahce but changes the status of writer to disposed.
  pub fn handle_not_alive_disposed_cache_change(&mut self, data: DDSData) {
    let instant = self.key_to_instant.get(&data.value_key_hash);

    if instant.is_some() {
      self
        .dds_cache
        .write()
        .unwrap()
        .from_topic_set_change_to_not_alive_disposed(&self.my_topic_name, &instant.unwrap());
    }
  }

  /// Removes permanently cacheChanges from DDSCache.
  /// CacheChanges can be safely removed only if they are acked by all readers. (Reliable)
  /// Depth is QoS policy History depth.
  /// Returns SequenceNumbers of removed CacheChanges
  /// This is called repeadedly by handle_cache_cleaning action.
  fn remove_all_acked_changes_but_keep_depth(&mut self, depth: i32) -> Vec<SequenceNumber> {
    let amount_need_to_remove;
    let mut removed_change_sequence_numbers = vec![];
    let acked_by_all_readers = {
      //let mut acked_by_all: Vec<(&Timestamp, &SequenceNumber)> = vec![];
      let mut acked_by_all: BTreeMap<&Timestamp, &SequenceNumber> = BTreeMap::new();
      for (sq, i) in self.sequence_number_to_instant.iter() {
        if self.change_with_sequence_number_is_acked_by_all(&sq) {
          acked_by_all.insert(i, sq);
        }
      }
      acked_by_all
    };
    if acked_by_all_readers.len() as i32 <= depth {
      return removed_change_sequence_numbers;
    } else {
      amount_need_to_remove = acked_by_all_readers.len() as i32 - depth;
    }
    {
      let mut index: i32 = 0;
      for (i, _sq) in acked_by_all_readers {
        if index >= amount_need_to_remove {
          break;
        }
        let removed = self
          .dds_cache
          .write()
          .unwrap()
          .from_topic_remove_change(&self.my_topic_name, i);
        if removed.is_some() {
          removed_change_sequence_numbers.push(removed.unwrap().sequence_number);
        } else {
          warn!(
            "Remove from {:?} failed. No results with {:?}",
            &self.my_topic_name, i
          );
          debug!("{:?}", self.dds_cache);
        }
        index = index + 1;
      }
    }
    return removed_change_sequence_numbers;
  }

  fn remove_from_history_cache(&mut self, instant: &Timestamp) {
    let removed_change = self
      .dds_cache
      .write()
      .unwrap()
      .from_topic_remove_change(&self.my_topic_name, instant);
    debug!("removed change from DDShistoryCache {:?}", removed_change);
    if removed_change.is_some() {
      self
        .disposed_sequence_numbers
        .insert(removed_change.unwrap().sequence_number);
    } else {
      todo!();
    }
  }

  fn remove_from_history_cache_with_sequence_number(&mut self, sequence_number: &SequenceNumber) {
    let instant = self.sequence_number_to_instant.get(sequence_number);
    if instant.is_some() {
      let removed_change = self
        .dds_cache
        .write()
        .unwrap()
        .from_topic_remove_change(&self.my_topic_name, instant.unwrap());
      if removed_change.is_none() {
        todo!(
          "Cache change with seqnum {:?} and instant {:?} cold not be revod from DDSCache",
          sequence_number,
          instant
        )
      }
    } else {
      todo!(
        "sequence number: {:?} cannot be tranformed to instant ",
        sequence_number
      );
    }
  }

  fn increase_last_change_sequence_number(&mut self) {
    self.last_change_sequence_number = self.last_change_sequence_number + SequenceNumber::from(1);
  }

  fn increase_heartbeat_counter(&mut self) {
    self.heartbeat_message_counter = self.heartbeat_message_counter + 1;
  }

  pub fn can_send_some(&self) -> bool {
    // When writer is reliable all changes has to be acnowledged by remote reader before sending new messages.
    if self.is_reliable() {
      let last_change_is_acked: bool =
        self.change_with_sequence_number_is_acked_by_all(&self.last_change_sequence_number);

      if last_change_is_acked {
        for reader_proxy in &self.readers {
          if reader_proxy.can_send() {
            return true;
          }
        }
        return false;
      }
    }
    //Note that for a Best-Effort Writer, W::pushMode == true, as there are no acknowledgements. Therefore, the
    //Writer always pushes out data as it becomes available.
    else {
      for reader_proxy in &self.readers {
        if reader_proxy.can_send() {
          return true;
        }
      }
      return false;
    }
    return false;
  }

  pub fn sequence_is_sent_to_all_readers(&self, sequence_number: SequenceNumber) -> bool {
    for reader_proxy in &self.readers {
      if reader_proxy.unsent_changes().contains(&sequence_number) {
        return false;
      }
    }
    return true;
  }

  pub fn sequence_needs_to_be_send_to(
    &self,
    sequence_number: SequenceNumber,
  ) -> Vec<&RtpsReaderProxy> {
    let mut readers_remaining: Vec<&RtpsReaderProxy> = vec![];
    for reader_proxy in &self.readers {
      if reader_proxy.unsent_changes().contains(&sequence_number) {
        readers_remaining.push(&reader_proxy);
      }
    }
    return readers_remaining;
  }

  fn get_some_reader_with_unsent_messages(&self) -> Option<&RtpsReaderProxy> {
    self.readers.iter().find(|p| p.can_send())
  }

  fn get_some_reader_with_unsent_messages_mut(&mut self) -> Option<&mut RtpsReaderProxy> {
    self.readers.iter_mut().find(|p| p.can_send())
  }

  fn generate_message(&self, reader_proxy: &RtpsReaderProxy) -> Option<Message> {
    if reader_proxy.can_send() {
      let sequenceNumber = match reader_proxy.next_unsent_change() {
        Some(s) => s,
        None => {
          warn!("Failed to get next unsent change sequence number.");
          return None;
        }
      };

      let instant = match self.sequence_number_to_instant.get(&sequenceNumber) {
        Some(i) => i,
        None => {
          warn!("Failed to get instant from sequence number.");
          return None;
        }
      };

      let cache = match self.dds_cache.read() {
        Ok(c) => c,
        Err(e) => panic!("DDSCache is poisoned. {:?}", e),
      };

      let change = match cache.from_topic_get_change(&self.my_topic_name, &instant) {
        Some(c) => c,
        None => {
          warn!("Failed to get cache change from topic.");
          return None;
        }
      };

      let reader_entity_id = reader_proxy.remote_reader_guid.entityId;
      let message = self.write_user_msg(change.clone(), reader_entity_id);

      return Some(message);
    }
    None
  }

  fn get_next_reader_next_unsend_message(&self) -> Option<(Message, GUID)> {
    self.readers.iter().find(|p| p.can_send()).map(|p| {
      let sequenceNumber = p.next_unsent_change();
      let instant = self
        .sequence_number_to_instant
        .get(&sequenceNumber.unwrap());
      let cache = self.dds_cache.read().unwrap();
      let change = cache.from_topic_get_change(&self.my_topic_name, &instant.unwrap());
      let reader_entity_id = p.remote_reader_guid.entityId.clone();
      let remote_reader_guid = p.remote_reader_guid.clone();
      let message = self.write_user_msg(change.unwrap().clone(), reader_entity_id);
      return (message, remote_reader_guid);
    })
  }

  fn get_next_reader_next_requested_message(&mut self) -> (Option<Message>, Option<GUID>) {
    for reader_proxy in &mut self.readers {
      if reader_proxy.can_send() {
        let sequenceNumber = reader_proxy.next_requested_change();
        let instant = self.sequence_number_to_instant.get(sequenceNumber.unwrap());
        let cache = self.dds_cache.read().unwrap();
        let change = cache.from_topic_get_change(&self.my_topic_name, &instant.unwrap());
        let message: Message;
        let reader_entity_id = reader_proxy.remote_reader_guid.entityId.clone();
        let remote_reader_guid = reader_proxy.remote_reader_guid.clone();
        {
          message = self.write_user_msg(change.unwrap().clone(), reader_entity_id);
        }
        return (Some(message), Some(remote_reader_guid));
      }
    }
    return (None, None);
  }

  fn send_next_unsend_message(&mut self) {
    let remote_reader_guid;
    let rem_sequece_number;
    let mut message_sequence_numbers = HashSet::new();

    if let Some(reader) = self.get_some_reader_with_unsent_messages() {
      rem_sequece_number = reader.next_unsent_change();

      remote_reader_guid = reader.remote_reader_guid;
      let message = self.generate_message(reader);
      if let Some(message) = message {
        message_sequence_numbers = message.get_data_sub_message_sequence_numbers();

        self.send_unicast_message_to_reader(&message, reader);
        self.send_multicast_message_to_reader(&message, reader);

        if let Some(seqnum) = rem_sequece_number {
          let instant = self.sequence_number_to_instant(seqnum - SequenceNumber::from(1));
          match self.get_qos().deadline {
            Some(dl) => {
              if let Some(instant) = instant {
                if dl.0 < Timestamp::now() - *instant {
                  self.offered_deadline_status.increase();
                  debug!(
                    "Trying to send single status change {:?}",
                    self.offered_deadline_status
                  );
                  match self
                    .status_sender
                    .try_send(StatusChange::OfferedDeadlineMissedStatus(
                      self.offered_deadline_status,
                    )) {
                    Ok(_) => (),
                    Err(e) => error!("Failed to send new message status. {:?}", e),
                  };
                }
              }
            }
            None => (),
          }
        }
      }
    } else {
      return;
    }

    if let Some(rem_seq) = rem_sequece_number {
      if let Some(reader) = self.get_some_reader_with_unsent_messages_mut() {
        reader.remove_unsend_change(rem_seq);
      }

      self.increase_heartbeat_counter_and_remove_unsend_sequence_numbers(
        message_sequence_numbers,
        &Some(remote_reader_guid),
      );
    }
  }

  fn send_unicast_message_to_reader(&self, message: &Message, reader: &RtpsReaderProxy) {
    if let Ok(data) = message.write_to_vec_with_ctx(self.endianness) {
      self
        .udp_sender
        .send_to_locator_list(&data, &reader.unicast_locator_list)
    }
  }

  fn send_multicast_message_to_reader(&self, message: &Message, reader: &RtpsReaderProxy) {
    let buffer = message.write_to_vec_with_ctx(self.endianness).unwrap();
    for multiaddress in &reader.multicast_locator_list {
      if multiaddress.kind == LocatorKind::LOCATOR_KIND_UDPv4 {
        self
          .udp_sender
          .send_ipv4_multicast(&buffer, multiaddress.to_socket_address())
          .expect("Unable to send multicast message.");
      } else if multiaddress.kind == LocatorKind::LOCATOR_KIND_UDPv6 {
        todo!();
      }
    }
  }

  pub fn send_all_unsend_messages(&mut self) {
    if self.can_send_some() {
      while let Some(_) = self.get_some_reader_with_unsent_messages() {
        self.send_next_unsend_message();
      }
    } else {
      // TODO: maybe add debug print when necessary
    }
  }

  fn create_message_header(&self) -> Header {
    let head: Header = Header {
      protocol_id: ProtocolId::default(),
      protocol_version: ProtocolVersion {
        major: self.source_version.major,
        minor: self.source_version.minor,
      },
      vendor_id: VendorId {
        vendorId: self.source_vendor_id.vendorId,
      },
      guid_prefix: self.entity_attributes.guid.guidPrefix,
    };
    return head;
  }

  // TODO: Is this copy-pase code from serialization/message.rs
  pub fn get_TS_submessage(&self, invalidiateFlagSet: bool) -> SubMessage {
    let timestamp = InfoTimestamp {
      timestamp: Timestamp::now(),
    };
    let mes = &mut timestamp.write_to_vec_with_ctx(self.endianness).unwrap();

    let flags = BitFlags::<INFOTIMESTAMP_Flags>::from_endianness(self.endianness)
      | (if invalidiateFlagSet {
        INFOTIMESTAMP_Flags::Invalidate.into()
      } else {
        BitFlags::<INFOTIMESTAMP_Flags>::empty()
      });

    let submessageHeader = SubmessageHeader {
      kind: SubmessageKind::INFO_TS,
      flags: flags.bits(),
      content_length: mes.len() as u16, // This conversion should be safe, as timestamp length cannot exceed u16
    };
    SubMessage {
      header: submessageHeader,
      body: SubmessageBody::Interpreter(InterpreterSubmessage::InfoTimestamp(timestamp, flags)),
    }
  }

  // TODO: Is this copy-pase code from serialization/message.rs
  pub fn get_DST_submessage(endianness: Endianness, guid_prefix: GuidPrefix) -> SubMessage {
    let flags = BitFlags::<INFODESTINATION_Flags>::from_endianness(endianness);
    let submessageHeader = SubmessageHeader {
      kind: SubmessageKind::INFO_DST,
      flags: flags.bits(),
      content_length: 12u16,
      //InfoDST length is always 12 because message contains only GuidPrefix
    };
    SubMessage {
      header: submessageHeader,
      body: SubmessageBody::Interpreter(InterpreterSubmessage::InfoDestination(
        InfoDestination { guid_prefix },
        flags,
      )),
    }
  }

  pub fn get_DATA_msg_from_cache_change(
    &self,
    change: CacheChange,
    reader_entity_id: EntityId,
  ) -> SubMessage {
    // let mut representationIdentifierBytes: [u8; 2] = [0, 0];
    // if self.endianness == Endianness::LittleEndian {
    //   representationIdentifierBytes = [0x00, 0x01];
    // } else if self.endianness == Endianness::BigEndian {
    //   representationIdentifierBytes = [0x00, 0x00];
    // }

    // TODO: might want check representation identifier again
    //data_message.serialized_payload.representation_identifier =
    //  SerializedPayload::representation_identifier_from(representationIdentifierBytes[1] as u16);

    //The current version of the protocol (2.3) does not use the representation_options: The sender shall set the representation_options to zero.
    //data_message.serialized_payload.representation_options = 0u16;
    //data_message.serialized_payload.value = change.data_value.unwrap().value.clone();
    //data_message.reader_id = reader_entity_id;
    //data_message.writer_sn = change.sequence_number;

    let inline_qos = match change.kind {
      ChangeKind::ALIVE => None,
      _ => {
        let mut param_list = ParameterList::new();
        let key_hash = Parameter {
          parameter_id: ParameterId::PID_KEY_HASH,
          value: change.key.to_le_bytes().to_vec(),
        };
        param_list.parameters.push(key_hash);
        let status_info = Parameter::create_pid_status_info_parameter(true, true, false);
        param_list.parameters.push(status_info);
        Some(param_list)
      }
    };

    let mut data_message = Data {
      reader_id: reader_entity_id,
      writer_id: self.get_entity_id(), // TODO! Is this the correct EntityId here?
      writer_sn: change.sequence_number,
      inline_qos,
      serialized_payload: change.data_value,
    };

    if self.get_entity_id().get_kind() == 0xC2 {
      match data_message.serialized_payload.as_mut() {
        Some(sp) => sp.representation_identifier = u16::from(RepresentationIdentifier::PL_CDR_LE),
        None => (),
      }
    }

    let flags: BitFlags<DATA_Flags> = BitFlags::<DATA_Flags>::from_endianness(self.endianness)
      | (
        if change.kind == ChangeKind::NOT_ALIVE_DISPOSED {
          // No data, we send key instead
          BitFlags::<DATA_Flags>::from_flag(DATA_Flags::InlineQos)
        } else {
          BitFlags::<DATA_Flags>::from_flag(DATA_Flags::Data)
        }
        // normal case
      );

    let size = data_message
      .write_to_vec_with_ctx(self.endianness)
      .unwrap()
      .len() as u16;
    let s: SubMessage = SubMessage {
      header: SubmessageHeader {
        kind: SubmessageKind::DATA,
        flags: flags.bits(),
        content_length: size,
      },
      body: SubmessageBody::Entity(EntitySubmessage::Data(data_message, flags)),
    };

    return s;
  }

  pub fn get_heartbeat_msg(
    &self,
    reader_id: EntityId,
    set_final_flag: bool,
    set_liveliness_flag: bool,
  ) -> Option<SubMessage> {
    let first = self.first_change_sequence_number;
    let last = self.last_change_sequence_number;

    let heartbeat = Heartbeat {
      reader_id: reader_id,
      writer_id: self.entity_attributes.guid.entityId,
      first_sn: first,
      last_sn: last,
      count: self.heartbeat_message_counter,
    };

    let mut flags = BitFlags::<HEARTBEAT_Flags>::from_endianness(self.endianness);

    if set_final_flag {
      flags.insert(HEARTBEAT_Flags::Final)
    }
    if set_liveliness_flag {
      flags.insert(HEARTBEAT_Flags::Liveliness)
    }

    heartbeat.create_submessage(flags)
  }

  pub fn write_user_msg(&self, change: CacheChange, reader_entity_id: EntityId) -> Message {
    let mut message: Vec<u8> = vec![];

    let mut RTPSMessage: Message = Message::new(self.create_message_header());
    RTPSMessage.add_submessage(self.get_TS_submessage(false));
    let data = self.get_DATA_msg_from_cache_change(change.clone(), reader_entity_id);
    RTPSMessage.add_submessage(data);
    //RTPSMessage.add_submessage(self.get_heartbeat_msg());
    message.append(&mut RTPSMessage.write_to_vec_with_ctx(self.endianness).unwrap());

    return RTPSMessage;
  }

  /// AckNack Is negative if reader_sn_state contains some sequenceNumbers in reader_sn_state set
  fn test_if_ack_nack_contains_not_recieved_sequence_numbers(ack_nack: &AckNack) -> bool {
    debug!("Testing ACKNACK set {:?}", ack_nack.reader_sn_state);
    if !&ack_nack.reader_sn_state.set.is_empty() {
      return true;
    }
    return false;
  }

  ///When receiving an ACKNACK Message indicating a Reader is missing some data samples, the Writer must
  ///respond by either sending the missing data samples, sending a GAP message when the sample is not relevant, or
  ///sending a HEARTBEAT message when the sample is no longer available
  pub fn handle_ack_nack(&mut self, guid_prefix: GuidPrefix, an: AckNack) {
    if !self.is_reliable() {
      error!(
        "Writer {:x?} is best effort! It should not handle acknack messages!",
        self.get_entity_id()
      );
      return;
    }

    let first_change_sq = self.first_change_sequence_number;
    let last_change_sq = self.last_change_sequence_number;

    if let Some(reader_proxy) = self.matched_reader_lookup(guid_prefix, an.reader_id) {
      reader_proxy.add_acked_changes(
        first_change_sq,
        last_change_sq,
        an.reader_sn_state.base,
        &an.reader_sn_state.set,
      );
      if Writer::test_if_ack_nack_contains_not_recieved_sequence_numbers(&an) {
        // if ack nac says reader has NOT recieved data then add data to requested changes
        reader_proxy.add_requested_changes(an.reader_sn_state.base, an.reader_sn_state.set);
      } else {
        reader_proxy.acked_changes_set(an.reader_sn_state.base);
      }
    }
  }

  pub fn matched_reader_add(&mut self, reader_proxy: RtpsReaderProxy) {
    if self.readers.iter().any(|x| {
      x.remote_group_entity_id == reader_proxy.remote_group_entity_id
        && x.remote_reader_guid == reader_proxy.remote_reader_guid
    }) {
      panic!("Reader proxy with same group entityid and remotereader guid added already");
    };
    &self.readers.push(reader_proxy);
  }

  pub fn matched_reader_remove(&mut self, reader_proxy: RtpsReaderProxy) {
    let pos = &self.readers.iter().position(|x| {
      x.remote_group_entity_id == reader_proxy.remote_group_entity_id
        && x.remote_reader_guid == reader_proxy.remote_reader_guid
    });
    if pos.is_some() {
      &self.readers.remove(pos.unwrap());
    }
  }

  ///This operation finds the ReaderProxy with GUID_t a_reader_guid from the set
  /// get guid Prefix from RTPS message main header
  /// get reader guid from AckNack submessage readerEntityId
  pub fn matched_reader_lookup(
    &mut self,
    guid_prefix: GuidPrefix,
    reader_entity_id: EntityId,
  ) -> Option<&mut RtpsReaderProxy> {
    let search_guid: GUID = GUID::new_with_prefix_and_id(guid_prefix, reader_entity_id);
    self
      .readers
      .iter_mut()
      .find(|x| x.remote_reader_guid == search_guid)
  }

  pub fn reader_lookup(
    &self,
    guid_prefix: GuidPrefix,
    reader_entity_id: EntityId,
  ) -> Option<&RtpsReaderProxy> {
    let search_guid: GUID = GUID::new_with_prefix_and_id(guid_prefix, reader_entity_id);
    self
      .readers
      .iter()
      .find(|x| x.remote_reader_guid == search_guid)
  }

  ///This operation takes a CacheChange a_change as a parameter and determines whether all the ReaderProxy
  ///have acknowledged the CacheChange. The operation will return true if all ReaderProxy have acknowledged the
  ///corresponding CacheChange and false otherwise.
  pub fn is_acked_by_all(&self, cache_change: &CacheChange) -> bool {
    for _proxy in &self.readers {
      if _proxy.sequence_is_acked(&cache_change.sequence_number) == false {
        return false;
      }
    }
    return true;
  }

  pub fn change_with_sequence_number_is_acked_by_all(
    &self,
    sequence_number: &SequenceNumber,
  ) -> bool {
    for proxy in &self.readers {
      if proxy.sequence_is_acked(sequence_number) == false {
        return false;
      }
    }
    return true;
  }

  pub fn increase_heartbeat_counter_and_remove_unsend_sequence_numbers(
    &mut self,
    sequence_numbers: HashSet<SequenceNumber>,
    remote_reader_guid: &Option<GUID>,
  ) {
    let sequenceNumbersCount: usize = { sequence_numbers.len() };

    match remote_reader_guid {
      Some(guid) => {
        match self.matched_reader_lookup(guid.guidPrefix, guid.entityId) {
          Some(rtps_reader_proxy) => {
            rtps_reader_proxy.remove_unsend_changes(&sequence_numbers);
          }
          None => (),
        };
        for _ in 0..sequenceNumbersCount + 1 {
          self.increase_heartbeat_counter();
        }
      }
      None => (),
    }
  }

  pub fn increase_heartbeat_counter_and_remove_unsend(
    &mut self,
    message: &Option<Message>,
    remote_reader_guid: &Option<GUID>,
  ) {
    if message.is_some() {
      let sequence_numbers = message
        .as_ref()
        .unwrap()
        .get_data_sub_message_sequence_numbers();
      for sq in sequence_numbers {
        let readerProxy = self
          .matched_reader_lookup(
            remote_reader_guid.unwrap().guidPrefix,
            remote_reader_guid.unwrap().entityId,
          )
          .unwrap();
        readerProxy.remove_unsend_change(sq)
      }
    }
  }

  pub fn writer_set_unsent_changes(&mut self) {
    for reader in &mut self.readers {
      reader.unsend_changes_set(self.last_change_sequence_number);
    }
  }

  pub fn sequence_number_to_instant(&self, seqnumber: SequenceNumber) -> Option<&Timestamp> {
    self.sequence_number_to_instant.get(&seqnumber)
  }

  pub fn find_cache_change(&self, instant: &Timestamp) -> Option<CacheChange> {
    match self.dds_cache.read() {
      Ok(dc) => {
        let cc = dc.from_topic_get_change(&self.my_topic_name, instant);
        cc.cloned()
      }
      Err(e) => panic!("DDSCache is poisoned {:?}", e),
    }
  }

  pub fn topic_name(&self) -> &String {
    &self.my_topic_name
  }

  pub fn reset_offered_deadline_missed_status(&mut self) {
    self.offered_deadline_status.reset_change();
  }
}

impl Entity for Writer {
  fn get_guid(&self) -> GUID {
    self.entity_attributes.guid
  }
}

impl Endpoint for Writer {
  fn as_endpoint(&self) -> &crate::structure::endpoint::EndpointAttributes {
    &self.endpoint_attributes
  }
}

impl HasQoSPolicy for Writer {
  fn get_qos(&self) -> QosPolicies {
    self.qos_policies.clone()
  }

  // fn set_qos(&mut self, new_qos: &QosPolicies) -> super::values::result::Result<()> {
  //   self.qos_policies = new_qos.clone();
  //   Ok(())
  // }
}

#[cfg(test)]
mod tests {
  use crate::{
    dds::{
      participant::DomainParticipant, qos::QosPolicies, with_key::datawriter::DataWriter,
      topic::TopicKind,
    },
  };
  use std::thread;
  use crate::test::random_data::*;
  use crate::serialization::cdr_serializer::CDRSerializerAdapter;
  use byteorder::LittleEndian;
  use log::info;

  #[test]
  fn test_writer_recieves_datawriter_cache_change_notifications() {
    let domain_participant = DomainParticipant::new(0);
    let qos = QosPolicies::qos_none();
    let _default_dw_qos = QosPolicies::qos_none();

    let publisher = domain_participant
      .create_publisher(&qos)
      .expect("Failed to create publisher");
    let topic = domain_participant
      .create_topic("Aasii", "Huh?", &qos, TopicKind::WithKey)
      .expect("Failed to create topic");
    let data_writer: DataWriter<RandomData, CDRSerializerAdapter<RandomData, LittleEndian>> =
      publisher
        .create_datawriter(None, topic, None)
        .expect("Failed to create datawriter");

    let data = RandomData {
      a: 4,
      b: "Fobar".to_string(),
    };

    let data2 = RandomData {
      a: 2,
      b: "Fobar".to_string(),
    };

    let data3 = RandomData {
      a: 3,
      b: "Fobar".to_string(),
    };

    let writeResult = data_writer.write(data, None).expect("Unable to write data");

    info!("writerResult:  {:?}", writeResult);
    let writeResult = data_writer
      .write(data2, None)
      .expect("Unable to write data");

    info!("writerResult:  {:?}", writeResult);
    let writeResult = data_writer
      .write(data3, None)
      .expect("Unable to write data");

    thread::sleep(std::time::Duration::from_millis(100));
    info!("writerResult:  {:?}", writeResult);
  }
}