emqtt_sock (emqtt v1.15.1)

View Source

Summary

Types

option/0

-type option() :: gen_tcp:connect_option() | {ssl_opts, [ssl:tls_client_option()]}.

socket/0

-type socket() :: inet:socket() | #ssl_socket{tcp :: term(), ssl :: term()}.

sockname/0

-type sockname() :: {inet:ip_address(), inet:port_number()}.

Functions

close(Sock)

-spec close(socket()) -> ok.

connect(Host, Port, SockOpts, Timeout)

-spec connect(inet:ip_address() | inet:hostname(), inet:port_number(), [option()], timeout()) ->
                 {ok, socket()} | {error, term()}.

getstat(Sock, Options)

-spec getstat(socket(), [atom()]) -> {ok, [{atom(), integer()}]} | {error, term()}.

recv(Sock, Length)

-spec recv(socket(), non_neg_integer()) -> {ok, iodata()} | {error, closed | inet:posix()}.

send(Sock, Data)

-spec send(socket(), iodata()) -> ok | {error, einval | closed}.

setopts(Sock, Opts)

-spec setopts(socket(), [gen_tcp:option() | ssl:tls_client_option()]) -> ok | {error, any()}.

sockname(Sock)

-spec sockname(socket()) -> {ok, sockname()} | {error, term()}.