Abstract types for buffered sockets.

Create an input channel reading from the given descriptor.

Create an output channel writing on the given descriptor.

Return the descriptor corresponding to an input channel.

Return the descriptor corresponding to an output channel.

Connect to a server at the given address. Return a buffered socket. Can raise the same exceptions as Unix.open_connection.

``Shut down'' a connection established with Socket.open_connection; that is, transmit an end-of-file condition to the server reading on the other side of the connection. (You should flush the out_channels connected to the same socket if you want to make sure all data is transmitted.)

output oc buf pos len writes len characters from string buf, starting at offset pos, to the given buffered socket oc.

• raises Invalid_argument

  "Socket.output" if pos and len do not designate a valid substring of buf.

• raises Sys_blocked_io

  if we are in non-blocking mode and output would block.

Write the character on the given buffered socket.

Write the string on the given buffered socket.

fprintf oc format arguments is like Printf.fprintf except that oc is a buffered socket.

Flush the output buffer associated with the given buffered socket.

close_out oc closes the socket oc, flushing all buffered write operations. (This closes the underlying file descriptor as well.) Output functions raise a Sys_error exception when they are applied to a closed output channel, except close_out and flush which do nothing.

input ic buf pos len reads up to len characters from the given socket ic, storing them in string buf, starting at character number pos. It returns the actual number of characters read, between 0 and len (inclusive).

A return value of 0 means that the end of file was reached.

• raises Invalid_argument

  "Socket.input" if pos and len do not designate a valid substring of buf.

• raises Sys_blocked_io

  if we are in non-blocking mode and input would block (no characters are then read).

Read one character from the given input channel.

• raises End_of_file

  if there are no more characters to read.

• raises Sys_blocked_io

  if we are in non-blocking mode and input_char would block (no characters are then read).

really_input ic buf pos len reads len characters from the buffered socket ic, storing them in string buf, starting at character number pos.

• raises End_of_file

  if the end of file is reached before len characters have been read.

• raises Invalid_argument

  "Socket.really_read" if pos and len do not designate a valid substring of buf.

• raises Sys_blocked_io

  if we are in non-blocking mode and really_input would block (the characters that may have been read are lost).

input_line ic returns the next line from the socket ic without the final '\n'.

• raises End_of_file

  if the end of the file is reached.

• raises Sys_blocked_io

  if we are in non-blocking mode and input_line would block (the characters that may have been read are lost).

input_till c ic buf pos len reads up to len characters different from c from the socket ic, storing them in string buf, starting at character number pos. The return value is the actual number of characters read (different from c), between 0 and len (inclusive). If c is encountered, the reading stops. c is left in the input stream; thus all further input_till commands will return 0.

• raises End_of_file

  if the end of the file is reached (i.e., there are no more characters to read). This is different from the return value being 0 -- the latter indicating that the first character in the stream is c.

• raises Invalid_argument

  "Socket.input_till" if pos and len do not designate a valid substring of buf.

• raises Sys_blocked_io

  if we are in non-blocking mode and input_till would block (no characters are then read).

input_all_till c ic returns the next chunk from the socket ic from the current position to the character c (excluded) or the end of the file. The character c is read and discarded.

• raises End_of_file

  if the end of the file is reached before any character can be read. (This is different from an empty string being returned which indicates that c is the first character in the input stream.)

• raises Sys_blocked_io

  if we are in non-blocking mode and input_all_till would block (the characters that may have been read are lost).

close_in ic closes the socket ic. (This closes the underlying file descriptor as well.) Input functions raise a Sys_error exception when they are applied to a closed input channel, except close_in, which does nothing when applied to an already closed channel.

select inl outl t waits at most t seconds until some input/output operations become possible on some channels among inl and outl. A negative t means unbounded wait. The result is composed of two sets of channels: those ready for reading (first component) and those ready for writing (second component).