Up  Next

Module Extended_linux.Epoll


module Epoll: sig .. end

Epoll flags


type flag =
| IN
| OUT
| PRI
| ERR
| HUP
| ET
| ONESHOT 
val bin_size_flag : flag Bin_prot.Size.sizer
val bin_write_flag : flag Bin_prot.Write_ml.writer
val bin_write_flag_ : flag Bin_prot.Unsafe_write_c.writer
val bin_writer_flag : flag Bin_prot.Type_class.writer
val bin_read_flag : flag Bin_prot.Read_ml.reader
val bin_read_flag_ : flag Bin_prot.Unsafe_read_c.reader
val bin_read_flag__ : (int -> flag) Bin_prot.Unsafe_read_c.reader
val bin_reader_flag : flag Bin_prot.Type_class.reader
val bin_flag : flag Bin_prot.Type_class.t
val sexp_of_flag : flag -> Sexplib.Sexp.t
val flag_of_sexp : Sexplib.Sexp.t -> flag
Type of Epoll event flag
type flags
Type of Epoll event flags
val make_flags : flag array -> flags
make_flags ar
Returns flags constructed from the array of flags ar.
val get_flags : flags -> flag array
get_flags flags
Returns the array of all flags set in flags.
val has_in : flags -> bool
has_in flags
Returns true iff the EPOLLIN flag is set in flags.
val has_out : flags -> bool
has_out flags
Returns true iff the EPOLLOUT flag is set in flags.
val has_pri : flags -> bool
has_pri flags
Returns true iff the EPOLLPRI flag is set in flags.
val has_err : flags -> bool
has_err flags
Returns true iff the EPOLLERR flag is set in flags.
val has_hup : flags -> bool
has_hup flags
Returns true iff the EPOLLHUP flag is set in flags.
val has_et : flags -> bool
has_et flags
Returns true iff the EPOLLET flag is set in flags.
val has_oneshot : flags -> bool
has_oneshot flags
Returns true iff the EPOLLONESHOT flag is set in flags.
val flag_to_string : flag -> string

Epoll functions

val create : int -> Core.Std.Unix.file_descr
create n
Raises Unix_error on Unix-errors.
Returns epoll file descriptor that preallocates n event backing stores for file descriptors.
val add : epfd:Core.Std.Unix.file_descr ->
       fd:Core.Std.Unix.file_descr -> flags -> unit
add ~epfd ~fd flags add file descriptor fd to epoll file descriptor epfd using event flags flags.
Raises Unix_error on Unix-errors.
val modify : epfd:Core.Std.Unix.file_descr ->
       fd:Core.Std.Unix.file_descr -> flags -> unit
modify ~epfd ~fd flags modifies file descriptor fd controlled by epoll file descriptor epfd using event flags flags.
Raises Unix_error on Unix-errors.
val del : epfd:Core.Std.Unix.file_descr -> fd:Core.Std.Unix.file_descr -> unit
del ~epfd ~fd removes file descriptor fd from epoll file descriptor epfd.
Raises Unix_error on Unix-errors.
val wait : Core.Std.Unix.file_descr ->
       maxevents:int ->
       timeout:int -> (Core.Std.Unix.file_descr * flags) array
wait epfd ~maxevents ~timeout waits for at most maxevents events on epoll file descriptor epfd using timeout timeout.
Raises Returns the array of received events. If a timeout occurs, the returned array will be empty.