scmi_iodev.md

Module scmi_iodev

• Description
• Data Types
• Function Index
• Function Details

Scheme interpreter i/o device resource and client

. __Authors:__ Joseph Wayne Norton ([`[email protected]`](mailto:[email protected])).

Data Types

iodev()

abstract datatype: iodev()

mode_file()

mode_file() = scmi_iodev_server_file:mode()

mode_ram()

mode_ram() = scmi_iodev_server_ram:mode()

mode_std()

mode_std() = scmi_iodev_server_std:mode()

Function Index

close/1
close/2
flush/1
is_ready/1
is_resource/1
is_resource_alive/1
is_resource_alive/2
new/2
notify_when_destroyed/2
notify_when_destroyed/3
open/2
peek/2
read/2
read_all/1
read_line/1
write/2

Function Details

close/1

close(IODev::iodev()) -> boolean()

close/2

close(IODev::iodev(), Mode::read | write) -> boolean()

flush/1

flush(IODev::iodev()) -> ok | {error, Reason::term()}

is_ready/1

is_ready(IODev::iodev()) -> boolean()

is_resource/1

is_resource(Term::term()) -> boolean()

is_resource_alive/1

is_resource_alive(Term::term()) -> boolean()

is_resource_alive/2

is_resource_alive(Term::term(), Mode::read | write | binary) -> boolean()

new/2

new(Pid::pid(), Mod::module()) -> iodev()

notify_when_destroyed/2

notify_when_destroyed(Msg::term(), Iodev::iodev()) -> true

notify_when_destroyed/3

notify_when_destroyed(Pid::pid(), Msg::term(), X3::iodev()) -> true

open/2

open(Term::standard_io, Modes::[mode_std()]) -> iodev()

peek/2

peek(IODev::iodev(), K::non_neg_integer()) -> string() | binary() | eof | {error, Reason::term()}

read/2

read(IODev::iodev(), K::non_neg_integer()) -> string() | binary() | eof | {error, Reason::term()}

read_all/1

read_all(IODev::iodev()) -> string() | binary() | eof | {error, Reason::term()}

read_line/1

read_line(IODev::iodev()) -> string() | binary() | eof | {error, Reason::term()}

write/2

write(IODev::iodev(), Data::string() | binary()) -> ok | {error, Reason::term()}