Module binbo_uci_connection

Data Types

engine_path()

engine_path() = binary() | string() | {tcp_host(), tcp_port(), timeout()}

socket_info()

socket_info() = {erlang, port()} | {gen_tcp, tcp_socket()}

tcp_host()

tcp_host() = inet:socket_address() | inet:hostname()

tcp_port()

tcp_port() = inet:port_number()

tcp_socket()

tcp_socket() = inet:socket()

Function Index

connect/1
disconnect/1
send_command/2

Function Details

connect/1

connect(EnginePath::binary() | string()) -> {ok, {erlang, port()}} | {error, any()}

connect(EnginePath::{tcp_host(), tcp_port(), timeout()}) -> {ok, {gen_tcp, tcp_socket()}} | {error, timeout | inet:posix()}

disconnect/1

disconnect(SocketInfo::socket_info() | undefined) -> ok

send_command/2

send_command(SocketInfo::socket_info(), Command::iodata()) -> ok


Generated by EDoc