package gapi-ocaml

  1. Overview
  2. Docs
Legend:
Library
Module
Module type
Parameter
Class
Class type

Creates a raw_in_channel for the passed file descriptor, which must * be open for reading. * * The pos_in method returns logical positions, i.e. it counts the number * of read octets. It is not tried to determine the real file position. * * The method close_in also closes the file descriptor. * * This class also supports Win32 proxy descriptors referring to an input * channel. * *

  • parameter blocking

    Whether the channel waits for data if it is not * possible to read from the (non-blocking) descriptor. Defaults to true. *

    @param start_pos_in

    The position to which pos_in is initialized when * the channel is created, by default 0 *

    @param fd_style

    The descriptor style. If omitted, it is automatically * determined if possible.

method pos_in : int

Returns the current channel position. This position can be expected * to be consistent with the returned number of bytes of input, i.e. * when input returns n, the position is advanced by n. * * As seek operations are outside the scope of Netchannels, * implementations may or may not take seek operations into account.

OCaml

Innovation. Community. Security.