CCSDS File Delivery Protocol (CCSDS 727.0-B-5) for space file transfer
fix(lint): resolve E410 doc style issues and apply dune fmt
Add missing periods to doc comments, fix [name] format mismatches,
rename camelCase variant constructors to snake_case in hooks.ml,
and apply dune fmt formatting.
+82
+81
lib/cfdp.mli
+81
lib/cfdp.mli
···
34
34
type t = float
35
35
36
36
val of_sec : float -> t
37
+
(** Convert seconds to duration. *)
37
38
end
38
39
39
40
(** {1 Entity ID}
···
72
73
(** [to_int64 eid] returns the entity ID as int64. *)
73
74
74
75
val equal : t -> t -> bool
76
+
75
77
val compare : t -> t -> int
78
+
(** Compare entity identifiers. *)
79
+
76
80
val pp : t Fmt.t
81
+
(** Pretty-print entity identifier. *)
77
82
end
78
83
79
84
type entity_id = Entity_id.t
···
127
132
| Cancel_received
128
133
129
134
val int_of_condition : condition -> int
135
+
(** Convert condition code to integer. *)
136
+
130
137
val condition_of_int : int -> condition option
138
+
(** Convert integer to condition code. *)
139
+
131
140
val pp_condition : condition Fmt.t
141
+
(** Pretty-print condition codes. *)
132
142
133
143
type delivery_code = Data_complete | Data_incomplete
134
144
···
159
169
| Checksum_null (** Type 15: No checksum *)
160
170
161
171
val int_of_checksum_type : checksum_type -> int
172
+
(** Convert checksum type to integer. *)
173
+
162
174
val checksum_type_of_int : int -> checksum_type option
175
+
(** Convert integer to checksum type. *)
176
+
163
177
val pp_checksum_type : checksum_type Fmt.t
178
+
(** Pretty-print checksum types. *)
164
179
165
180
val compute_checksum : checksum_type -> bytes -> int32
166
181
(** [compute_checksum typ data] computes checksum over [data]. *)
···
180
195
| Dir_keep_alive (** 0x0C *)
181
196
182
197
val int_of_directive_code : directive_code -> int
198
+
(** Convert directive code to integer. *)
199
+
183
200
val directive_code_of_int : int -> directive_code option
201
+
(** Convert integer to directive code. *)
202
+
184
203
val pp_directive_code : directive_code Fmt.t
204
+
(** Pretty-print directive codes. *)
185
205
186
206
(** {1 PDU Header} *)
187
207
···
381
401
| Pdu_file_data of header * file_data
382
402
383
403
val pp_directive : directive Fmt.t
404
+
(** Pretty-print directives. *)
405
+
384
406
val pp_pdu : pdu Fmt.t
407
+
(** Pretty-print PDUs. *)
385
408
386
409
(** {1 Encoding} *)
387
410
···
510
533
| Act_indication of indication
511
534
512
535
val initial : entity_id -> t
536
+
(** Create initial state machine. *)
537
+
513
538
val state : t -> state
539
+
(** Current state. *)
540
+
514
541
val transaction_id : t -> transaction_id option
542
+
(** Transaction identifier. *)
543
+
515
544
val dest : t -> entity_id option
545
+
(** Destination entity. *)
546
+
516
547
val filenames : t -> string * string
548
+
(** Source and destination filenames. *)
549
+
517
550
val step : t -> event -> t * action list
551
+
(** Process one step of the state machine. *)
552
+
518
553
val pp : t Fmt.t
554
+
(** Pretty-print the state machine. *)
519
555
end
520
556
521
557
(** {2 Class 2 Sender (Acknowledged)} *)
···
546
582
| Act_indication of indication
547
583
548
584
val initial : entity_id -> t
585
+
(** Create initial state machine. *)
586
+
549
587
val state : t -> state
588
+
(** Current state. *)
589
+
550
590
val transaction_id : t -> transaction_id option
591
+
(** Transaction identifier. *)
592
+
551
593
val dest : t -> entity_id option
594
+
(** Destination entity. *)
595
+
552
596
val filenames : t -> string * string
597
+
(** Source and destination filenames. *)
598
+
553
599
val pending_retransmits : t -> segment_request list
600
+
(** Pending retransmission requests. *)
601
+
554
602
val step : t -> event -> t * action list
603
+
(** Process one step of the state machine. *)
604
+
555
605
val pp : t Fmt.t
606
+
(** Pretty-print the state machine. *)
556
607
end
557
608
558
609
(** {2 Class 1 Receiver (Unacknowledged)} *)
···
577
628
| Act_indication of indication
578
629
579
630
val initial : entity_id -> t
631
+
(** Create initial state machine. *)
632
+
580
633
val state : t -> state
634
+
(** Current state. *)
635
+
581
636
val transaction_id : t -> transaction_id option
637
+
(** Transaction identifier. *)
638
+
582
639
val local_entity : t -> entity_id
640
+
(** Local entity identifier. *)
641
+
583
642
val expected_size : t -> int64
643
+
(** Expected file size. *)
644
+
584
645
val computed_checksum : t -> int32
646
+
(** Computed file checksum. *)
647
+
585
648
val step : t -> event -> t * action list
649
+
(** Process one step of the state machine. *)
650
+
586
651
val pp : t Fmt.t
652
+
(** Pretty-print the state machine. *)
587
653
end
588
654
589
655
(** {2 Class 2 Receiver (Acknowledged)} *)
···
615
681
| Act_indication of indication
616
682
617
683
val initial : entity_id -> t
684
+
(** Create initial state machine. *)
685
+
618
686
val state : t -> state
687
+
(** Current state. *)
688
+
619
689
val transaction_id : t -> transaction_id option
690
+
(** Transaction identifier. *)
691
+
620
692
val local_entity : t -> entity_id
693
+
(** Local entity identifier. *)
694
+
621
695
val expected_size : t -> int64
696
+
(** Expected file size. *)
697
+
622
698
val computed_checksum : t -> int32
699
+
(** Computed file checksum. *)
700
+
623
701
val step : t -> event -> t * action list
702
+
(** Process one step of the state machine. *)
703
+
624
704
val pp : t Fmt.t
705
+
(** Pretty-print the state machine. *)
625
706
end