| Overview |  |
erlzmq_capability() = ipc | pgm | tipc | norm | curve | gssapi | draft
abstract datatype: erlzmq_context()
erlzmq_ctxopt() = blocky | io_threads | thread_sched_policy | thread_priority | thread_affinity_cpu_add | thread_affinity_cpu_remove | thread_name_prefix | max_msgsz | msg_t_size | socket_limit | max_sockets | ipv6
erlzmq_data() = binary()
erlzmq_endpoint() = string() | binary()
erlzmq_error() = {error, erlzmq_error_type()}
erlzmq_error_type() = efsm | enocompatproto | eterm | emthread | errno() | unknown
erlzmq_poll_event() = pollin | pollout | pollerr | pollpri
erlzmq_send_recv_flag() = dontwait | sndmore | recvmore
erlzmq_send_recv_flags() = [erlzmq_send_recv_flag()]
abstract datatype: erlzmq_socket()
erlzmq_socket_type() = pair | pub | sub | req | rep | dealer | router | xreq | xrep | pull | push | xpub | xsub | stream
erlzmq_sockopt() = affinity | routing_id | subscribe | unsubscribe | rate | recovery_ivl | sndbuf | rcvbuf | rcvmore | fd | events | type | linger | reconnect_ivl | backlog | reconnect_ivl_max | maxmsgsize | sndhwm | rcvhwm | multicast_hops | rcvtimeo | sndtimeo | last_endpoint | router_mandatory | tcp_keepalive | tcp_keepalive_cnt | tcp_keepalive_idle | tcp_keepalive_intvl | immediate | xpub_verbose | router_raw | ipv6 | mechanism | plain_server | plain_username | plain_password | curve_server | curve_publickey | curve_secretkey | curve_serverkey | probe_router | req_correlate | req_relaxed | conflate | zap_domain | router_handover | tos | connect_routing_id | gssapi_server | gssapi_principal | gssapi_service_principal | gssapi_plaintext | handshake_ivl | socks_proxy | xpub_nodrop | xpub_manual | xpub_welcome_msg | stream_notify | invert_matching | heartbeat_ivl | heartbeat_ttl | heartbeat_timeout | xpub_verboser | connect_timeout | tcp_maxrt | thread_safe | multicast_maxtpdu | vmci_buffer_size | vmci_buffer_min_size | vmci_buffer_max_size | vmci_connect_timeout | use_fd | gssapi_principal_nametype | gssapi_service_principal_nametype | bindtodevice | ipv4only | tcp_accept_filter | connect_rid | delay_attach_on_connect | noblock | fail_unroutable | router_behavior | identity
erlzmq_sockopt_value() = integer() | iolist()
errno() = eperm | enoent | srch | eintr | eio | enxio | ebad | echild | edeadlk | enomem | eacces | efault | enotblk | ebusy | eexist | exdev | enodev | enotdir | eisdir | einval | enfile | emfile | enotty | etxtbsy | efbig | enospc | espipe | erofs | emlink | epipe | eagain | einprogress | ealready | enotsock | edestaddrreq | emsgsize | eprototype | enoprotoopt | eprotonosupport | esocktnosupport | enotsup | epfnosupport | eafnosupport | eaddrinuse | eaddrnotavail | enetdown | enetunreach | enetreset | econnaborted | econnreset | enobufs | eisconn | enotconn | eshutdown | etoomanyrefs | ehostunreach | etimedout | econnrefused | eloop | enametoolong | eaddnotavail
| bind/2 | Accept connections on a socket. |
| close/1 | Close the given socket. |
| connect/2 | Connect a socket. |
| context/0 | Equivalent to context(1).
|
| context/1 | Create a new erlzmq context with the specified number of io threads. |
| ctx_get/2 | Get an option associated with a context. |
| ctx_set/3 | Set an option associated with an option. |
| curve_keypair/0 | Generate a Curve keypair. |
| disconnect/2 | Disonnect a socket. |
| getsockopt/2 | Get an option associated with a socket. |
| has/1 | Checks if 0MQ library has given capability. |
| poll/3 | Allows multiplexing input output over 1 socket. |
| recv/1 | Equivalent to recv(Socket, 0).
|
| recv/2 | Receive a message from a socket. |
| recv_multipart/1 | Equivalent to recv_multipart(Socket, []).
|
| recv_multipart/2 | Receive a multipart message from a socket. |
| recvmsg/1 | This function exists for zeromq api compatibility and doesn't
actually provide any different functionality then what you get with
the erlzmq:recv/3 function. |
| recvmsg/2 | This function exists for zeromq api compatibility and doesn't
actually provide any different functionality then what you get with
the erlzmq:recv/3 function. |
| send/2 | Equivalent to send(Socket, Msg, []).
|
| send/3 | Send a message on a socket. |
| send_multipart/2 | Equivalent to send_multipart(Socket, Parts, []).
|
| send_multipart/3 | Send a multi part message on a socket. |
| sendmsg/2 | This function exists for zeromq api compatibility and doesn't
actually provide any different functionality then what you get with
the erlzmq:send/2 function. |
| sendmsg/3 | This function exists for zeromq api compatibility and doesn't
actually provide any different functionality then what you get with
the erlzmq:send/3 function. |
| setsockopt/3 | Set an option associated with a socket. |
| socket/2 | Create a socket. |
| term/1 | Terminate the given context. |
| unbind/2 | Stop accept connections on a socket. |
| version/0 | Returns the 0MQ library version. |
| z85_decode/1 | Decode a Z85-encoded iolist. |
| z85_encode/1 | Encode an iolist into Z85. |
bind(Socket::erlzmq_socket(), Endpoint::erlzmq_endpoint()) -> ok | erlzmq_error()
Accept connections on a socket.
For more information see
zmq_bind.
close(Socket::erlzmq_socket()) -> ok | erlzmq_error()
Close the given socket.
For more information see
zmq_close.
connect(Socket::erlzmq_socket(), Endpoint::erlzmq_endpoint()) -> ok | erlzmq_error()
Connect a socket.
For more information see
zmq_connect.
context() -> {ok, erlzmq_context()} | erlzmq_error()
Equivalent to context(1).
context(Threads::pos_integer()) -> {ok, erlzmq_context()} | erlzmq_error()
Create a new erlzmq context with the specified number of io threads.
If the context can be created an 'ok' tuple containing an
erlzmq_context() handle to the created context is returned;
if not, it returns an 'error' tuple with an erlzmq_type_error()
describing the error.
The context must be later cleaned up calling term/1
For more information see
zmq_init
ctx_get(Context::erlzmq_context(), Name::erlzmq_ctxopt()) -> {ok, integer()} | erlzmq_error()
Get an option associated with a context.
For more information see
zmq_ctx_get.
ctx_set(Context::erlzmq_context(), Name::erlzmq_ctxopt(), Value::integer()) -> ok | erlzmq_error()
Set an option associated with an option.
NOTE: Setting max_sockets will have no effect, due to the implementation
of zeromq. Instead, set max_sockets when creating the context.
For more information see
zmq_ctx_set.
curve_keypair() -> {ok, binary(), binary()} | erlzmq_error()
Generate a Curve keypair.
This will return two 40-character binaries, each a Z85-encoded
version of the 32-byte keys from curve.
For more information see
zmq_curve_keypair.
disconnect(Socket::erlzmq_socket(), Endpoint::erlzmq_endpoint()) -> ok | erlzmq_error()
Disonnect a socket.
For more information see
zmq_disconnect.
getsockopt(Socket::erlzmq_socket(), Name::erlzmq_sockopt()) -> {ok, erlzmq_sockopt_value()} | erlzmq_error()
Get an option associated with a socket.
For more information see
zmq_getsockopt.
has(Capability::erlzmq_capability()) -> boolean() | unknown | erlzmq_error()
Checks if 0MQ library has given capability.
For more information see
zmq_has.
poll(X1::erlzmq_socket(), Flags::[erlzmq_poll_event()], Timeout::integer()) -> {ok, [erlzmq_poll_event()]} | erlzmq_error()
Allows multiplexing input output over 1 socket.
Unlike zmq version only 1 socket is supported
For more information see
zmq_poll.
recv(Socket::erlzmq_socket()) -> {ok, erlzmq_data()} | erlzmq_error()
Equivalent to recv(Socket, 0).
recv(Socket::erlzmq_socket(), Flags::erlzmq_send_recv_flags()) -> {ok, erlzmq_data()} | erlzmq_error()
Receive a message from a socket.
For more information see
zmq_recv.
recv_multipart(Socket::erlzmq_socket()) -> {ok, [erlzmq_data()]} | erlzmq_error()
Equivalent to recv_multipart(Socket, []).
recv_multipart(Socket::erlzmq_socket(), Flags::erlzmq_send_recv_flags()) -> {ok, [erlzmq_data()]} | erlzmq_error()
Receive a multipart message from a socket.
recvmsg(Socket::erlzmq_socket()) -> {ok, erlzmq_data()} | erlzmq_error()
Equivalent to recv(Socket, 0).
This function exists for zeromq api compatibility and doesn't
actually provide any different functionality then what you get with
the erlzmq:recv/3 function. In fact this function just
calls that function. So there is a slight bit of additional
overhead as well.
recvmsg(Socket::erlzmq_socket(), Flags::erlzmq_send_recv_flags()) -> {ok, erlzmq_data()} | erlzmq_error()
Equivalent to recv(Socket, Flags).
This function exists for zeromq api compatibility and doesn't
actually provide any different functionality then what you get with
the erlzmq:recv/3 function. In fact this function just
calls that function. So there is a slight bit of additional
overhead as well.
send(Socket::erlzmq_socket(), Binary::iolist()) -> ok | erlzmq_error()
Equivalent to send(Socket, Msg, []).
send(X1::erlzmq_socket(), Binary::iolist(), Flags::erlzmq_send_recv_flags()) -> ok | erlzmq_error()
Send a message on a socket.
For more information see
zmq_send.
send_multipart(Socket::erlzmq_socket(), Parts::[iolist()]) -> ok | erlzmq_error()
Equivalent to send_multipart(Socket, Parts, []).
send_multipart(X1::erlzmq_socket(), Parts::[iolist()], Flags::erlzmq_send_recv_flags()) -> ok | erlzmq_error()
Send a multi part message on a socket.
sendmsg(Socket::erlzmq_socket(), Binary::iolist()) -> ok | erlzmq_error()
Equivalent to send(Socket, Msg, []).
This function exists for zeromq api compatibility and doesn't
actually provide any different functionality then what you get with
the erlzmq:send/2 function. In fact this function just
calls that function. So there is a slight bit of additional
overhead as well.
sendmsg(Socket::erlzmq_socket(), Binary::iolist(), Flags::erlzmq_send_recv_flags()) -> ok | erlzmq_error()
Equivalent to send(Socket, Msg, Flags).
This function exists for zeromq api compatibility and doesn't
actually provide any different functionality then what you get with
the erlzmq:send/3 function. In fact this function just
calls that function. So there is a slight bit of additional
overhead as well.
setsockopt(X1::erlzmq_socket(), Name::erlzmq_sockopt(), Value::erlzmq_sockopt_value()) -> ok | erlzmq_error()
Set an option associated with a socket.
For more information see
zmq_setsockopt.
socket(Context::erlzmq_context(), Type::erlzmq_socket_type()) -> {ok, erlzmq_socket()} | erlzmq_error()
Create a socket.
This functions creates a socket of the given
type
and associates it with the given context.
If the socket can be created an 'ok' tuple containing a
erlzmq_socket() handle to the created socket is returned;
if not, it returns an erlzmq_error() describing the error.
For more information see
zmq_socket.
term(Context::erlzmq_context()) -> ok | erlzmq_error()
Terminate the given context.
For more information see
zmq_term.
unbind(Socket::erlzmq_socket(), Endpoint::erlzmq_endpoint()) -> ok | erlzmq_error()
Stop accept connections on a socket.
For more information see
zmq_unbind.
version() -> {integer(), integer(), integer()}
Returns the 0MQ library version.
z85_decode(Z85::iolist()) -> {ok, binary()} | erlzmq_error()
Decode a Z85-encoded iolist
This will take a binary of size 5*n, and return a binary of size 4*n.
For more information see
zmq_z85_decode.
z85_encode(Binary::iolist()) -> {ok, binary()} | erlzmq_error()
Encode an iolist into Z85
This will take a binary of size 4*n, and return a binary of size 5*n.
For more information see
zmq_z85_encode.
Generated by EDoc