Module `Zmq.Socket`Source

Sourcetype +'a t

Sourcetype 'a kind

Sourceval pair : [ `Pair ] kind

Sourceval pub : [ `Pub ] kind

Sourceval sub : [ `Sub ] kind

Sourceval req : [ `Req ] kind

Sourceval rep : [ `Rep ] kind

Sourceval dealer : [ `Dealer ] kind

Sourceval router : [ `Router ] kind

Sourceval pull : [ `Pull ] kind

Sourceval push : [ `Push ] kind

Sourceval xsub : [ `Xsub ] kind

Sourceval xpub : [ `Xpub ] kind

Sourceval stream : [ `Stream ] kind

Sourceval create : Context.t -> 'a kind -> 'a t

Creation and Destruction

Sourceval close : 'a t -> unit

Sourceval connect : 'a t -> string -> unit

Wiring

Sourceval disconnect : 'a t -> string -> unit

Sourceval bind : 'a t -> string -> unit

Sourceval unbind : 'a t -> string -> unit

Sourceval recv : ?block:bool -> 'a t -> string

Read a message from the socket. block indicates if the call should be blocking or non-blocking. If block is false, recv will raise Unix.Unix_error (Unix.EAGAIN, _, _) if there are no messages available to receive on the specified socket. Default true

Sourceval recv_all : ?block:bool -> 'a t -> string list

Read a complete multipart message from the socket. block indicates if the call should be blocking or non-blocking. Default true

Sourceval send : ?block:bool -> ?more:bool -> 'a t -> string -> unit

Send a message to the socket. block indicates if the call should be blocking or non-blocking. Default true more is used for multipart messages, and indicates that the more message parts will follow. Default false

Sourceval send_all : ?block:bool -> 'a t -> string list -> unit

Send a multipart message to the socket. block indicates if the call should be blocking or non-blocking. Default true

Sourceval recv_msg : ?block:bool -> 'a t -> Msg.t

Receive a Msg.t on the socket.

parameter block
indicates if the call should be blocking or non-blocking. Defaults to true.

Sourceval recv_msg_all : ?block:bool -> 'a t -> Msg.t list

Receive a multi-part message on the socket.

parameter block
indicates if the call should be blocking or non-blocking. Defaults to true.

Sourceval send_msg : ?block:bool -> ?more:bool -> 'a t -> Msg.t -> unit

Send a Msg.t to the socket.

parameter block
indicates if the call should be blocking or non-blocking. Defaults to true.

parameter more
is used for multipart messages Set to true to indicate that more message parts will follow. Defaults to false.

Sourceval send_msg_all : ?block:bool -> 'a t -> Msg.t list -> unit

Send a multi-part message to the socket.

parameter block
indicates if the call should be blocking or non-blocking. Defaults to true.

Option Getter and Setters

Sourceval set_max_message_size : 'a t -> int -> unit

Set the maximum message size of a message sent in this context, represented as a signed integer. A value of -1 will set the max message size to 2^64-1.

Sourceval get_max_message_size : 'a t -> int

Get the maximum message size for this context represented as a signed integer. A value of -1 equals to 2^64-1.

Sourceval set_affinity : 'a t -> int -> unit

Set thread affinity. Affinity is represented as a bit vector

Sourceval get_affinity : 'a t -> int

Get thread affinity, represented as a bit vector.

Sourceval set_identity : 'a t -> string -> unit

Sourceval get_identity : 'a t -> string

Sourceval subscribe : [< `Sub ] t -> string -> unit

Sourceval unsubscribe : [< `Sub ] t -> string -> unit

Sourceval get_last_endpoint : 'a t -> string

Sourceval set_tcp_accept_filter : 'a t -> string -> unit

Sourceval set_rate : 'a t -> int -> unit

Sourceval get_rate : 'a t -> int

Sourceval set_recovery_interval : 'a t -> int -> unit

Sourceval get_recovery_interval : 'a t -> int

Sourceval set_send_buffer_size : 'a t -> int -> unit

Sourceval get_send_buffer_size : 'a t -> int

Sourceval set_receive_buffer_size : 'a t -> int -> unit

Sourceval get_receive_buffer_size : 'a t -> int

Sourceval has_more : 'a t -> bool

Sourceval set_linger_period : 'a t -> int -> unit

Sourceval get_linger_period : 'a t -> int

Sourceval set_reconnect_interval : 'a t -> int -> unit

Sourceval get_reconnect_interval : 'a t -> int

Sourceval set_connection_backlog : 'a t -> int -> unit

Sourceval get_connection_backlog : 'a t -> int

Sourceval set_reconnect_interval_max : 'a t -> int -> unit

Sourceval get_reconnect_interval_max : 'a t -> int

Sourceval set_send_high_water_mark : 'a t -> int -> unit

Sourceval get_send_high_water_mark : 'a t -> int

Sourceval set_receive_high_water_mark : 'a t -> int -> unit

Sourceval get_receive_high_water_mark : 'a t -> int

Sourceval set_multicast_hops : 'a t -> int -> unit

Sourceval get_multicast_hops : 'a t -> int

Sourceval set_receive_timeout : 'a t -> int -> unit

Sourceval get_receive_timeout : 'a t -> int

Sourceval set_send_timeout : 'a t -> int -> unit

Sourceval get_send_timeout : 'a t -> int

Sourceval set_ipv6 : 'a t -> bool -> unit

Sourceval get_ipv6 : 'a t -> bool

Sourceval set_router_mandatory : [> `Router ] t -> bool -> unit

Sourceval get_router_mandatory : [> `Router ] t -> bool

Sourceval set_tcp_keepalive : 'a t -> [ `Default | `Value of bool ] -> unit

Sourceval get_tcp_keepalive : 'a t -> [ `Default | `Value of bool ]

Sourceval set_tcp_keepalive_idle : 'a t -> [ `Default | `Value of int ] -> unit

Sourceval get_tcp_keepalive_idle : 'a t -> [ `Default | `Value of int ]

Sourceval set_tcp_keepalive_count : 'a t -> [ `Default | `Value of int ] -> unit

Sourceval get_tcp_keepalive_count : 'a t -> [ `Default | `Value of int ]

Sourceval set_tcp_keepalive_interval : 'a t -> [ `Default | `Value of int ] -> unit

Sourceval get_tcp_keepalive_interval : 'a t -> [ `Default | `Value of int ]

Sourceval set_immediate : 'a t -> bool -> unit

Sourceval get_immediate : 'a t -> bool

Sourceval set_xpub_verbose : [< `Xpub ] t -> bool -> unit

Sourceval set_probe_router : [< `Router | `Dealer | `Req ] t -> bool -> unit

Sourceval set_req_correlate : [< `Req ] t -> bool -> unit

Sourceval set_req_relaxed : [< `Req ] t -> bool -> unit

Sourceval set_plain_server : 'a t -> bool -> unit

Sourceval set_plain_username : 'a t -> string -> unit

Sourceval get_plain_username : 'a t -> string

Sourceval set_plain_password : 'a t -> string -> unit

Sourceval get_plain_password : 'a t -> string

Sourceval set_curve_server : 'a t -> bool -> unit

Sourceval set_curve_publickey : 'a t -> string -> unit

Sourceval get_curve_publickey : 'a t -> string

Sourceval set_curve_secretkey : 'a t -> string -> unit

Sourceval get_curve_secretkey : 'a t -> string

Sourceval set_curve_serverkey : 'a t -> string -> unit

Sourceval get_curve_serverkey : 'a t -> string

Sourceval get_mechanism : 'a t -> [ `Null | `Plain | `Curve ]

Sourceval set_zap_domain : 'a t -> string -> unit

Sourceval get_zap_domain : 'a t -> string

Sourceval set_conflate : [< `Pull | `Push | `Sub | `Pub | `Dealer ] t -> bool -> unit

Sourceval get_fd : 'a t -> Unix.file_descr

Sourcetype event =

| No_event
| Poll_in
| Poll_out
| Poll_in_out
| Poll_error

Sourceval events : 'a t -> event

package zmq

Module Zmq.SocketSource

Module `Zmq.Socket`Source