scmi_iodev_server_std.md

Module scmi_iodev_server_std

• Description
• Data Types
• Function Index
• Function Details

Scheme interpreter i/o device stdio and stderr server

. __Behaviours:__ [`gen_server`](gen_server.html).

Authors: Joseph Wayne Norton ([email protected]).

Data Types

mode()

mode() = read | write

mode_error()

mode_error() = write

opt()

opt() = {read, boolean()} | {write, boolean()} | {binary, false} | {test, boolean()}

server()

server() = pid()

Function Index

close/1
close/2
code_change/3
flush/1
getopts/1
getopts/2
handle_call/3
handle_cast/2
handle_info/2
init/1
is_ready/1
peek/2
read/2
read_all/1
read_line/1
start/2
terminate/2
write/2

Function Details

close/1

close(Server::server()) -> boolean()

close/2

close(Server::server(), Mode::read | write) -> boolean()

code_change/3

code_change(OldVsn, State, Extra) -> any()

flush/1

flush(Server::server()) -> ok | {error, Reason::term()}

getopts/1

getopts(Server::server()) -> [opt()]

getopts/2

getopts(Server::server(), Mode::read | write | binary) -> boolean()

handle_call/3

handle_call(Msg, From, State) -> any()

handle_cast/2

handle_cast(Msg, State) -> any()

handle_info/2

handle_info(Info, State) -> any()

init/1

init(X1::{iodata() | standard_io | standard_error, [mode()]}) -> {ok, #state{}}

is_ready/1

is_ready(Server::server()) -> boolean()

peek/2

peek(Server::server(), K::non_neg_integer()) -> string() | eof | {error, Reason::term()}

read/2

read(Server::server(), K::non_neg_integer()) -> string() | eof | {error, Reason::term()}

read_all/1

read_all(Server::server()) -> string() | eof | {error, Reason::term()}

read_line/1

read_line(Server::server()) -> string() | eof | {error, Reason::term()}

start/2

start(Term::standard_io, Modes::[mode()]) -> {ok, pid()} | ignore | {error, Reason::term()}

terminate/2

terminate(Reason, State) -> any()

write/2

write(Server::server(), Data::string()) -> ok | {error, Reason::term()}