Ocamlnet 4 Reference Manual : Netchannels

`sig
exception Closed_channel
exception Buffer_underrun
exception Command_failure of Unix.process_status
class type rec_in_channel =
object
method close_in : unit -> unit
method input : Stdlib.Bytes.t -> int -> int -> int
end
class type raw_in_channel =
object
method close_in : unit -> unit
method input : Bytes.t -> int -> int -> int
method pos_in : int
end
class type rec_out_channel =
object
method close_out : unit -> unit
method flush : unit -> unit
method output : Stdlib.Bytes.t -> int -> int -> int
end
class type raw_out_channel =
object
method close_out : unit -> unit
method flush : unit -> unit
method output : Bytes.t -> int -> int -> int
method pos_out : int
end
class type raw_io_channel =
object
method close_in : unit -> unit
method close_out : unit -> unit
method flush : unit -> unit
method input : Bytes.t -> int -> int -> int
method output : Bytes.t -> int -> int -> int
method pos_in : int
method pos_out : int
end
class type compl_in_channel =
object
method input_byte : unit -> int
method input_char : unit -> char
method input_line : unit -> string
method really_input : Stdlib.Bytes.t -> int -> int -> unit
method really_input_string : int -> string
end
class type in_obj_channel =
object
method close_in : unit -> unit
method input : Bytes.t -> int -> int -> int
method input_byte : unit -> int
method input_char : unit -> char
method input_line : unit -> string
method pos_in : int
method really_input : Bytes.t -> int -> int -> unit
method really_input_string : int -> string
end
class type compl_out_channel =
object
method output_buffer : Stdlib.Buffer.t -> unit
method output_byte : int -> unit
method output_bytes : Stdlib.Bytes.t -> unit
method output_channel : ?len:int -> Netchannels.in_obj_channel -> unit
method output_char : char -> unit
method output_string : string -> unit
method really_output : Stdlib.Bytes.t -> int -> int -> unit
method really_output_string : string -> int -> int -> unit
end
class type out_obj_channel =
object
method close_out : unit -> unit
method flush : unit -> unit
method output : Bytes.t -> int -> int -> int
method output_buffer : Buffer.t -> unit
method output_byte : int -> unit
method output_bytes : Bytes.t -> unit
method output_channel : ?len:int -> in_obj_channel -> unit
method output_char : char -> unit
method output_string : string -> unit
method pos_out : int
method really_output : Bytes.t -> int -> int -> unit
method really_output_string : string -> int -> int -> unit
end
class type io_obj_channel =
object
method close_in : unit -> unit
method close_out : unit -> unit
method flush : unit -> unit
method input : Bytes.t -> int -> int -> int
method input_byte : unit -> int
method input_char : unit -> char
method input_line : unit -> string
method output : Bytes.t -> int -> int -> int
method output_buffer : Buffer.t -> unit
method output_byte : int -> unit
method output_bytes : Bytes.t -> unit
method output_channel : ?len:int -> in_obj_channel -> unit
method output_char : char -> unit
method output_string : string -> unit
method pos_in : int
method pos_out : int
method really_input : Bytes.t -> int -> int -> unit
method really_input_string : int -> string
method really_output : Bytes.t -> int -> int -> unit
method really_output_string : string -> int -> int -> unit
end
class type trans_out_obj_channel =
object
method close_out : unit -> unit
method commit_work : unit -> unit
method flush : unit -> unit
method output : Bytes.t -> int -> int -> int
method output_buffer : Buffer.t -> unit
method output_byte : int -> unit
method output_bytes : Bytes.t -> unit
method output_channel : ?len:int -> in_obj_channel -> unit
method output_char : char -> unit
method output_string : string -> unit
method pos_out : int
method really_output : Bytes.t -> int -> int -> unit
method really_output_string : string -> int -> int -> unit
method rollback_work : unit -> unit
end
class input_channel :
?onclose:(unit -> unit) -> Stdlib.in_channel -> in_obj_channel
val input_channel :
?onclose:(unit -> unit) ->
Stdlib.in_channel -> Netchannels.in_obj_channel
class input_command : string -> in_obj_channel
val input_command : string -> Netchannels.in_obj_channel
class input_string : ?pos:int -> ?len:int -> string -> in_obj_channel
val input_string :
?pos:int -> ?len:int -> string -> Netchannels.in_obj_channel
class input_bytes :
?pos:int -> ?len:int -> Stdlib.Bytes.t -> in_obj_channel
val input_bytes :
?pos:int -> ?len:int -> Stdlib.Bytes.t -> Netchannels.in_obj_channel
class input_memory :
?pos:int -> ?len:int -> Netsys_types.memory -> in_obj_channel
val input_memory :
?pos:int -> ?len:int -> Netsys_types.memory -> Netchannels.in_obj_channel
val input_tstring :
?pos:int ->
?len:int -> Netsys_types.tstring -> Netchannels.in_obj_channel
val create_input_netbuffer :
?keep_data:bool ->
Netbuffer.t -> Netchannels.in_obj_channel * (unit -> unit)
val lexbuf_of_in_obj_channel :
Netchannels.in_obj_channel -> Stdlib.Lexing.lexbuf
val string_of_in_obj_channel : Netchannels.in_obj_channel -> string
val bytes_of_in_obj_channel : Netchannels.in_obj_channel -> Stdlib.Bytes.t
val lines_of_in_obj_channel : Netchannels.in_obj_channel -> string list
val with_in_obj_channel :
(#Netchannels.in_obj_channel as 'a) -> ('a -> 'b) -> 'b
class output_channel :
?onclose:(unit -> unit) -> Stdlib.out_channel -> out_obj_channel
class output_command : ?onclose:(unit -> unit) -> string -> out_obj_channel
class output_buffer :
?onclose:(unit -> unit) -> Stdlib.Buffer.t -> out_obj_channel
class output_netbuffer :
?onclose:(unit -> unit) -> Netbuffer.t -> out_obj_channel
class output_null : ?onclose:(unit -> unit) -> unit -> out_obj_channel
val with_out_obj_channel :
(#Netchannels.out_obj_channel as 'a) -> ('a -> 'b) -> 'b
class rec_in_channel_delegation :
?close:bool -> Netchannels.rec_in_channel -> rec_in_channel
class raw_in_channel_delegation :
?close:bool -> Netchannels.raw_in_channel -> raw_in_channel
class in_obj_channel_delegation :
?close:bool -> Netchannels.in_obj_channel -> in_obj_channel
class rec_out_channel_delegation :
?close:bool -> Netchannels.rec_out_channel -> rec_out_channel
class raw_out_channel_delegation :
?close:bool -> Netchannels.raw_out_channel -> raw_out_channel
class out_obj_channel_delegation :
?close:bool -> Netchannels.out_obj_channel -> out_obj_channel
val lift_in :
?eol:string list ->
?buffered:bool ->
?buffer_size:int ->
?pass_through:int ->
[ `Raw of Netchannels.raw_in_channel | `Rec of Netchannels.rec_in_channel
] -> Netchannels.in_obj_channel
val lift_out :
?buffered:bool ->
?buffer_size:int ->
?pass_through:int ->
[ `Raw of Netchannels.raw_out_channel
| `Rec of Netchannels.rec_out_channel ] -> Netchannels.out_obj_channel
class virtual augment_raw_in_channel :
object
method virtual close_in : unit -> unit
method virtual input : Stdlib.Bytes.t -> int -> int -> int
method input_byte : unit -> int
method input_char : unit -> char
method input_line : unit -> string
method virtual pos_in : int
method really_input : Bytes.t -> int -> int -> unit
method really_input_string : int -> string
end
class lift_rec_in_channel :
?start_pos_in:int -> Netchannels.rec_in_channel -> in_obj_channel
class virtual augment_raw_out_channel :
object
method virtual close_out : unit -> unit
method virtual flush : unit -> unit
method virtual output : Stdlib.Bytes.t -> int -> int -> int
method output_buffer : Buffer.t -> unit
method output_byte : int -> unit
method output_bytes : Bytes.t -> unit
method output_channel : ?len:int -> in_obj_channel -> unit
method output_char : char -> unit
method output_string : string -> unit
method virtual pos_out : int
method really_output : Bytes.t -> int -> int -> unit
method really_output_string : string -> int -> int -> unit
end
class lift_raw_out_channel : Netchannels.raw_out_channel -> out_obj_channel
class lift_rec_out_channel :
?start_pos_out:int -> Netchannels.rec_out_channel -> out_obj_channel
type input_result = [ `Data of int | `Separator of string ]
class type enhanced_raw_in_channel =
object
method close_in : unit -> unit
method private enhanced_input :
Stdlib.Bytes.t -> int -> int -> Netchannels.input_result
method private enhanced_input_line : unit -> string
method input : Bytes.t -> int -> int -> int
method pos_in : int
end
class buffered_raw_in_channel :
?eol:string list ->
?buffer_size:int ->
?pass_through:int ->
Netchannels.raw_in_channel -> enhanced_raw_in_channel
class buffered_raw_out_channel :
?buffer_size:int ->
?pass_through:int -> Netchannels.raw_out_channel -> raw_out_channel
class input_descr :
?blocking:bool ->
?start_pos_in:int ->
?fd_style:Netsys.fd_style -> Unix.file_descr -> raw_in_channel
class output_descr :
?blocking:bool ->
?start_pos_out:int ->
?fd_style:Netsys.fd_style -> Unix.file_descr -> raw_out_channel
class socket_descr :
?blocking:bool ->
?start_pos_in:int ->
?start_pos_out:int ->
?fd_style:Netsys.fd_style -> Unix.file_descr -> raw_io_channel
type close_mode = [ `Commit | `Rollback ]
class buffered_trans_channel :
?close_mode:Netchannels.close_mode ->
Netchannels.out_obj_channel -> trans_out_obj_channel
val make_temporary_file :
?mode:int ->
?limit:int ->
?tmp_directory:string ->
?tmp_prefix:string ->
unit -> string * Stdlib.in_channel * Stdlib.out_channel
class tempfile_trans_channel :
?close_mode:Netchannels.close_mode ->
?tmp_directory:string ->
?tmp_prefix:string ->
Netchannels.out_obj_channel -> trans_out_obj_channel
class pipe :
?conv:(Netbuffer.t -> bool -> Netbuffer.t -> unit) ->
?buffer_size:int -> unit -> io_obj_channel
class output_filter :
Netchannels.io_obj_channel ->
Netchannels.out_obj_channel -> out_obj_channel
class input_filter :
Netchannels.in_obj_channel ->
Netchannels.io_obj_channel -> in_obj_channel
end`