ZMQ socket

选项
参考

选项

socket选项

ZMQ_SNDHWM

值类型	int
值	1000
特殊值	无限制：0
应用场景	所有socket
边界处理	pub/sub：TODO router/dealer：TODO

发送消息高水位（最大发送缓冲区缓存量，这只是理论上的硬限制值，实际缓冲区最大容量只能达到高水位的6-~70%左右）。

ZMQ_RCVHWM

值类型	int
默认值	1000
特殊值	0：无限制
应用场景	所有socket
边界处理	pub/sub：TODO router/dealer：TODO

接收消息高水位（最大接收缓冲区缓存量，这只是理论上的硬限制值，实际缓冲区最大容量只能达到高水位的6-~70%左右）。

ZMQ_AFFINITY

值类型	bitmap
默认值	0
特殊值	0：无关联
应用场景	所有socket
边界处理

设置I/O线程关联（指定socket新创建的链接与哪个线程关联），最低位对应线程，第2位对应线程2，以此类推。

ZMQ_SUBSCRIBE

值类型	二进制数据
默认值	N/A
特殊值	长度为0的二进制数据：订阅所有主题
应用场景	ZMQ_SUB
边界处理

订阅主题（支持订阅多个相同主题）。

ZMQ_UNSUBSCRIBE

值类型	二进制数据
默认值	N/A
特殊值	长度为0的二进制数据：订阅所有主题
应用场景	ZMQ_SUB
边界处理

取消订阅主题（如果订阅多个相同的主题，此操作指挥移除其中一个，其它可以继续使用）。

ZMQ_IDENTITY

值类型	二进制数据
默认值	NULL
特殊值
应用场景	ZMQ_REQ, ZMQ_REP, ZMQ_ROUTER, ZMQ_DEALER
边界处理	1. ID重名：TODO。

设置socket身份ID（socket ID主要用于消息路由）。

ZMQ_RATE

值类型	int (kbyte/s)
默认值	100
特殊值
应用场景	多路广播时，所有socket都有效。
边界处理

设置接收和发送广播数据的频率最大值。

ZMQ_RECOVERY_IVL

值类型	int (ms)
默认值	10000
特殊值
应用场景	多路广播时，所有socket都有效。
边界处理

设置多路广播恢复时间（一个接收端从一个广播组退出后再连接上来之前，数据丢失导致数据不可恢复的最大时间间隔（ms）；当设置较大的恢复时间时，非常耗内存）。

ZMQ_SNDBUF

值类型	int (Byte)
默认值	0
特殊值	0：使用OS默认值；
应用场景	对所有socket都有效。
边界处理

设置内核发送缓冲区大小。

ZMQ_RCVBUF

值类型	int (Byte)
默认值	0
特殊值	0：使用OS默认值；
应用场景	对所有socket都有效。
边界处理

设置内核接收缓冲区大小。

ZMQ_RCVMORE

ZMQ_FD

ZMQ_EVENTS

ZMQ_TYPE

ZMQ_LINGER

值类型	int (ms)
默认值	-1
特殊值	-1：无限停留时间；0：不停留，直接丢弃未发送消息。
应用场景	对所有socket都有效。
边界处理

为socket关闭设置停留时间（为尚未发送完的消息发送腾出时间，当时间到时，所有未发送的消息都被丢弃）。

ZMQ_RECONNECT_IVL

值类型	int (ms)
默认值	100
特殊值	-1：不进行重连
应用场景	当使用面向连接的传输方式时，对所有socket都有效。
边界处理

重连间隔（当对端的连接断开后，初次尝试重新连接的时长；不建议设置过小，防止“重连风暴”）。

ZMQ_BACKLOG

ZMQ_RECONNECT_IVL_MAX

值类型	int (ms)
默认值	0
特殊值	0：只使用`ZMQ_RECONNECT_IVL`设置的值，不进行指数补偿；
应用场景	当使用面向连接的传输方式时，对所有socket都有效。
边界处理	`< ZMQ_RECONNECT_IVL`：忽略这个值。

重连间隔最大值（与ZMQ_RECONNECT_IVL配合使用，使用指数补偿技术：每次重连都是上次时间间隔的2倍，直到ZMQ_RECONNECT_IVL == ZMQ_RECONNECT_IVL_MAX）。

ZMQ_MAXMSGSIZE

ZMQ_MULTICAST_HOPS

值类型	int
默认值	1
特殊值	1：多播数据包不能离开本地网路。
应用场景	当使用面向连接的传输方式时，对所有socket都有效。
边界处理

多播数据包的最大网络中继。

ZMQ_RCVTIMEO

值类型	int (ms)
默认值	-1
特殊值	-1：阻塞直到收到消息； 0：立即返回，如果没有收到任何消息，返回EAGAIN错误；
应用场景	对所有socket都有效。
边界处理

接收超时

ZMQ_SNDTIMEO

值类型	int (ms)
默认值	-1
特殊值	-1：阻塞直到收到消息； 0：立即返回，如果没有收到任何消息，返回EAGAIN错误；
应用场景	对所有socket都有效。
边界处理

发送超时

ZMQ_LAST_ENDPOINT

ZMQ_ROUTER_MANDATORY

ZMQ_TCP_KEEPALIVE

ZMQ_TCP_KEEPALIVE_CNT

ZMQ_TCP_KEEPALIVE_INTVL

ZMQ_IMMEDIATE

值类型	int
默认值	0
特殊值	0：false 1：true
应用场景	当使用面向连接的时候，所有socket可用；
边界处理

设置在连接在建立完成后进行发送（防止连接时丢包）。

ZMQ_XPUB_VERBOSE

值类型	int
默认值	0
特殊值	0：只允许新的订阅消息通过传输到上游； 1：允许所有的订阅消息传输到上游。
应用场景	ZMQ_XPUB
边界处理

设置订阅行为。

ZMQ_ROUTER_RAW

ZMQ_IPV6

ZMQ_MECHANISM

ZMQ_PLAIN_SERVER

ZMQ_PLAIN_USERNAME

ZMQ_PLAIN_PASSWORD

ZMQ_CURVE_SERVER

ZMQ_CURVE_PUBLICKEY

ZMQ_CURVE_SECRETKEY

ZMQ_CURVE_SERVERKEY

ZMQ_PROBE_ROUTER

ZMQ_REQ_CORRELATE

ZMQ_REQ_RELAXED

ZMQ_CONFLATE

ZMQ_ZAP_DOMAIN

ZMQ_ROUTER_HANDOVER

值类型	int
默认值	0
特殊值	0：不处理 1：遇到ID冲突时进行ID重新分配
应用场景	ZMQ_ROUTER
边界处理

设置如何处理ROUTER socket的ID冲突。

ZMQ_TOS

ZMQ_CONNECT_ROUTING_ID

ZMQ_GSSAPI_SERVER

ZMQ_GSSAPI_PRINCIPAL

ZMQ_GSSAPI_SERVICE_PRINCIPAL

ZMQ_GSSAPI_PLAINTEXT

ZMQ_HANDSHAKE_IVL

ZMQ_SOCKS_PROXY

ZMQ_XPUB_NODROP

ZMQ_BLOCKY

ZMQ_XPUB_MANUAL

ZMQ_XPUB_WELCOME_MSG

ZMQ_STREAM_NOTIFY

ZMQ_INVERT_MATCHING

ZMQ_HEARTBEAT_IVL

ZMQ_HEARTBEAT_TTL

ZMQ_HEARTBEAT_TIMEOUT

ZMQ_XPUB_VERBOSER

ZMQ_CONNECT_TIMEOUT

ZMQ_TCP_MAXRT

ZMQ_THREAD_SAFE

ZMQ_MULTICAST_MAXTPDU

ZMQ_VMCI_BUFFER_SIZE

ZMQ_VMCI_BUFFER_MIN_SIZE

ZMQ_VMCI_BUFFER_MAX_SIZE

ZMQ_VMCI_CONNECT_TIMEOUT

ZMQ_USE_FD

ZMQ_GSSAPI_PRINCIPAL_NAMETYPE

ZMQ_GSSAPI_SERVICE_PRINCIPAL_NAMETYPE

ZMQ_BINDTODEVICE

message选项

ZMQ_MORE

ZMQ_SHARED

send/recv 选项

ZMQ_DONTWAIT

ZMQ_SNDMORE

security mechainsms选项

ZMQ_NULL

ZMQ_PLAIN

ZMQ_CURVE

ZMQ_GSSAPI

RDDIO-DISH protocol选项

ZMQ_GROUP_MAX_LENGTH

注意

一般的选项都需要在bind/connect之前设置（以下选项除外）：

ZMQ_SUBSCRIBE
ZMQ_UNSUBSCRIBE
ZMQ_LINGER
ZMQ_ROUTER_HANDOVER
ZMQ_ROUTER_MANDATORY
ZMQ_PROBE_ROUTE
ZMQ_XPUB_VERBOSE
ZMQ_REQ_CORRELATE
ZMQ_REQ_RELAXED

FilesExpand file tree

socket_zh.md

Latest commit

History