Skip to content

Commit

Permalink
Document why send_application_data is None
Browse files Browse the repository at this point in the history
  • Loading branch information
reynir committed Apr 24, 2024
1 parent fc78dd8 commit 61abc5a
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions lib/engine.mli
Original file line number Diff line number Diff line change
Expand Up @@ -163,9 +163,10 @@ val handle_tls : state -> Cstruct.t -> ret
is a handshake in progress or scheduled. *)
val handshake_in_progress : state -> bool

(** [send_application_data tls outs] is [(tls' * out) option] where
(** [send_application_data tls outs] is [Some (tls', out)] where
[tls'] is the new tls state, and [out] the cstruct to send over the
wire (encrypted [outs]). *)
wire (encrypted [outs]) when the TLS session is ready. When the TLS
session is not ready it is [None]. *)
val send_application_data : state -> Cstruct.t list -> (state * Cstruct.t) option

(** [send_close_notify tls] is [tls' * out] where [tls'] is the new
Expand Down

0 comments on commit 61abc5a

Please sign in to comment.