lwt 2.6.0 · OCaml Package

Buffered byte channels

A channel is a high-level object for performing input/output (IO). It allows to read/write from/to the outside world in an efficient way, by minimising the number of system calls.

An output channel is used to send data and an input channel is used to receive data.

If you are familiar with buffered channels you may be familiar too with the flush operation. Note that byte channels of this module are automatically flushed when there is nothing else to do (i.e. before the program becomes idle), so this means that you no longer have to write:

eprintf "log message\n";
flush stderr;

to have your messages displayed.

Note about errors: input functions of this module raise End_of_file when the end-of-file is reached (i.e. when the read function returns 0). Other exceptions are ones caused by the backend read/write functions, such as Unix.Unix_error.

exception Channel_closed of string

Exception raised when a channel is closed. The parameter is a description of the channel.

Types

type 'mode channel

Type of buffered byte channels

type input

Input mode

type output

Output mode

type 'a mode =

| Input : input mode
| Output : output mode

Channel mode

val input : input mode

input input mode representation

val output : output mode

output output mode representation

type input_channel = input channel

Type of input channels

type output_channel = output channel

Type of output channels

val mode : 'a channel -> 'a mode

mode ch returns the mode of a channel

Well-known instances

val stdin : input_channel

The standard input, it reads data from Lwt_unix.stdin

val stdout : output_channel

The standard output, it writes data to Lwt_unix.stdout

val stderr : output_channel

The standard output for error messages, it writes data to Lwt_unix.stderr

val zero : input_channel

Inputs which returns always '\x00'

val null : output_channel

Output which drops everything

Channels creation/manipulation

val pipe : 
  ?in_buffer:Lwt_bytes.t ->
  ?out_buffer:Lwt_bytes.t ->
  unit ->
  input_channel * output_channel

pipe ?in_buffer ?out_buffer () creates a pipe using Lwt_unix.pipe and makes two channels from the two returned file descriptors

val make : 
  ?buffer:Lwt_bytes.t ->
  ?close:(unit -> unit Lwt.t) ->
  ?seek:(int64 -> Unix.seek_command -> int64 Lwt.t) ->
  mode:'mode mode ->
  (Lwt_bytes.t -> int -> int -> int Lwt.t) ->
  'mode channel

make ?buffer ?close ~mode perform_io is the main function for creating new channels.

parameter buffer
user-supplied buffer. When this argument is present, its value will be used as the buffer for the created channel. The size of buffer must conform to the limitations described in set_default_buffer_size. When this argument is not present, a new internal buffer of default size will be allocated for this channel.
Warning: do not use the same buffer for simultaneous work with more than one channel.
There are other functions in this module that take a buffer argument, sharing the same semantics.

parameter close
close function of the channel. It defaults to Lwt.return

parameter seek
same meaning as Unix.lseek

parameter mode
either input or output

parameter perform_io
is the read or write function. It is called when more input is needed or when the buffer need to be flushed.

val of_bytes : mode:'mode mode -> Lwt_bytes.t -> 'mode channel

Create a channel from a byte array. Reading/writing is done directly on the provided array.

val of_fd : 
  ?buffer:Lwt_bytes.t ->
  ?close:(unit -> unit Lwt.t) ->
  mode:'mode mode ->
  Lwt_unix.file_descr ->
  'mode channel

of_fd ?buffer ?close ~mode fd creates a channel from a file descriptor.

parameter close
defaults to closing the file descriptor.

val of_unix_fd : 
  ?buffer:Lwt_bytes.t ->
  ?close:(unit -> unit Lwt.t) ->
  mode:'mode mode ->
  Unix.file_descr ->
  'mode channel

of_unix_fd ?buffer ?close ~mode fd is a short-hand for:

of_fd ?buffer ?close (Lwt_unix.of_unix_file_descr fd)

val close : 'a channel -> unit Lwt.t

close ch closes the given channel. If ch is an output channel, it performs all pending actions, flushes it and closes it. If ch is an input channel, it just closes it immediately.

close returns the result of the close function of the channel. Multiple calls to close will return exactly the same value.

Note: you cannot use close on channels obtained with atomic.

val abort : 'a channel -> unit Lwt.t

abort ch abort current operations and close the channel immediately.

val atomic : ('a channel -> 'b Lwt.t) -> 'a channel -> 'b Lwt.t

atomic f transforms a sequence of io operations into one single atomic io operation.

Note:

the channel passed to f is invalid after f terminates
atomic can be called inside another atomic

val file_length : string -> int64 Lwt.t

Returns the length of a file

val buffered : 'a channel -> int

buffered oc returns the number of bytes in the buffer

val flush : output_channel -> unit Lwt.t

flush oc performs all pending writes on oc

val flush_all : unit -> unit Lwt.t

flush_all () flushes all open output channels

val buffer_size : 'a channel -> int

Returns the size of the internal buffer.

val resize_buffer : 'a channel -> int -> unit Lwt.t

Resize the internal buffer to the given size

val is_busy : 'a channel -> bool

is_busy channel returns whether the given channel is currently busy. A channel is busy when there is at least one job using it that has not yet terminated.

Random access

val position : 'a channel -> int64

position ch Returns the current position in the channel.

val set_position : 'a channel -> int64 -> unit Lwt.t

set_position ch pos Sets the position in the output channel. This does not work if the channel does not support random access.

val length : 'a channel -> int64 Lwt.t

Returns the length of the channel in bytes

Reading

Note: except for functions dealing with streams (read_chars and read_lines) all functions are atomic.

val read_char : input_channel -> char Lwt.t

read_char ic reads the next character of ic.

raises End_of_file
if the end of the file is reached

val read_char_opt : input_channel -> char option Lwt.t

Same as read_byte but does not raise End_of_file on end of input

val read_chars : input_channel -> char Lwt_stream.t

read_chars ic returns a stream holding all characters of ic

val read_line : input_channel -> string Lwt.t

read_line ic reads one complete line from ic and returns it without the end of line. End of line is either "\n" or "\r\n".

If the end of line is reached before reading any character, End_of_file is raised. If it is reached before reading an end of line but characters have already been read, they are returned.

val read_line_opt : input_channel -> string option Lwt.t

Same as read_line but do not raise End_of_file on end of input.

val read_lines : input_channel -> string Lwt_stream.t

read_lines ic returns a stream holding all lines of ic

val read : ?count:int -> input_channel -> string Lwt.t

read ?count ic reads at most count characters from ic. It returns "" if the end of input is reached. If count is not specified, it reads all bytes until the end of input.

val read_into : input_channel -> Bytes.t -> int -> int -> int Lwt.t

read_into ic buffer offset length reads up to length bytes, stores them in buffer at offset offset, and returns the number of bytes read.

Note: read_into does not raise End_of_file, it returns a length of 0 instead.

val read_into_exactly : input_channel -> Bytes.t -> int -> int -> unit Lwt.t

read_into_exactly ic buffer offset length reads exactly length bytes and stores them in buffer at offset offset.

raises End_of_file
on end of input

val read_value : input_channel -> 'a Lwt.t

read_value ic reads a marshaled value from ic

Writing

Note: as for reading functions, all functions except write_chars and write_lines are atomic.

For example if you use write_line in two different threads, the two operations will be serialized, and lines cannot be mixed.

val write_char : output_channel -> char -> unit Lwt.t

write_char oc char writes char on oc

val write_chars : output_channel -> char Lwt_stream.t -> unit Lwt.t

write_chars oc chars writes all characters of chars on oc

val write : output_channel -> string -> unit Lwt.t

write oc str writes all characters of str on oc

val write_line : output_channel -> string -> unit Lwt.t

write_line oc str writes str on oc followed by a new-line.

val write_lines : output_channel -> string Lwt_stream.t -> unit Lwt.t

write_lines oc lines writes all lines of lines to oc

val write_from : output_channel -> Bytes.t -> int -> int -> int Lwt.t

write_from oc buffer offset length writes up to length bytes to oc, from buffer at offset offset and returns the number of bytes actually written

val write_from_string : output_channel -> string -> int -> int -> int Lwt.t

See write.

val write_from_exactly : output_channel -> Bytes.t -> int -> int -> unit Lwt.t

write_from_exactly oc buffer offset length writes all length bytes from buffer at offset offset to oc

val write_from_string_exactly : 
  output_channel ->
  string ->
  int ->
  int ->
  unit Lwt.t

See write_from_exactly.

val write_value : 
  output_channel ->
  ?flags:Marshal.extern_flags list ->
  'a ->
  unit Lwt.t

write_value oc ?flags x marshals the value x to oc

Printing

These functions are basically helpers. Also you may prefer using the name printl rather than write_line because it is shorter.

The general name of a printing function is <prefix>print<suffixes>,

where <prefix> is one of:

'f', which means that the function takes as argument a channel
nothing, which means that the function prints on stdout
'e', which means that the function prints on stderr

and <suffixes> is a combination of:

'l' which means that a new-line character is printed after the message
'f' which means that the function takes as argument a format instead of a string

val fprint : output_channel -> string -> unit Lwt.t

val fprintl : output_channel -> string -> unit Lwt.t

val fprintf : 
  output_channel ->
  ('a, unit, string, unit Lwt.t) Pervasives.format4 ->
  'a

val fprintlf : 
  output_channel ->
  ('a, unit, string, unit Lwt.t) Pervasives.format4 ->
  'a

val print : string -> unit Lwt.t

val printl : string -> unit Lwt.t

val printf : ('a, unit, string, unit Lwt.t) Pervasives.format4 -> 'a

val printlf : ('a, unit, string, unit Lwt.t) Pervasives.format4 -> 'a

val eprint : string -> unit Lwt.t

val eprintl : string -> unit Lwt.t

val eprintf : ('a, unit, string, unit Lwt.t) Pervasives.format4 -> 'a

val eprintlf : ('a, unit, string, unit Lwt.t) Pervasives.format4 -> 'a

Utilities

val hexdump_stream : output_channel -> char Lwt_stream.t -> unit Lwt.t

hexdump_stream oc byte_stream produces the same output as the command hexdump -C.

val hexdump : output_channel -> string -> unit Lwt.t

hexdump oc str = hexdump_stream oc (Lwt_stream.of_string str)

File utilities

type file_name = string

Type of file names

val open_file : 
  ?buffer:Lwt_bytes.t ->
  ?flags:Unix.open_flag list ->
  ?perm:Unix.file_perm ->
  mode:'a mode ->
  file_name ->
  'a channel Lwt.t

open_file ?buffer ?flags ?perm ~mode filename opens the file with name filename and returns a channel for reading/writing it.

raises Unix.Unix_error
on error.

val with_file : 
  ?buffer:Lwt_bytes.t ->
  ?flags:Unix.open_flag list ->
  ?perm:Unix.file_perm ->
  mode:'a mode ->
  file_name ->
  ('a channel -> 'b Lwt.t) ->
  'b Lwt.t

with_file ?buffer ?flags ?perm ~mode filename f opens a file and passes the channel to f. It is ensured that the channel is closed when f ch terminates (even if it fails).

val open_connection : 
  ?fd:Lwt_unix.file_descr ->
  ?in_buffer:Lwt_bytes.t ->
  ?out_buffer:Lwt_bytes.t ->
  Unix.sockaddr ->
  (input_channel * output_channel) Lwt.t

open_connection ?fd ?in_buffer ?out_buffer addr opens a connection to the given address and returns two channels for using it. If fd is not specified, a fresh one will be used.

The connection is completly closed when you close both channels.

raises Unix.Unix_error
on error.

val with_connection : 
  ?fd:Lwt_unix.file_descr ->
  ?in_buffer:Lwt_bytes.t ->
  ?out_buffer:Lwt_bytes.t ->
  Unix.sockaddr ->
  ((input_channel * output_channel) -> 'a Lwt.t) ->
  'a Lwt.t

with_connection ?fd ?in_buffer ?out_buffer addr f opens a connection to the given address and passes the channels to f

type server

Type of a server

val establish_server : 
  ?fd:Lwt_unix.file_descr ->
  ?buffer_size:int ->
  ?backlog:int ->
  Unix.sockaddr ->
  ((input_channel * output_channel) -> unit) ->
  server

establish_server ?fd ?buffer_size ?backlog sockaddr f creates a server which listens for incoming connections. New connections are passed to f.

establish_server does not start separate threads for running f, nor close the connections passed to f. Thus, the skeleton of a practical server based on establish_server might look like this:

Lwt_io.establish_server address (fun (ic, oc) ->
  Lwt.async (fun () ->

    (* ... *)

    Lwt.catch (fun () -> Lwt_io.close oc) (fun _ -> Lwt.return_unit) >>=
    Lwt.catch (fun () -> Lwt_io.close ic) (fun _ -> Lwt.return_unit)))

If fd is not specified, a fresh file descriptor will be created for listening.

backlog is the argument passed to Lwt_unix.listen.

val shutdown_server : server -> unit

Close the given server's listening socket. This function does not wait for the close operation to actually complete. It does not affect the sockets of connections that have already been accepted, i.e. passed to f by establish_server or establish_server_safe.

val lines_of_file : file_name -> string Lwt_stream.t

lines_of_file name returns a stream of all lines of the file with name name. The file is automatically closed when all lines have been read.

val lines_to_file : file_name -> string Lwt_stream.t -> unit Lwt.t

lines_to_file name lines writes all lines of lines to file with name name.

val chars_of_file : file_name -> char Lwt_stream.t

chars_of_file name returns a stream of all characters of the file with name name. As for lines_of_file the file is closed when all characters have been read.

val chars_to_file : file_name -> char Lwt_stream.t -> unit Lwt.t

chars_to_file name chars writes all characters of chars to name

Input/output of integers

module type NumberIO = sig ... end

Common interface for reading/writing integers in binary

module LE : NumberIO

Reading/writing of numbers in little-endian

module BE : NumberIO

Reading/writing of numbers in big-endian

Reading/writing of numbers in the system endianness.

include NumberIO

Reading

val read_int : input_channel -> int Lwt.t

Reads a 32-bits integer as an ocaml int

val read_int16 : input_channel -> int Lwt.t

val read_int32 : input_channel -> int32 Lwt.t

val read_int64 : input_channel -> int64 Lwt.t

val read_float32 : input_channel -> float Lwt.t

Reads an IEEE single precision floating point value

val read_float64 : input_channel -> float Lwt.t

Reads an IEEE double precision floating point value

Writing

val write_int : output_channel -> int -> unit Lwt.t

Writes an ocaml int as a 32-bits integer

val write_int16 : output_channel -> int -> unit Lwt.t

val write_int32 : output_channel -> int32 -> unit Lwt.t

val write_int64 : output_channel -> int64 -> unit Lwt.t

val write_float32 : output_channel -> float -> unit Lwt.t

Writes an IEEE single precision floating point value

val write_float64 : output_channel -> float -> unit Lwt.t

Writes an IEEE double precision floating point value

type byte_order = Lwt_sys.byte_order =

| Little_endian
| Big_endian
(*
Type of byte order
*)

val system_byte_order : byte_order

Same as Lwt_sys.byte_order.

Low-level access to the internal buffer

val block : 'a channel -> int -> (Lwt_bytes.t -> int -> 'b Lwt.t) -> 'b Lwt.t

block ch size f pass to f the internal buffer and an offset. The buffer contains size chars at offset. f may read or write these chars. size must satisfy 0 <= size <= 16

type direct_access = {

da_buffer : Lwt_bytes.t;
(*
The internal buffer
*)
mutable da_ptr : int;
(*
The pointer to:
- the beginning of free space for output channels
- the beginning of data for input channels
*)
mutable da_max : int;
(*
The maximum offset
*)
da_perform : unit -> int Lwt.t;
(*
- for input channels: refills the buffer and returns how many bytes have been read
- for output channels: flush partially the buffer and returns how many bytes have been written
*)

}

Information for directly accessing the internal buffer of a channel

val direct_access : 'a channel -> (direct_access -> 'b Lwt.t) -> 'b Lwt.t

direct_access ch f passes to f a direct_access structure. f must use it and update da_ptr to reflect how many bytes have been read/written.

Misc

val default_buffer_size : unit -> int

Return the default size for buffers. Channels that are created without a specific buffer use new buffer of this size.

val set_default_buffer_size : int -> unit

Change the default buffer size.

raises Invalid_argument
if the given size is smaller than 16 or greater than Sys.max_string_length

package lwt

Types

Well-known instances

Channels creation/manipulation

Random access

Reading

Writing

Printing

Utilities

File utilities

Input/output of integers

Reading

Writing

Low-level access to the internal buffer

Misc