Module type Mirage_types.CHANNEL

The type for errors.

pp_error is the pretty-printer for errors.

The type for write errors.

The type for write errors.

pp_write_error is the pretty-printer for write errors.

The type for unbuffered network flow.

The type for the state associated with channels, such as the inflight buffers.

create flow allocates send and receive buffers and associates them with the given unbuffered flow.

to_flow t returns the flow that backs this channel.

Reads a single character from the channel, blocking if there is no immediately available input data.

read_some ?len t reads up to len characters from the input channel and at most a full buffer. If len is not specified, it reads all available data and returns that buffer.

read_exactly len t reads len bytes from the channel t or fails with Eof.

read_line t reads a line of input, which is terminated either by a CRLF sequence, or the end of the channel (which counts as a line).

returns

Returns a list of views that terminates at EOF.

write_char t ch writes a single character to the output channel.

write_string t buf off len writes len bytes from a string buf, starting from from offset off.

write_buffer t buf copies the buffer to the channel's output buffer. The buffer should not be modified after being written, and it will be recycled into the buffer allocation pool at some future point.

write_line t buf writes the string buf to the output channel and append a newline character afterwards.

flush t flushes the output buffer and block if necessary until it is all written out to the flow.

close t calls flush and then close the underlying flow.