From 2823f3342a0252403312575d8bd0ae2221adcc34 Mon Sep 17 00:00:00 2001 From: "Documenter.jl" Date: Wed, 17 Jul 2024 22:45:28 +0000 Subject: [PATCH] build based on e66c836 --- dev/.documenter-siteinfo.json | 2 +- dev/_changelog/index.html | 2 +- dev/bindings/index.html | 2 ++ dev/changelog/index.html | 2 +- dev/index.html | 2 +- dev/man/examples/index.html | 2 +- dev/man/guide/index.html | 4 ++-- dev/objects.inv | Bin 922 -> 1727 bytes dev/reference/index.html | 2 +- dev/search_index.js | 2 +- 10 files changed, 11 insertions(+), 9 deletions(-) create mode 100644 dev/bindings/index.html diff --git a/dev/.documenter-siteinfo.json b/dev/.documenter-siteinfo.json index a240124..b0f16e0 100644 --- a/dev/.documenter-siteinfo.json +++ b/dev/.documenter-siteinfo.json @@ -1 +1 @@ -{"documenter":{"julia_version":"1.10.4","generation_timestamp":"2024-07-15T20:06:15","documenter_version":"1.5.0"}} \ No newline at end of file +{"documenter":{"julia_version":"1.10.4","generation_timestamp":"2024-07-17T22:45:25","documenter_version":"1.5.0"}} \ No newline at end of file diff --git a/dev/_changelog/index.html b/dev/_changelog/index.html index c5577d9..c00b2f8 100644 --- a/dev/_changelog/index.html +++ b/dev/_changelog/index.html @@ -1,2 +1,2 @@ -Changelog · ZMQ.jl
GitHub

Changelog

This documents notable changes in ZMQ.jl. The format is based on Keep a Changelog.

Unreleased

Added

  • Support for creating Message's from the new Memory type in Julia 1.11 ([#244]).

Fixed

  • Fixed isfreed(), which would previously return the wrong values ([#245]).

[v1.2.6] - 2024-06-13

Added

Fixed

  • Fixed a precompilation bug that would cause creating a sysimage with PackageCompiler.jl on Julia 1.6 to fail ([#242]).

[v1.2.5] - 2024-05-28

Fixed

  • Fixed support for Julia 1.3 in the precompilation workload ([#237]).

[v1.2.4] - 2024-05-27

Changed

  • Refactored the internals to use the public FileWatching.FDWatcher instead of FileWatching._FDWatcher ([#215]).

Fixed

  • Docstrings to inner constructors are now assigned properly ([#227]).
  • Socket now holds a reference to its Context to prevent it from being garbage collected accidentally ([#229]).
  • Changed the precompilation workload to use any available port to avoid port conflicts ([#234]).

[v1.2.3] - 2024-05-12

Added

  • Support for setting ZMQ_IMMEDIATE and ZMQ_CONFLATE on sockets ([#209], [#222]).
  • Overloads for Message to allow deserializing them with MsgPack.jl ([#214]).
  • A precompilation workload to improve TTFX ([#224]).
+Changelog · ZMQ.jl
GitHub

Changelog

This documents notable changes in ZMQ.jl. The format is based on Keep a Changelog.

Unreleased

Added

  • Support for creating Message's from the new Memory type in Julia 1.11 ([#244]).
  • Full Bindings to libzmq ([#232]).

Fixed

  • Fixed isfreed(), which would previously return the wrong values ([#245]).

[v1.2.6] - 2024-06-13

Added

Fixed

  • Fixed a precompilation bug that would cause creating a sysimage with PackageCompiler.jl on Julia 1.6 to fail ([#242]).

[v1.2.5] - 2024-05-28

Fixed

  • Fixed support for Julia 1.3 in the precompilation workload ([#237]).

[v1.2.4] - 2024-05-27

Changed

  • Refactored the internals to use the public FileWatching.FDWatcher instead of FileWatching._FDWatcher ([#215]).

Fixed

  • Docstrings to inner constructors are now assigned properly ([#227]).
  • Socket now holds a reference to its Context to prevent it from being garbage collected accidentally ([#229]).
  • Changed the precompilation workload to use any available port to avoid port conflicts ([#234]).

[v1.2.3] - 2024-05-12

Added

  • Support for setting ZMQ_IMMEDIATE and ZMQ_CONFLATE on sockets ([#209], [#222]).
  • Overloads for Message to allow deserializing them with MsgPack.jl ([#214]).
  • A precompilation workload to improve TTFX ([#224]).
diff --git a/dev/bindings/index.html b/dev/bindings/index.html new file mode 100644 index 0000000..435a4ae --- /dev/null +++ b/dev/bindings/index.html @@ -0,0 +1,2 @@ + +Bindings · ZMQ.jl
GitHub

Bindings

This page documents the low-level bindings to libzmq that were automatically generated. Where possible, the docstrings link to the upstream documentation. Bindings have not been generated for deprecated functions.

Danger

These bindings are unsafe, do not use them unless you know what you're doing.

ZMQ.lib.zmq_sleep — Method
zmq_sleep(seconds_)

This is an undocumented function, not part of the formal ZMQ API.

source
diff --git a/dev/changelog/index.html b/dev/changelog/index.html index ad9fa1f..e004d86 100644 --- a/dev/changelog/index.html +++ b/dev/changelog/index.html @@ -1,2 +1,2 @@ -Changelog · ZMQ.jl
GitHub

Changelog

This documents notable changes in ZMQ.jl. The format is based on Keep a Changelog.

Unreleased

Added

  • Support for creating Message's from the new Memory type in Julia 1.11 (#244).

Fixed

  • Fixed isfreed(), which would previously return the wrong values (#245).

v1.2.6 - 2024-06-13

Added

Fixed

  • Fixed a precompilation bug that would cause creating a sysimage with PackageCompiler.jl on Julia 1.6 to fail (#242).

v1.2.5 - 2024-05-28

Fixed

  • Fixed support for Julia 1.3 in the precompilation workload (#237).

v1.2.4 - 2024-05-27

Changed

  • Refactored the internals to use the public FileWatching.FDWatcher instead of FileWatching._FDWatcher (#215).

Fixed

  • Docstrings to inner constructors are now assigned properly (#227).
  • Socket now holds a reference to its Context to prevent it from being garbage collected accidentally (#229).
  • Changed the precompilation workload to use any available port to avoid port conflicts (#234).

v1.2.3 - 2024-05-12

Added

  • Support for setting ZMQ_IMMEDIATE and ZMQ_CONFLATE on sockets (#209, #222).
  • Overloads for Message to allow deserializing them with MsgPack.jl (#214).
  • A precompilation workload to improve TTFX (#224).
+Changelog · ZMQ.jl
GitHub

Changelog

This documents notable changes in ZMQ.jl. The format is based on Keep a Changelog.

Unreleased

Added

Fixed

  • Fixed isfreed(), which would previously return the wrong values (#245).

v1.2.6 - 2024-06-13

Added

Fixed

  • Fixed a precompilation bug that would cause creating a sysimage with PackageCompiler.jl on Julia 1.6 to fail (#242).

v1.2.5 - 2024-05-28

Fixed

  • Fixed support for Julia 1.3 in the precompilation workload (#237).

v1.2.4 - 2024-05-27

Changed

  • Refactored the internals to use the public FileWatching.FDWatcher instead of FileWatching._FDWatcher (#215).

Fixed

  • Docstrings to inner constructors are now assigned properly (#227).
  • Socket now holds a reference to its Context to prevent it from being garbage collected accidentally (#229).
  • Changed the precompilation workload to use any available port to avoid port conflicts (#234).

v1.2.3 - 2024-05-12

Added

  • Support for setting ZMQ_IMMEDIATE and ZMQ_CONFLATE on sockets (#209, #222).
  • Overloads for Message to allow deserializing them with MsgPack.jl (#214).
  • A precompilation workload to improve TTFX (#224).
diff --git a/dev/index.html b/dev/index.html index 2fe6112..27feebe 100644 --- a/dev/index.html +++ b/dev/index.html @@ -1,2 +1,2 @@ -Home · ZMQ.jl
GitHub
+Home · ZMQ.jl
GitHub
diff --git a/dev/man/examples/index.html b/dev/man/examples/index.html index 3e98779..1973a8f 100644 --- a/dev/man/examples/index.html +++ b/dev/man/examples/index.html @@ -1,2 +1,2 @@ -Examples · ZMQ.jl
GitHub
+Examples · ZMQ.jl
GitHub
diff --git a/dev/man/guide/index.html b/dev/man/guide/index.html index 2c788d3..435a8f6 100644 --- a/dev/man/guide/index.html +++ b/dev/man/guide/index.html @@ -1,5 +1,5 @@ -Guide · ZMQ.jl
GitHub

Guide

Usage

using ZMQ
+Guide · ZMQ.jl
GitHub
Guide
Usage
using ZMQ
 
 s1=Socket(REP)
 s2=Socket(REQ)
@@ -11,4 +11,4 @@
 msg = recv(s1, String)
 send(s1, "test response")
 close(s1)
-close(s2)
The send(socket, x) and recv(socket, SomeType) functions make an extra copy of the data when converting between ZMQ and Julia.   Alternatively, for large data sets (e.g. very large arrays or long strings), it can be preferable to share data, with send(socket, Message(x)) and msg = recv(Message), where the msg::Message object acts like an array of bytes; this involves some overhead so it may not be optimal for short messages.
(Help in writing more detailed documentation would be welcome!)

+close(s2)

The send(socket, x) and recv(socket, SomeType) functions make an extra copy of the data when converting between ZMQ and Julia. Alternatively, for large data sets (e.g. very large arrays or long strings), it can be preferable to share data, with send(socket, Message(x)) and msg = recv(Message), where the msg::Message object acts like an array of bytes; this involves some overhead so it may not be optimal for short messages.

(Help in writing more detailed documentation would be welcome!)

diff --git a/dev/objects.inv b/dev/objects.inv index b6cdfd5925902fab1c59c61d0ecaec9be1e59f04..2eff65212296e438b7045022f6c895ac5d38d9a1 100644 GIT binary patch delta 1624 zcmV-e2B-O&2fq!FdVgB&PUAQf{okjEG+Sv$nzqm{SpHEcGqZxB(}H%iD-^kjX)~m8 zCvi$)weP-;<0N(xH?~1Skh(ti`dr^HJ9vQ$_f~}6GZ#5l=h(8opbczoK+s#oo(uV} z^1+_5itw~ zt6qxzSZFyFmw#2Wsu5XLyMIcxwFl?z{uTKtbdnFeR`M~`OCB=KHI1b*xaZqqP?l*EAyfeoE&yna)2RV+%{nmu{xqNZC*M0cS>aG?|YhXD7eWoUnm$Rwv$CPa*~8E~G68+EQAz;Otpil4CwRyLtE7cy!-waBT|^)3)G zz#bo*lSQ~RO6zD1cv=LI2@wNp%2x;>Jn|Yrmv954B#I)1b&emTZc?|-aj{Mc$b^VH zyFktp#D9m?f6i;7EY1@b^S!0LgJI;M!20Q*J;s59ljn*!Ho5z{`DMSJj%@M`a$)B# zCRX|PJb3wJWxxJQ1Z^N*BiG`y(jf`$lL|c$l3|TE<$JvjA#f>eO(!V>Wo*b| z0_b3aZ4;2Sd&bY+L@V2XM+sJDvACaT2VDfQ?Im?=2Yl1~AQjb|C|GW0nnh*Y;ww{$ z4ZhKH0Y)3oA?_Y0 zJ8hG#jx~wNB^=_pf+kTZAeEw0G^MJJiUBLKsoRj+0bvN1KGaW^^#YnQW*V8mb@dfi zuxh#-Kw_?(N;LHGc%>cNpwM8)3RHQ=E`M+T`nI^6PtR|fGYZQ|$wd6Jg-RKh^w&nd zT!l-`<3*1lgf3IU7I`qa3J4;XVG5D6`^6Xa3>(pw*MKAsRI8$BTTbQ5l{AM+HO+J? zY6zX3ewcBnh5&Q$-VWe%ZLO5l5FU}2Om-gWvX(`?gDhoky|u`|LM5NwUtg;myniH; zbj@$7L^)o5eh6V0qEPqbz@uccS#;~!v<#|japGL+`5~IOs*s zo^{x=RULLSp-erA6ygIL%^poa$+ng>AW2$7TZ1D~1>2A#_+u&vv4$_zB8A}0S;yfH z+E4Ih3%t<4S8DK$4ig87ECXdcuzyjDp$-KNKjzb!dSc5ObN#laKuHq~Jqz>Rq1A+x z(Tz4uVkBC}*hSBQesqaQ8K*Uf^hD=?$`P7xT$20U6$}qHP7ASNVUYS>g_e55W2cC3 zK6zeF&#!gP#H2(8NF!Zv^J|j?yQVayE5Oyy+3dU*8CI|Ys&-a{m2{z{u7AL*GpzJ1 z1{L&>4C(n5`NsD{1y-FWtMbVo6l*5JI&7Jjc=1#b+;I1#vNdL>Jed%AWzo9zbG^v? zjqO2Xx;W9FigJ{%NKsT`noHsNDBx9&kk| z%~5ebQ@xSk^NR~G&~G6Mlz;rr-@Ku%U?mN$P>8Qs53f^+GmJFk!w_f&eS(mQTi}q8 z)smM&xNB^k7Lhhbl?LBtP)a)uFQBkLNl|f%^&}_!I zjr8A)aBxC$q~4f$!P_pQay*}e>1*Ev-fW0c308>IN(GihXL^3$#!KIGOnkEfmtVi0 We{DFzP>XmG+QNqai1;6h1BMIfrzy$+ delta 813 zcmV+|1JeAz4Vnj#dVf`GZ`v>v{hnW8sf)Bq3n>8t>o;iWW1=gCqE(x!DkLVP4Gv12 zs@1grJ}0qbn}$5vN)V*000 zY}vs^{}KD1b%`(xgRTDi>ZbMR>ml@^6%obQa`g;*$XNz*Sp`+~NL8vaNZHiRP&LlT zALk@rL{{=O<9{U!#!Qxkn|#uI#&?lF+Y~hpsK(9*GZ3-IO zhO&q(7s{1!Cm(zPnv#*oA?Xjy81Fxx?%`f%?lI5?Rni2!RlE@u2wSVj<;xFwCS~w2r928wd0{{z9 zX3`kUL-`;~t#=ZT19-uuF|2#{c3_dLjwp)&SQ5Eu#^P9)`X(RjX$e;_O4=)`QKxyo z*Cs`En!L^wz>>%}I}hw9h|B5E^M|Z#0QlbW;TeXJ7a;KHAFpC$<7E9NT@rkH{p;ua zb~YYfC4aGYfFf)mTpUY}C<(-`TUZ=)Hycl@Q)Ozk+n8Ly-!od_zXZ2|cpW%0Y8RpQ zM+~F(PdV{TZ4H!pjzbT*rMwb=5N8lhD<>R=q4nA*Uy9)Ayl53d=+JaDxHO@JAPFgk zr>wk?5t&6T+YcgG?HB3dlF{bEu*tnq2(L~`NPlO=H}H6%|$lSBwo#AQcYFa z-RvYHh@84UE+1t(t&JKsHWJ!;cD=Z*I&~%>g!Xf}fV5$kULBox@3_Z0&9|%eO~cvr r*(R^7aEJSP6t7lI$tg(i)bO%~#~0H&PhWc4UKDI$#e4c66wQlZHxiO^ diff --git a/dev/reference/index.html b/dev/reference/index.html index 955ae42..31a6a24 100644 --- a/dev/reference/index.html +++ b/dev/reference/index.html @@ -1,2 +1,2 @@ -Reference · ZMQ.jl
GitHub

Reference

Sockets

The ZMQ Socket type:

ZMQ.Socket — Method
Socket(ctx::Context, typ::Integer)

Create a socket in a given context.

source
ZMQ.Socket — Method
Socket(typ::Integer)

Create a socket of a certain type.

source

Socket implements the Sockets interface:

Base.bind — Function
Sockets.bind(socket::Socket, endpoint::AbstractString)

Bind the socket to an endpoint. Note that the endpoint must be formatted as described here. e.g. tcp://127.0.0.1:42000.

source
Sockets.connect — Function
Sockets.connect(socket::Socket, endpoint::AbstractString)

Connect the socket to an endpoint.

source
Sockets.recv — Function
recv(socket::Socket)

Return a Message object representing a message received from a ZMQ Socket (without making a copy of the message data).

source
recv(socket::Socket, ::Type{T})

Receive a message of type T (typically a String, Vector{UInt8}, or isbits type) from a ZMQ Socket. (Makes a copy of the message data; you can alternatively use recv(socket) to work with zero-copy bytearray-like representation for large messages.)

source
Sockets.send — Function
send(socket::Socket, data; more=false)

Send data over socket. A more=true keyword argument can be passed to indicate that data is a portion of a larger multipart message. data can be any isbits type, a Vector of isbits elements, a String, or a Message object to perform zero-copy sends of large arrays.

source
send(socket::Socket, zmsg::Message; more::Bool=false)

Zero-copy version of Sockets.send(socket, data) using a user-allocated Message.

source

ZMQ socket types (note: some of these are aliases; e.g. XREQ = DEALER):

Messages

ZMQ.Message — Type

High-level Message object for sending/receiving ZMQ messages in shared buffers.

source
ZMQ.Message — Method
Message(len::Integer)

Create a message with a given buffer size (for send).

source
ZMQ.Message — Method
Message(origin::Any, m::Ptr{T}, len::Integer) where {T}

Low-level function to create a message (for send) with an existing data buffer, without making a copy. The origin parameter should be the Julia object that is the origin of the data, so that we can hold a reference to it until ZMQ is done with the buffer.

source
ZMQ.Message — Method
Message(m::String)

Create a message with a string as a buffer (for send). Note: the Message now "owns" the string, it must not be resized, or even written to after the message is sent.

source
ZMQ.Message — Method
Message(p::SubString{String})

Create a message with a sub-string as a buffer (for send). Note: the same ownership semantics as for Message(m::String) apply.

source
ZMQ.Message — Method
Message(origin::Any, m::Ptr{T}, len::Integer) where {T}

Low-level function to create a message (for send) with an existing data buffer, without making a copy. The origin parameter should be the Julia object that is the origin of the data, so that we can hold a reference to it until ZMQ is done with the buffer.

source
ZMQ.isfreed — Method
isfreed(m::Message)

Check whether zeromq has called our free-function, i.e. whether we are safe to reclaim ownership of any buffer object the Message was created with.

source

Context

ZMQ.context — Function
context()

Return the default ZMQ context (of type Context), initializing it if this has not been done already. (This context is automatically closed when Julia exits.)

source
+Reference · ZMQ.jl
GitHub

Reference

Sockets

The ZMQ Socket type:

ZMQ.Socket — Method
Socket(ctx::Context, typ::Integer)

Create a socket in a given context.

source
ZMQ.Socket — Method
Socket(typ::Integer)

Create a socket of a certain type.

source

Socket implements the Sockets interface:

Base.bind — Function
Sockets.bind(socket::Socket, endpoint::AbstractString)

Bind the socket to an endpoint. Note that the endpoint must be formatted as described here. e.g. tcp://127.0.0.1:42000.

source
Sockets.connect — Function
Sockets.connect(socket::Socket, endpoint::AbstractString)

Connect the socket to an endpoint.

source
Sockets.recv — Function
recv(socket::Socket)

Return a Message object representing a message received from a ZMQ Socket (without making a copy of the message data).

source
recv(socket::Socket, ::Type{T})

Receive a message of type T (typically a String, Vector{UInt8}, or isbits type) from a ZMQ Socket. (Makes a copy of the message data; you can alternatively use recv(socket) to work with zero-copy bytearray-like representation for large messages.)

source
Sockets.send — Function
send(socket::Socket, data; more=false)

Send data over socket. A more=true keyword argument can be passed to indicate that data is a portion of a larger multipart message. data can be any isbits type, a Vector of isbits elements, a String, or a Message object to perform zero-copy sends of large arrays.

source
send(socket::Socket, zmsg::Message; more::Bool=false)

Zero-copy version of Sockets.send(socket, data) using a user-allocated Message.

source

ZMQ socket types (note: some of these are aliases; e.g. XREQ = DEALER):

Messages

ZMQ.Message — Type

High-level Message object for sending/receiving ZMQ messages in shared buffers.

source
ZMQ.Message — Method
Message(len::Integer)

Create a message with a given buffer size (for send).

source
ZMQ.Message — Method
Message(origin::Any, m::Ptr{T}, len::Integer) where {T}

Low-level function to create a message (for send) with an existing data buffer, without making a copy. The origin parameter should be the Julia object that is the origin of the data, so that we can hold a reference to it until ZMQ is done with the buffer.

source
ZMQ.Message — Method
Message(m::String)

Create a message with a string as a buffer (for send). Note: the Message now "owns" the string, it must not be resized, or even written to after the message is sent.

source
ZMQ.Message — Method
Message(p::SubString{String})

Create a message with a sub-string as a buffer (for send). Note: the same ownership semantics as for Message(m::String) apply.

source
ZMQ.Message — Method
Message(origin::Any, m::Ptr{T}, len::Integer) where {T}

Low-level function to create a message (for send) with an existing data buffer, without making a copy. The origin parameter should be the Julia object that is the origin of the data, so that we can hold a reference to it until ZMQ is done with the buffer.

source
ZMQ.isfreed — Method
isfreed(m::Message)

Check whether zeromq has called our free-function, i.e. whether we are safe to reclaim ownership of any buffer object the Message was created with.

source

Context

ZMQ.context — Function
context()

Return the default ZMQ context (of type Context), initializing it if this has not been done already. (This context is automatically closed when Julia exits.)

source
diff --git a/dev/search_index.js b/dev/search_index.js index 42f59f5..0148762 100644 --- a/dev/search_index.js +++ b/dev/search_index.js @@ -1,3 +1,3 @@ var documenterSearchIndex = {"docs": -[{"location":"_changelog/","page":"Changelog","title":"Changelog","text":"CurrentModule = ZMQ","category":"page"},{"location":"_changelog/#Changelog","page":"Changelog","title":"Changelog","text":"","category":"section"},{"location":"_changelog/","page":"Changelog","title":"Changelog","text":"This documents notable changes in ZMQ.jl. The format is based on Keep a Changelog.","category":"page"},{"location":"_changelog/#Unreleased","page":"Changelog","title":"Unreleased","text":"","category":"section"},{"location":"_changelog/#Added","page":"Changelog","title":"Added","text":"","category":"section"},{"location":"_changelog/","page":"Changelog","title":"Changelog","text":"Support for creating Message's from the new Memory type in Julia 1.11 ([#244]).","category":"page"},{"location":"_changelog/#Fixed","page":"Changelog","title":"Fixed","text":"","category":"section"},{"location":"_changelog/","page":"Changelog","title":"Changelog","text":"Fixed isfreed(), which would previously return the wrong values ([#245]).","category":"page"},{"location":"_changelog/#[v1.2.6]-2024-06-13","page":"Changelog","title":"[v1.2.6] - 2024-06-13","text":"","category":"section"},{"location":"_changelog/#Added-2","page":"Changelog","title":"Added","text":"","category":"section"},{"location":"_changelog/","page":"Changelog","title":"Changelog","text":"lib_version() to get the libzmq version ([#240]).","category":"page"},{"location":"_changelog/#Fixed-2","page":"Changelog","title":"Fixed","text":"","category":"section"},{"location":"_changelog/","page":"Changelog","title":"Changelog","text":"Fixed a precompilation bug that would cause creating a sysimage with PackageCompiler.jl on Julia 1.6 to fail ([#242]).","category":"page"},{"location":"_changelog/#[v1.2.5]-2024-05-28","page":"Changelog","title":"[v1.2.5] - 2024-05-28","text":"","category":"section"},{"location":"_changelog/#Fixed-3","page":"Changelog","title":"Fixed","text":"","category":"section"},{"location":"_changelog/","page":"Changelog","title":"Changelog","text":"Fixed support for Julia 1.3 in the precompilation workload ([#237]).","category":"page"},{"location":"_changelog/#[v1.2.4]-2024-05-27","page":"Changelog","title":"[v1.2.4] - 2024-05-27","text":"","category":"section"},{"location":"_changelog/#Changed","page":"Changelog","title":"Changed","text":"","category":"section"},{"location":"_changelog/","page":"Changelog","title":"Changelog","text":"Refactored the internals to use the public FileWatching.FDWatcher instead of FileWatching._FDWatcher ([#215]).","category":"page"},{"location":"_changelog/#Fixed-4","page":"Changelog","title":"Fixed","text":"","category":"section"},{"location":"_changelog/","page":"Changelog","title":"Changelog","text":"Docstrings to inner constructors are now assigned properly ([#227]).\nSocket now holds a reference to its Context to prevent it from being garbage collected accidentally ([#229]).\nChanged the precompilation workload to use any available port to avoid port conflicts ([#234]).","category":"page"},{"location":"_changelog/#[v1.2.3]-2024-05-12","page":"Changelog","title":"[v1.2.3] - 2024-05-12","text":"","category":"section"},{"location":"_changelog/#Added-3","page":"Changelog","title":"Added","text":"","category":"section"},{"location":"_changelog/","page":"Changelog","title":"Changelog","text":"Support for setting ZMQ_IMMEDIATE and ZMQ_CONFLATE on sockets ([#209], [#222]).\nOverloads for Message to allow deserializing them with MsgPack.jl ([#214]).\nA precompilation workload to improve TTFX ([#224]).","category":"page"},{"location":"changelog/","page":"Changelog","title":"Changelog","text":"EditURL = \"https://github.com/JuliaInterop/ZMQ.jl/blob/master/CHANGELOG.md\"","category":"page"},{"location":"changelog/","page":"Changelog","title":"Changelog","text":"CurrentModule = ZMQ","category":"page"},{"location":"changelog/#Changelog","page":"Changelog","title":"Changelog","text":"","category":"section"},{"location":"changelog/","page":"Changelog","title":"Changelog","text":"This documents notable changes in ZMQ.jl. The format is based on Keep a Changelog.","category":"page"},{"location":"changelog/#Unreleased","page":"Changelog","title":"Unreleased","text":"","category":"section"},{"location":"changelog/#Added","page":"Changelog","title":"Added","text":"","category":"section"},{"location":"changelog/","page":"Changelog","title":"Changelog","text":"Support for creating Message's from the new Memory type in Julia 1.11 (#244).","category":"page"},{"location":"changelog/#Fixed","page":"Changelog","title":"Fixed","text":"","category":"section"},{"location":"changelog/","page":"Changelog","title":"Changelog","text":"Fixed isfreed(), which would previously return the wrong values (#245).","category":"page"},{"location":"changelog/#[v1.2.6](https://github.com/JuliaInterop/ZMQ.jl/releases/tag/v1.2.6)-2024-06-13","page":"Changelog","title":"v1.2.6 - 2024-06-13","text":"","category":"section"},{"location":"changelog/#Added-2","page":"Changelog","title":"Added","text":"","category":"section"},{"location":"changelog/","page":"Changelog","title":"Changelog","text":"lib_version() to get the libzmq version (#240).","category":"page"},{"location":"changelog/#Fixed-2","page":"Changelog","title":"Fixed","text":"","category":"section"},{"location":"changelog/","page":"Changelog","title":"Changelog","text":"Fixed a precompilation bug that would cause creating a sysimage with PackageCompiler.jl on Julia 1.6 to fail (#242).","category":"page"},{"location":"changelog/#[v1.2.5](https://github.com/JuliaInterop/ZMQ.jl/releases/tag/v1.2.5)-2024-05-28","page":"Changelog","title":"v1.2.5 - 2024-05-28","text":"","category":"section"},{"location":"changelog/#Fixed-3","page":"Changelog","title":"Fixed","text":"","category":"section"},{"location":"changelog/","page":"Changelog","title":"Changelog","text":"Fixed support for Julia 1.3 in the precompilation workload (#237).","category":"page"},{"location":"changelog/#[v1.2.4](https://github.com/JuliaInterop/ZMQ.jl/releases/tag/v1.2.4)-2024-05-27","page":"Changelog","title":"v1.2.4 - 2024-05-27","text":"","category":"section"},{"location":"changelog/#Changed","page":"Changelog","title":"Changed","text":"","category":"section"},{"location":"changelog/","page":"Changelog","title":"Changelog","text":"Refactored the internals to use the public FileWatching.FDWatcher instead of FileWatching._FDWatcher (#215).","category":"page"},{"location":"changelog/#Fixed-4","page":"Changelog","title":"Fixed","text":"","category":"section"},{"location":"changelog/","page":"Changelog","title":"Changelog","text":"Docstrings to inner constructors are now assigned properly (#227).\nSocket now holds a reference to its Context to prevent it from being garbage collected accidentally (#229).\nChanged the precompilation workload to use any available port to avoid port conflicts (#234).","category":"page"},{"location":"changelog/#[v1.2.3](https://github.com/JuliaInterop/ZMQ.jl/releases/tag/v1.2.3)-2024-05-12","page":"Changelog","title":"v1.2.3 - 2024-05-12","text":"","category":"section"},{"location":"changelog/#Added-3","page":"Changelog","title":"Added","text":"","category":"section"},{"location":"changelog/","page":"Changelog","title":"Changelog","text":"Support for setting ZMQ_IMMEDIATE and ZMQ_CONFLATE on sockets (#209, #222).\nOverloads for Message to allow deserializing them with MsgPack.jl (#214).\nA precompilation workload to improve TTFX (#224).","category":"page"},{"location":"man/guide/#Guide","page":"Guide","title":"Guide","text":"","category":"section"},{"location":"man/guide/#Usage","page":"Guide","title":"Usage","text":"","category":"section"},{"location":"man/guide/","page":"Guide","title":"Guide","text":"using ZMQ\n\ns1=Socket(REP)\ns2=Socket(REQ)\n\nbind(s1, \"tcp://*:5555\")\nconnect(s2, \"tcp://localhost:5555\")\n\nsend(s2, \"test request\")\nmsg = recv(s1, String)\nsend(s1, \"test response\")\nclose(s1)\nclose(s2)","category":"page"},{"location":"man/guide/","page":"Guide","title":"Guide","text":"The send(socket, x) and recv(socket, SomeType) functions make an extra copy of the data when converting between ZMQ and Julia. Alternatively, for large data sets (e.g. very large arrays or long strings), it can be preferable to share data, with send(socket, Message(x)) and msg = recv(Message), where the msg::Message object acts like an array of bytes; this involves some overhead so it may not be optimal for short messages.","category":"page"},{"location":"man/guide/","page":"Guide","title":"Guide","text":"(Help in writing more detailed documentation would be welcome!)","category":"page"},{"location":"reference/","page":"Reference","title":"Reference","text":"CurrentModule = ZMQ","category":"page"},{"location":"reference/#Reference","page":"Reference","title":"Reference","text":"","category":"section"},{"location":"reference/","page":"Reference","title":"Reference","text":"lib_version","category":"page"},{"location":"reference/#ZMQ.lib_version","page":"Reference","title":"ZMQ.lib_version","text":"lib_version()\n\nGet the libzmq version number.\n\n\n\n\n\n","category":"function"},{"location":"reference/#Sockets","page":"Reference","title":"Sockets","text":"","category":"section"},{"location":"reference/","page":"Reference","title":"Reference","text":"The ZMQ Socket type:","category":"page"},{"location":"reference/","page":"Reference","title":"Reference","text":"Socket\nSocket(::Context, ::Integer)\nSocket(::Integer)\nSocket(::Function)\nisopen\nclose","category":"page"},{"location":"reference/#ZMQ.Socket","page":"Reference","title":"ZMQ.Socket","text":"A ZMQ socket.\n\n\n\n\n\n","category":"type"},{"location":"reference/#ZMQ.Socket-Tuple{Context, Integer}","page":"Reference","title":"ZMQ.Socket","text":"Socket(ctx::Context, typ::Integer)\n\nCreate a socket in a given context.\n\n\n\n\n\n","category":"method"},{"location":"reference/#ZMQ.Socket-Tuple{Integer}","page":"Reference","title":"ZMQ.Socket","text":"Socket(typ::Integer)\n\nCreate a socket of a certain type.\n\n\n\n\n\n","category":"method"},{"location":"reference/#ZMQ.Socket-Tuple{Function}","page":"Reference","title":"ZMQ.Socket","text":"Socket(f::Function, args...)\n\nDo-block constructor.\n\n\n\n\n\n","category":"method"},{"location":"reference/#Base.isopen","page":"Reference","title":"Base.isopen","text":"Base.isopen(socket::Socket)\n\n\n\n\n\n","category":"function"},{"location":"reference/#Base.close","page":"Reference","title":"Base.close","text":"Base.close(socket::Socket)\n\n\n\n\n\n","category":"function"},{"location":"reference/","page":"Reference","title":"Reference","text":"Socket implements the Sockets interface:","category":"page"},{"location":"reference/","page":"Reference","title":"Reference","text":"bind\nconnect\nrecv\nsend","category":"page"},{"location":"reference/#Base.bind","page":"Reference","title":"Base.bind","text":"Sockets.bind(socket::Socket, endpoint::AbstractString)\n\nBind the socket to an endpoint. Note that the endpoint must be formatted as described here. e.g. tcp://127.0.0.1:42000.\n\n\n\n\n\n","category":"function"},{"location":"reference/#Sockets.connect","page":"Reference","title":"Sockets.connect","text":"Sockets.connect(socket::Socket, endpoint::AbstractString)\n\nConnect the socket to an endpoint.\n\n\n\n\n\n","category":"function"},{"location":"reference/#Sockets.recv","page":"Reference","title":"Sockets.recv","text":"recv(socket::Socket)\n\nReturn a Message object representing a message received from a ZMQ Socket (without making a copy of the message data).\n\n\n\n\n\nrecv(socket::Socket, ::Type{T})\n\nReceive a message of type T (typically a String, Vector{UInt8}, or isbits type) from a ZMQ Socket. (Makes a copy of the message data; you can alternatively use recv(socket) to work with zero-copy bytearray-like representation for large messages.)\n\n\n\n\n\n","category":"function"},{"location":"reference/#Sockets.send","page":"Reference","title":"Sockets.send","text":"send(socket::Socket, data; more=false)\n\nSend data over socket. A more=true keyword argument can be passed to indicate that data is a portion of a larger multipart message. data can be any isbits type, a Vector of isbits elements, a String, or a Message object to perform zero-copy sends of large arrays.\n\n\n\n\n\nsend(socket::Socket, zmsg::Message; more::Bool=false)\n\nZero-copy version of Sockets.send(socket, data) using a user-allocated Message.\n\n\n\n\n\n","category":"function"},{"location":"reference/","page":"Reference","title":"Reference","text":"ZMQ socket types (note: some of these are aliases; e.g. XREQ = DEALER):","category":"page"},{"location":"reference/","page":"Reference","title":"Reference","text":"PAIR\nPUB\nSUB\nREQ\nREP\nDEALER\nROUTER\nPULL\nPUSH\nXPUB\nXSUB\nXREQ\nXREP\nUPSTREAM\nDOWNSTREAM","category":"page"},{"location":"reference/#ZMQ.PAIR","page":"Reference","title":"ZMQ.PAIR","text":"PAIR socket.\n\n\n\n\n\n","category":"constant"},{"location":"reference/#ZMQ.PUB","page":"Reference","title":"ZMQ.PUB","text":"PUB socket.\n\n\n\n\n\n","category":"constant"},{"location":"reference/#ZMQ.SUB","page":"Reference","title":"ZMQ.SUB","text":"SUB socket.\n\n\n\n\n\n","category":"constant"},{"location":"reference/#ZMQ.REQ","page":"Reference","title":"ZMQ.REQ","text":"REQ socket.\n\n\n\n\n\n","category":"constant"},{"location":"reference/#ZMQ.REP","page":"Reference","title":"ZMQ.REP","text":"REP socket.\n\n\n\n\n\n","category":"constant"},{"location":"reference/#ZMQ.DEALER","page":"Reference","title":"ZMQ.DEALER","text":"DEALER socket.\n\n\n\n\n\n","category":"constant"},{"location":"reference/#ZMQ.ROUTER","page":"Reference","title":"ZMQ.ROUTER","text":"ROUTER socket.\n\n\n\n\n\n","category":"constant"},{"location":"reference/#ZMQ.PULL","page":"Reference","title":"ZMQ.PULL","text":"PULL socket.\n\n\n\n\n\n","category":"constant"},{"location":"reference/#ZMQ.PUSH","page":"Reference","title":"ZMQ.PUSH","text":"PUSH socket.\n\n\n\n\n\n","category":"constant"},{"location":"reference/#ZMQ.XPUB","page":"Reference","title":"ZMQ.XPUB","text":"XPUB socket.\n\n\n\n\n\n","category":"constant"},{"location":"reference/#ZMQ.XSUB","page":"Reference","title":"ZMQ.XSUB","text":"XSUB socket.\n\n\n\n\n\n","category":"constant"},{"location":"reference/#ZMQ.XREQ","page":"Reference","title":"ZMQ.XREQ","text":"XREQ socket.\n\ncompat: Compat\nThis is a deprecated alias for ZMQ.DEALER.\n\n\n\n\n\n","category":"constant"},{"location":"reference/#ZMQ.XREP","page":"Reference","title":"ZMQ.XREP","text":"XREP socket.\n\ncompat: Compat\nThis is a deprecated alias for ZMQ.ROUTER.\n\n\n\n\n\n","category":"constant"},{"location":"reference/#ZMQ.UPSTREAM","page":"Reference","title":"ZMQ.UPSTREAM","text":"UPSTREAM socket.\n\ncompat: Compat\nThis is a deprecated alias for ZMQ.PULL.\n\n\n\n\n\n","category":"constant"},{"location":"reference/#ZMQ.DOWNSTREAM","page":"Reference","title":"ZMQ.DOWNSTREAM","text":"DOWNSTREAM socket.\n\ncompat: Compat\nThis is a deprecated alias for ZMQ.PUSH.\n\n\n\n\n\n","category":"constant"},{"location":"reference/#Messages","page":"Reference","title":"Messages","text":"","category":"section"},{"location":"reference/","page":"Reference","title":"Reference","text":"Message\nMessage()\nMessage(::Integer)\nMessage(::Any)\nMessage(::String)\nMessage(::SubString{String})\nMessage(::Array)\nMessage(::IOBuffer)\nisfreed(::Message)","category":"page"},{"location":"reference/#ZMQ.Message","page":"Reference","title":"ZMQ.Message","text":"High-level Message object for sending/receiving ZMQ messages in shared buffers.\n\n\n\n\n\n","category":"type"},{"location":"reference/#ZMQ.Message-Tuple{}","page":"Reference","title":"ZMQ.Message","text":"Message()\n\nCreate an empty message (for receive).\n\n\n\n\n\n","category":"method"},{"location":"reference/#ZMQ.Message-Tuple{Integer}","page":"Reference","title":"ZMQ.Message","text":"Message(len::Integer)\n\nCreate a message with a given buffer size (for send).\n\n\n\n\n\n","category":"method"},{"location":"reference/#ZMQ.Message-Tuple{Any}","page":"Reference","title":"ZMQ.Message","text":"Message(origin::Any, m::Ptr{T}, len::Integer) where {T}\n\nLow-level function to create a message (for send) with an existing data buffer, without making a copy. The origin parameter should be the Julia object that is the origin of the data, so that we can hold a reference to it until ZMQ is done with the buffer.\n\n\n\n\n\n","category":"method"},{"location":"reference/#ZMQ.Message-Tuple{String}","page":"Reference","title":"ZMQ.Message","text":"Message(m::String)\n\nCreate a message with a string as a buffer (for send). Note: the Message now \"owns\" the string, it must not be resized, or even written to after the message is sent.\n\n\n\n\n\n","category":"method"},{"location":"reference/#ZMQ.Message-Tuple{SubString{String}}","page":"Reference","title":"ZMQ.Message","text":"Message(p::SubString{String})\n\nCreate a message with a sub-string as a buffer (for send). Note: the same ownership semantics as for Message(m::String) apply.\n\n\n\n\n\n","category":"method"},{"location":"reference/#ZMQ.Message-Tuple{Array}","page":"Reference","title":"ZMQ.Message","text":"Message(origin::Any, m::Ptr{T}, len::Integer) where {T}\n\nLow-level function to create a message (for send) with an existing data buffer, without making a copy. The origin parameter should be the Julia object that is the origin of the data, so that we can hold a reference to it until ZMQ is done with the buffer.\n\n\n\n\n\n","category":"method"},{"location":"reference/#ZMQ.Message-Tuple{IOBuffer}","page":"Reference","title":"ZMQ.Message","text":"Message(io::IOBuffer)\n\nCreate a message with an IOBuffer as a buffer (for send). Note: the same ownership semantics as for Message(m::String) apply.\n\n\n\n\n\n","category":"method"},{"location":"reference/#ZMQ.isfreed-Tuple{Message}","page":"Reference","title":"ZMQ.isfreed","text":"isfreed(m::Message)\n\nCheck whether zeromq has called our free-function, i.e. whether we are safe to reclaim ownership of any buffer object the Message was created with.\n\n\n\n\n\n","category":"method"},{"location":"reference/#Context","page":"Reference","title":"Context","text":"","category":"section"},{"location":"reference/","page":"Reference","title":"Reference","text":"ZMQ.context","category":"page"},{"location":"reference/#ZMQ.context","page":"Reference","title":"ZMQ.context","text":"context()\n\nReturn the default ZMQ context (of type Context), initializing it if this has not been done already. (This context is automatically closed when Julia exits.)\n\n\n\n\n\n","category":"function"},{"location":"man/examples/#Examples","page":"Examples","title":"Examples","text":"","category":"section"},{"location":"man/examples/","page":"Examples","title":"Examples","text":"Examples using ZMQ.jl can be found in the ZeroMQ Guide (zguide) or directly in its repository","category":"page"},{"location":"#ZMQ.jl","page":"Home","title":"ZMQ.jl","text":"","category":"section"},{"location":"","page":"Home","title":"Home","text":"A Julia interface to ZeroMQ.","category":"page"},{"location":"","page":"Home","title":"Home","text":"ZMQ.jl is a Julia interface to ZeroMQ, The Intelligent Transport Layer.","category":"page"},{"location":"#Package-Features","page":"Home","title":"Package Features","text":"","category":"section"},{"location":"","page":"Home","title":"Home","text":"Access ZeroMQ sockets from Julia","category":"page"},{"location":"","page":"Home","title":"Home","text":"The Guide provides a tutorial explaining how to get started using ZMQ.jl.","category":"page"},{"location":"","page":"Home","title":"Home","text":"Some examples of packages using Documenter can be found on the Examples page.","category":"page"},{"location":"","page":"Home","title":"Home","text":"See the Reference for the complete list of documented functions and types.","category":"page"}] +[{"location":"_changelog/","page":"Changelog","title":"Changelog","text":"CurrentModule = ZMQ","category":"page"},{"location":"_changelog/#Changelog","page":"Changelog","title":"Changelog","text":"","category":"section"},{"location":"_changelog/","page":"Changelog","title":"Changelog","text":"This documents notable changes in ZMQ.jl. The format is based on Keep a Changelog.","category":"page"},{"location":"_changelog/#Unreleased","page":"Changelog","title":"Unreleased","text":"","category":"section"},{"location":"_changelog/#Added","page":"Changelog","title":"Added","text":"","category":"section"},{"location":"_changelog/","page":"Changelog","title":"Changelog","text":"Support for creating Message's from the new Memory type in Julia 1.11 ([#244]).\nFull Bindings to libzmq ([#232]).","category":"page"},{"location":"_changelog/#Fixed","page":"Changelog","title":"Fixed","text":"","category":"section"},{"location":"_changelog/","page":"Changelog","title":"Changelog","text":"Fixed isfreed(), which would previously return the wrong values ([#245]).","category":"page"},{"location":"_changelog/#[v1.2.6]-2024-06-13","page":"Changelog","title":"[v1.2.6] - 2024-06-13","text":"","category":"section"},{"location":"_changelog/#Added-2","page":"Changelog","title":"Added","text":"","category":"section"},{"location":"_changelog/","page":"Changelog","title":"Changelog","text":"lib_version() to get the libzmq version ([#240]).","category":"page"},{"location":"_changelog/#Fixed-2","page":"Changelog","title":"Fixed","text":"","category":"section"},{"location":"_changelog/","page":"Changelog","title":"Changelog","text":"Fixed a precompilation bug that would cause creating a sysimage with PackageCompiler.jl on Julia 1.6 to fail ([#242]).","category":"page"},{"location":"_changelog/#[v1.2.5]-2024-05-28","page":"Changelog","title":"[v1.2.5] - 2024-05-28","text":"","category":"section"},{"location":"_changelog/#Fixed-3","page":"Changelog","title":"Fixed","text":"","category":"section"},{"location":"_changelog/","page":"Changelog","title":"Changelog","text":"Fixed support for Julia 1.3 in the precompilation workload ([#237]).","category":"page"},{"location":"_changelog/#[v1.2.4]-2024-05-27","page":"Changelog","title":"[v1.2.4] - 2024-05-27","text":"","category":"section"},{"location":"_changelog/#Changed","page":"Changelog","title":"Changed","text":"","category":"section"},{"location":"_changelog/","page":"Changelog","title":"Changelog","text":"Refactored the internals to use the public FileWatching.FDWatcher instead of FileWatching._FDWatcher ([#215]).","category":"page"},{"location":"_changelog/#Fixed-4","page":"Changelog","title":"Fixed","text":"","category":"section"},{"location":"_changelog/","page":"Changelog","title":"Changelog","text":"Docstrings to inner constructors are now assigned properly ([#227]).\nSocket now holds a reference to its Context to prevent it from being garbage collected accidentally ([#229]).\nChanged the precompilation workload to use any available port to avoid port conflicts ([#234]).","category":"page"},{"location":"_changelog/#[v1.2.3]-2024-05-12","page":"Changelog","title":"[v1.2.3] - 2024-05-12","text":"","category":"section"},{"location":"_changelog/#Added-3","page":"Changelog","title":"Added","text":"","category":"section"},{"location":"_changelog/","page":"Changelog","title":"Changelog","text":"Support for setting ZMQ_IMMEDIATE and ZMQ_CONFLATE on sockets ([#209], [#222]).\nOverloads for Message to allow deserializing them with MsgPack.jl ([#214]).\nA precompilation workload to improve TTFX ([#224]).","category":"page"},{"location":"changelog/","page":"Changelog","title":"Changelog","text":"EditURL = \"https://github.com/JuliaInterop/ZMQ.jl/blob/master/CHANGELOG.md\"","category":"page"},{"location":"changelog/","page":"Changelog","title":"Changelog","text":"CurrentModule = ZMQ","category":"page"},{"location":"changelog/#Changelog","page":"Changelog","title":"Changelog","text":"","category":"section"},{"location":"changelog/","page":"Changelog","title":"Changelog","text":"This documents notable changes in ZMQ.jl. The format is based on Keep a Changelog.","category":"page"},{"location":"changelog/#Unreleased","page":"Changelog","title":"Unreleased","text":"","category":"section"},{"location":"changelog/#Added","page":"Changelog","title":"Added","text":"","category":"section"},{"location":"changelog/","page":"Changelog","title":"Changelog","text":"Support for creating Message's from the new Memory type in Julia 1.11 (#244).\nFull Bindings to libzmq (#232).","category":"page"},{"location":"changelog/#Fixed","page":"Changelog","title":"Fixed","text":"","category":"section"},{"location":"changelog/","page":"Changelog","title":"Changelog","text":"Fixed isfreed(), which would previously return the wrong values (#245).","category":"page"},{"location":"changelog/#[v1.2.6](https://github.com/JuliaInterop/ZMQ.jl/releases/tag/v1.2.6)-2024-06-13","page":"Changelog","title":"v1.2.6 - 2024-06-13","text":"","category":"section"},{"location":"changelog/#Added-2","page":"Changelog","title":"Added","text":"","category":"section"},{"location":"changelog/","page":"Changelog","title":"Changelog","text":"lib_version() to get the libzmq version (#240).","category":"page"},{"location":"changelog/#Fixed-2","page":"Changelog","title":"Fixed","text":"","category":"section"},{"location":"changelog/","page":"Changelog","title":"Changelog","text":"Fixed a precompilation bug that would cause creating a sysimage with PackageCompiler.jl on Julia 1.6 to fail (#242).","category":"page"},{"location":"changelog/#[v1.2.5](https://github.com/JuliaInterop/ZMQ.jl/releases/tag/v1.2.5)-2024-05-28","page":"Changelog","title":"v1.2.5 - 2024-05-28","text":"","category":"section"},{"location":"changelog/#Fixed-3","page":"Changelog","title":"Fixed","text":"","category":"section"},{"location":"changelog/","page":"Changelog","title":"Changelog","text":"Fixed support for Julia 1.3 in the precompilation workload (#237).","category":"page"},{"location":"changelog/#[v1.2.4](https://github.com/JuliaInterop/ZMQ.jl/releases/tag/v1.2.4)-2024-05-27","page":"Changelog","title":"v1.2.4 - 2024-05-27","text":"","category":"section"},{"location":"changelog/#Changed","page":"Changelog","title":"Changed","text":"","category":"section"},{"location":"changelog/","page":"Changelog","title":"Changelog","text":"Refactored the internals to use the public FileWatching.FDWatcher instead of FileWatching._FDWatcher (#215).","category":"page"},{"location":"changelog/#Fixed-4","page":"Changelog","title":"Fixed","text":"","category":"section"},{"location":"changelog/","page":"Changelog","title":"Changelog","text":"Docstrings to inner constructors are now assigned properly (#227).\nSocket now holds a reference to its Context to prevent it from being garbage collected accidentally (#229).\nChanged the precompilation workload to use any available port to avoid port conflicts (#234).","category":"page"},{"location":"changelog/#[v1.2.3](https://github.com/JuliaInterop/ZMQ.jl/releases/tag/v1.2.3)-2024-05-12","page":"Changelog","title":"v1.2.3 - 2024-05-12","text":"","category":"section"},{"location":"changelog/#Added-3","page":"Changelog","title":"Added","text":"","category":"section"},{"location":"changelog/","page":"Changelog","title":"Changelog","text":"Support for setting ZMQ_IMMEDIATE and ZMQ_CONFLATE on sockets (#209, #222).\nOverloads for Message to allow deserializing them with MsgPack.jl (#214).\nA precompilation workload to improve TTFX (#224).","category":"page"},{"location":"man/guide/#Guide","page":"Guide","title":"Guide","text":"","category":"section"},{"location":"man/guide/#Usage","page":"Guide","title":"Usage","text":"","category":"section"},{"location":"man/guide/","page":"Guide","title":"Guide","text":"using ZMQ\n\ns1=Socket(REP)\ns2=Socket(REQ)\n\nbind(s1, \"tcp://*:5555\")\nconnect(s2, \"tcp://localhost:5555\")\n\nsend(s2, \"test request\")\nmsg = recv(s1, String)\nsend(s1, \"test response\")\nclose(s1)\nclose(s2)","category":"page"},{"location":"man/guide/","page":"Guide","title":"Guide","text":"The send(socket, x) and recv(socket, SomeType) functions make an extra copy of the data when converting between ZMQ and Julia. Alternatively, for large data sets (e.g. very large arrays or long strings), it can be preferable to share data, with send(socket, Message(x)) and msg = recv(Message), where the msg::Message object acts like an array of bytes; this involves some overhead so it may not be optimal for short messages.","category":"page"},{"location":"man/guide/","page":"Guide","title":"Guide","text":"(Help in writing more detailed documentation would be welcome!)","category":"page"},{"location":"reference/","page":"Reference","title":"Reference","text":"CurrentModule = ZMQ","category":"page"},{"location":"reference/#Reference","page":"Reference","title":"Reference","text":"","category":"section"},{"location":"reference/","page":"Reference","title":"Reference","text":"lib_version","category":"page"},{"location":"reference/#ZMQ.lib_version","page":"Reference","title":"ZMQ.lib_version","text":"lib_version()\n\nGet the libzmq version number.\n\n\n\n\n\n","category":"function"},{"location":"reference/#Sockets","page":"Reference","title":"Sockets","text":"","category":"section"},{"location":"reference/","page":"Reference","title":"Reference","text":"The ZMQ Socket type:","category":"page"},{"location":"reference/","page":"Reference","title":"Reference","text":"Socket\nSocket(::Context, ::Integer)\nSocket(::Integer)\nSocket(::Function)\nisopen\nclose","category":"page"},{"location":"reference/#ZMQ.Socket","page":"Reference","title":"ZMQ.Socket","text":"A ZMQ socket.\n\n\n\n\n\n","category":"type"},{"location":"reference/#ZMQ.Socket-Tuple{Context, Integer}","page":"Reference","title":"ZMQ.Socket","text":"Socket(ctx::Context, typ::Integer)\n\nCreate a socket in a given context.\n\n\n\n\n\n","category":"method"},{"location":"reference/#ZMQ.Socket-Tuple{Integer}","page":"Reference","title":"ZMQ.Socket","text":"Socket(typ::Integer)\n\nCreate a socket of a certain type.\n\n\n\n\n\n","category":"method"},{"location":"reference/#ZMQ.Socket-Tuple{Function}","page":"Reference","title":"ZMQ.Socket","text":"Socket(f::Function, args...)\n\nDo-block constructor.\n\n\n\n\n\n","category":"method"},{"location":"reference/#Base.isopen","page":"Reference","title":"Base.isopen","text":"Base.isopen(socket::Socket)\n\n\n\n\n\n","category":"function"},{"location":"reference/#Base.close","page":"Reference","title":"Base.close","text":"Base.close(socket::Socket)\n\n\n\n\n\n","category":"function"},{"location":"reference/","page":"Reference","title":"Reference","text":"Socket implements the Sockets interface:","category":"page"},{"location":"reference/","page":"Reference","title":"Reference","text":"bind\nconnect\nrecv\nsend","category":"page"},{"location":"reference/#Base.bind","page":"Reference","title":"Base.bind","text":"Sockets.bind(socket::Socket, endpoint::AbstractString)\n\nBind the socket to an endpoint. Note that the endpoint must be formatted as described here. e.g. tcp://127.0.0.1:42000.\n\n\n\n\n\n","category":"function"},{"location":"reference/#Sockets.connect","page":"Reference","title":"Sockets.connect","text":"Sockets.connect(socket::Socket, endpoint::AbstractString)\n\nConnect the socket to an endpoint.\n\n\n\n\n\n","category":"function"},{"location":"reference/#Sockets.recv","page":"Reference","title":"Sockets.recv","text":"recv(socket::Socket)\n\nReturn a Message object representing a message received from a ZMQ Socket (without making a copy of the message data).\n\n\n\n\n\nrecv(socket::Socket, ::Type{T})\n\nReceive a message of type T (typically a String, Vector{UInt8}, or isbits type) from a ZMQ Socket. (Makes a copy of the message data; you can alternatively use recv(socket) to work with zero-copy bytearray-like representation for large messages.)\n\n\n\n\n\n","category":"function"},{"location":"reference/#Sockets.send","page":"Reference","title":"Sockets.send","text":"send(socket::Socket, data; more=false)\n\nSend data over socket. A more=true keyword argument can be passed to indicate that data is a portion of a larger multipart message. data can be any isbits type, a Vector of isbits elements, a String, or a Message object to perform zero-copy sends of large arrays.\n\n\n\n\n\nsend(socket::Socket, zmsg::Message; more::Bool=false)\n\nZero-copy version of Sockets.send(socket, data) using a user-allocated Message.\n\n\n\n\n\n","category":"function"},{"location":"reference/","page":"Reference","title":"Reference","text":"ZMQ socket types (note: some of these are aliases; e.g. XREQ = DEALER):","category":"page"},{"location":"reference/","page":"Reference","title":"Reference","text":"PAIR\nPUB\nSUB\nREQ\nREP\nDEALER\nROUTER\nPULL\nPUSH\nXPUB\nXSUB\nXREQ\nXREP\nUPSTREAM\nDOWNSTREAM","category":"page"},{"location":"reference/#ZMQ.PAIR","page":"Reference","title":"ZMQ.PAIR","text":"PAIR socket.\n\n\n\n\n\n","category":"constant"},{"location":"reference/#ZMQ.PUB","page":"Reference","title":"ZMQ.PUB","text":"PUB socket.\n\n\n\n\n\n","category":"constant"},{"location":"reference/#ZMQ.SUB","page":"Reference","title":"ZMQ.SUB","text":"SUB socket.\n\n\n\n\n\n","category":"constant"},{"location":"reference/#ZMQ.REQ","page":"Reference","title":"ZMQ.REQ","text":"REQ socket.\n\n\n\n\n\n","category":"constant"},{"location":"reference/#ZMQ.REP","page":"Reference","title":"ZMQ.REP","text":"REP socket.\n\n\n\n\n\n","category":"constant"},{"location":"reference/#ZMQ.DEALER","page":"Reference","title":"ZMQ.DEALER","text":"DEALER socket.\n\n\n\n\n\n","category":"constant"},{"location":"reference/#ZMQ.ROUTER","page":"Reference","title":"ZMQ.ROUTER","text":"ROUTER socket.\n\n\n\n\n\n","category":"constant"},{"location":"reference/#ZMQ.PULL","page":"Reference","title":"ZMQ.PULL","text":"PULL socket.\n\n\n\n\n\n","category":"constant"},{"location":"reference/#ZMQ.PUSH","page":"Reference","title":"ZMQ.PUSH","text":"PUSH socket.\n\n\n\n\n\n","category":"constant"},{"location":"reference/#ZMQ.XPUB","page":"Reference","title":"ZMQ.XPUB","text":"XPUB socket.\n\n\n\n\n\n","category":"constant"},{"location":"reference/#ZMQ.XSUB","page":"Reference","title":"ZMQ.XSUB","text":"XSUB socket.\n\n\n\n\n\n","category":"constant"},{"location":"reference/#ZMQ.XREQ","page":"Reference","title":"ZMQ.XREQ","text":"XREQ socket.\n\ncompat: Compat\nThis is a deprecated alias for ZMQ.DEALER.\n\n\n\n\n\n","category":"constant"},{"location":"reference/#ZMQ.XREP","page":"Reference","title":"ZMQ.XREP","text":"XREP socket.\n\ncompat: Compat\nThis is a deprecated alias for ZMQ.ROUTER.\n\n\n\n\n\n","category":"constant"},{"location":"reference/#ZMQ.UPSTREAM","page":"Reference","title":"ZMQ.UPSTREAM","text":"UPSTREAM socket.\n\ncompat: Compat\nThis is a deprecated alias for ZMQ.PULL.\n\n\n\n\n\n","category":"constant"},{"location":"reference/#ZMQ.DOWNSTREAM","page":"Reference","title":"ZMQ.DOWNSTREAM","text":"DOWNSTREAM socket.\n\ncompat: Compat\nThis is a deprecated alias for ZMQ.PUSH.\n\n\n\n\n\n","category":"constant"},{"location":"reference/#Messages","page":"Reference","title":"Messages","text":"","category":"section"},{"location":"reference/","page":"Reference","title":"Reference","text":"Message\nMessage()\nMessage(::Integer)\nMessage(::Any)\nMessage(::String)\nMessage(::SubString{String})\nMessage(::Array)\nMessage(::IOBuffer)\nisfreed(::Message)","category":"page"},{"location":"reference/#ZMQ.Message","page":"Reference","title":"ZMQ.Message","text":"High-level Message object for sending/receiving ZMQ messages in shared buffers.\n\n\n\n\n\n","category":"type"},{"location":"reference/#ZMQ.Message-Tuple{}","page":"Reference","title":"ZMQ.Message","text":"Message()\n\nCreate an empty message (for receive).\n\n\n\n\n\n","category":"method"},{"location":"reference/#ZMQ.Message-Tuple{Integer}","page":"Reference","title":"ZMQ.Message","text":"Message(len::Integer)\n\nCreate a message with a given buffer size (for send).\n\n\n\n\n\n","category":"method"},{"location":"reference/#ZMQ.Message-Tuple{Any}","page":"Reference","title":"ZMQ.Message","text":"Message(origin::Any, m::Ptr{T}, len::Integer) where {T}\n\nLow-level function to create a message (for send) with an existing data buffer, without making a copy. The origin parameter should be the Julia object that is the origin of the data, so that we can hold a reference to it until ZMQ is done with the buffer.\n\n\n\n\n\n","category":"method"},{"location":"reference/#ZMQ.Message-Tuple{String}","page":"Reference","title":"ZMQ.Message","text":"Message(m::String)\n\nCreate a message with a string as a buffer (for send). Note: the Message now \"owns\" the string, it must not be resized, or even written to after the message is sent.\n\n\n\n\n\n","category":"method"},{"location":"reference/#ZMQ.Message-Tuple{SubString{String}}","page":"Reference","title":"ZMQ.Message","text":"Message(p::SubString{String})\n\nCreate a message with a sub-string as a buffer (for send). Note: the same ownership semantics as for Message(m::String) apply.\n\n\n\n\n\n","category":"method"},{"location":"reference/#ZMQ.Message-Tuple{Array}","page":"Reference","title":"ZMQ.Message","text":"Message(origin::Any, m::Ptr{T}, len::Integer) where {T}\n\nLow-level function to create a message (for send) with an existing data buffer, without making a copy. The origin parameter should be the Julia object that is the origin of the data, so that we can hold a reference to it until ZMQ is done with the buffer.\n\n\n\n\n\n","category":"method"},{"location":"reference/#ZMQ.Message-Tuple{IOBuffer}","page":"Reference","title":"ZMQ.Message","text":"Message(io::IOBuffer)\n\nCreate a message with an IOBuffer as a buffer (for send). Note: the same ownership semantics as for Message(m::String) apply.\n\n\n\n\n\n","category":"method"},{"location":"reference/#ZMQ.isfreed-Tuple{Message}","page":"Reference","title":"ZMQ.isfreed","text":"isfreed(m::Message)\n\nCheck whether zeromq has called our free-function, i.e. whether we are safe to reclaim ownership of any buffer object the Message was created with.\n\n\n\n\n\n","category":"method"},{"location":"reference/#Context","page":"Reference","title":"Context","text":"","category":"section"},{"location":"reference/","page":"Reference","title":"Reference","text":"ZMQ.context","category":"page"},{"location":"reference/#ZMQ.context","page":"Reference","title":"ZMQ.context","text":"context()\n\nReturn the default ZMQ context (of type Context), initializing it if this has not been done already. (This context is automatically closed when Julia exits.)\n\n\n\n\n\n","category":"function"},{"location":"man/examples/#Examples","page":"Examples","title":"Examples","text":"","category":"section"},{"location":"man/examples/","page":"Examples","title":"Examples","text":"Examples using ZMQ.jl can be found in the ZeroMQ Guide (zguide) or directly in its repository","category":"page"},{"location":"#ZMQ.jl","page":"Home","title":"ZMQ.jl","text":"","category":"section"},{"location":"","page":"Home","title":"Home","text":"A Julia interface to ZeroMQ.","category":"page"},{"location":"","page":"Home","title":"Home","text":"ZMQ.jl is a Julia interface to ZeroMQ, The Intelligent Transport Layer.","category":"page"},{"location":"#Package-Features","page":"Home","title":"Package Features","text":"","category":"section"},{"location":"","page":"Home","title":"Home","text":"Access ZeroMQ sockets from Julia","category":"page"},{"location":"","page":"Home","title":"Home","text":"The Guide provides a tutorial explaining how to get started using ZMQ.jl.","category":"page"},{"location":"","page":"Home","title":"Home","text":"Some examples are linked on the Examples page.","category":"page"},{"location":"","page":"Home","title":"Home","text":"See the Reference for the complete list of wrapped functions and types.","category":"page"},{"location":"bindings/#Bindings","page":"Bindings","title":"Bindings","text":"","category":"section"},{"location":"bindings/","page":"Bindings","title":"Bindings","text":"This page documents the low-level bindings to libzmq that were automatically generated. Where possible, the docstrings link to the upstream documentation. Bindings have not been generated for deprecated functions.","category":"page"},{"location":"bindings/","page":"Bindings","title":"Bindings","text":"danger: Danger\nThese bindings are unsafe, do not use them unless you know what you're doing.","category":"page"},{"location":"bindings/","page":"Bindings","title":"Bindings","text":"","category":"page"},{"location":"bindings/","page":"Bindings","title":"Bindings","text":"Modules = [ZMQ.lib]","category":"page"},{"location":"bindings/#ZMQ.lib.zmq_atomic_counter_dec-Tuple{Any}","page":"Bindings","title":"ZMQ.lib.zmq_atomic_counter_dec","text":"zmq_atomic_counter_dec(counter_)\n\nUpstream documentation.\n\n\n\n\n\n","category":"method"},{"location":"bindings/#ZMQ.lib.zmq_atomic_counter_destroy-Tuple{Any}","page":"Bindings","title":"ZMQ.lib.zmq_atomic_counter_destroy","text":"zmq_atomic_counter_destroy(counter_p_)\n\nUpstream documentation.\n\n\n\n\n\n","category":"method"},{"location":"bindings/#ZMQ.lib.zmq_atomic_counter_inc-Tuple{Any}","page":"Bindings","title":"ZMQ.lib.zmq_atomic_counter_inc","text":"zmq_atomic_counter_inc(counter_)\n\nUpstream documentation.\n\n\n\n\n\n","category":"method"},{"location":"bindings/#ZMQ.lib.zmq_atomic_counter_new-Tuple{}","page":"Bindings","title":"ZMQ.lib.zmq_atomic_counter_new","text":"zmq_atomic_counter_new()\n\nUpstream documentation.\n\n\n\n\n\n","category":"method"},{"location":"bindings/#ZMQ.lib.zmq_atomic_counter_set-Tuple{Any, Any}","page":"Bindings","title":"ZMQ.lib.zmq_atomic_counter_set","text":"zmq_atomic_counter_set(counter_, value_)\n\nUpstream documentation.\n\n\n\n\n\n","category":"method"},{"location":"bindings/#ZMQ.lib.zmq_atomic_counter_value-Tuple{Any}","page":"Bindings","title":"ZMQ.lib.zmq_atomic_counter_value","text":"zmq_atomic_counter_value(counter_)\n\nUpstream documentation.\n\n\n\n\n\n","category":"method"},{"location":"bindings/#ZMQ.lib.zmq_bind-Tuple{Any, Any}","page":"Bindings","title":"ZMQ.lib.zmq_bind","text":"zmq_bind(s_, addr_)\n\nUpstream documentation.\n\n\n\n\n\n","category":"method"},{"location":"bindings/#ZMQ.lib.zmq_close-Tuple{Any}","page":"Bindings","title":"ZMQ.lib.zmq_close","text":"zmq_close(s_)\n\nUpstream documentation.\n\n\n\n\n\n","category":"method"},{"location":"bindings/#ZMQ.lib.zmq_connect-Tuple{Any, Any}","page":"Bindings","title":"ZMQ.lib.zmq_connect","text":"zmq_connect(s_, addr_)\n\nUpstream documentation.\n\n\n\n\n\n","category":"method"},{"location":"bindings/#ZMQ.lib.zmq_ctx_get-Tuple{Any, Any}","page":"Bindings","title":"ZMQ.lib.zmq_ctx_get","text":"zmq_ctx_get(context_, option_)\n\nUpstream documentation.\n\n\n\n\n\n","category":"method"},{"location":"bindings/#ZMQ.lib.zmq_ctx_new-Tuple{}","page":"Bindings","title":"ZMQ.lib.zmq_ctx_new","text":"zmq_ctx_new()\n\nUpstream documentation.\n\n\n\n\n\n","category":"method"},{"location":"bindings/#ZMQ.lib.zmq_ctx_set-Tuple{Any, Any, Any}","page":"Bindings","title":"ZMQ.lib.zmq_ctx_set","text":"zmq_ctx_set(context_, option_, optval_)\n\nUpstream documentation.\n\n\n\n\n\n","category":"method"},{"location":"bindings/#ZMQ.lib.zmq_ctx_shutdown-Tuple{Any}","page":"Bindings","title":"ZMQ.lib.zmq_ctx_shutdown","text":"zmq_ctx_shutdown(context_)\n\nUpstream documentation.\n\n\n\n\n\n","category":"method"},{"location":"bindings/#ZMQ.lib.zmq_ctx_term-Tuple{Any}","page":"Bindings","title":"ZMQ.lib.zmq_ctx_term","text":"zmq_ctx_term(context_)\n\nUpstream documentation.\n\n\n\n\n\n","category":"method"},{"location":"bindings/#ZMQ.lib.zmq_curve_keypair-Tuple{Any, Any}","page":"Bindings","title":"ZMQ.lib.zmq_curve_keypair","text":"zmq_curve_keypair(z85_public_key_, z85_secret_key_)\n\nUpstream documentation.\n\n\n\n\n\n","category":"method"},{"location":"bindings/#ZMQ.lib.zmq_curve_public-Tuple{Any, Any}","page":"Bindings","title":"ZMQ.lib.zmq_curve_public","text":"zmq_curve_public(z85_public_key_, z85_secret_key_)\n\nUpstream documentation.\n\n\n\n\n\n","category":"method"},{"location":"bindings/#ZMQ.lib.zmq_disconnect-Tuple{Any, Any}","page":"Bindings","title":"ZMQ.lib.zmq_disconnect","text":"zmq_disconnect(s_, addr_)\n\nUpstream documentation.\n\n\n\n\n\n","category":"method"},{"location":"bindings/#ZMQ.lib.zmq_errno-Tuple{}","page":"Bindings","title":"ZMQ.lib.zmq_errno","text":"zmq_errno()\n\nUpstream documentation.\n\n\n\n\n\n","category":"method"},{"location":"bindings/#ZMQ.lib.zmq_getsockopt-NTuple{4, Any}","page":"Bindings","title":"ZMQ.lib.zmq_getsockopt","text":"zmq_getsockopt(s_, option_, optval_, optvallen_)\n\nUpstream documentation.\n\n\n\n\n\n","category":"method"},{"location":"bindings/#ZMQ.lib.zmq_has-Tuple{Any}","page":"Bindings","title":"ZMQ.lib.zmq_has","text":"zmq_has(capability_)\n\nUpstream documentation.\n\n\n\n\n\n","category":"method"},{"location":"bindings/#ZMQ.lib.zmq_msg_close-Tuple{Any}","page":"Bindings","title":"ZMQ.lib.zmq_msg_close","text":"zmq_msg_close(msg_)\n\nUpstream documentation.\n\n\n\n\n\n","category":"method"},{"location":"bindings/#ZMQ.lib.zmq_msg_copy-Tuple{Any, Any}","page":"Bindings","title":"ZMQ.lib.zmq_msg_copy","text":"zmq_msg_copy(dest_, src_)\n\nUpstream documentation.\n\n\n\n\n\n","category":"method"},{"location":"bindings/#ZMQ.lib.zmq_msg_data-Tuple{Any}","page":"Bindings","title":"ZMQ.lib.zmq_msg_data","text":"zmq_msg_data(msg_)\n\nUpstream documentation.\n\n\n\n\n\n","category":"method"},{"location":"bindings/#ZMQ.lib.zmq_msg_get-Tuple{Any, Any}","page":"Bindings","title":"ZMQ.lib.zmq_msg_get","text":"zmq_msg_get(msg_, property_)\n\nUpstream documentation.\n\n\n\n\n\n","category":"method"},{"location":"bindings/#ZMQ.lib.zmq_msg_gets-Tuple{Any, Any}","page":"Bindings","title":"ZMQ.lib.zmq_msg_gets","text":"zmq_msg_gets(msg_, property_)\n\nUpstream documentation.\n\n\n\n\n\n","category":"method"},{"location":"bindings/#ZMQ.lib.zmq_msg_init-Tuple{Any}","page":"Bindings","title":"ZMQ.lib.zmq_msg_init","text":"zmq_msg_init(msg_)\n\nUpstream documentation.\n\n\n\n\n\n","category":"method"},{"location":"bindings/#ZMQ.lib.zmq_msg_init_data-NTuple{5, Any}","page":"Bindings","title":"ZMQ.lib.zmq_msg_init_data","text":"zmq_msg_init_data(msg_, data_, size_, ffn_, hint_)\n\nUpstream documentation.\n\n\n\n\n\n","category":"method"},{"location":"bindings/#ZMQ.lib.zmq_msg_init_size-Tuple{Any, Any}","page":"Bindings","title":"ZMQ.lib.zmq_msg_init_size","text":"zmq_msg_init_size(msg_, size_)\n\nUpstream documentation.\n\n\n\n\n\n","category":"method"},{"location":"bindings/#ZMQ.lib.zmq_msg_more-Tuple{Any}","page":"Bindings","title":"ZMQ.lib.zmq_msg_more","text":"zmq_msg_more(msg_)\n\nUpstream documentation.\n\n\n\n\n\n","category":"method"},{"location":"bindings/#ZMQ.lib.zmq_msg_move-Tuple{Any, Any}","page":"Bindings","title":"ZMQ.lib.zmq_msg_move","text":"zmq_msg_move(dest_, src_)\n\nUpstream documentation.\n\n\n\n\n\n","category":"method"},{"location":"bindings/#ZMQ.lib.zmq_msg_recv-Tuple{Any, Any, Any}","page":"Bindings","title":"ZMQ.lib.zmq_msg_recv","text":"zmq_msg_recv(msg_, s_, flags_)\n\nUpstream documentation.\n\n\n\n\n\n","category":"method"},{"location":"bindings/#ZMQ.lib.zmq_msg_send-Tuple{Any, Any, Any}","page":"Bindings","title":"ZMQ.lib.zmq_msg_send","text":"zmq_msg_send(msg_, s_, flags_)\n\nUpstream documentation.\n\n\n\n\n\n","category":"method"},{"location":"bindings/#ZMQ.lib.zmq_msg_set-Tuple{Any, Any, Any}","page":"Bindings","title":"ZMQ.lib.zmq_msg_set","text":"zmq_msg_set(msg_, property_, optval_)\n\nUpstream documentation.\n\n\n\n\n\n","category":"method"},{"location":"bindings/#ZMQ.lib.zmq_msg_size-Tuple{Any}","page":"Bindings","title":"ZMQ.lib.zmq_msg_size","text":"zmq_msg_size(msg_)\n\nUpstream documentation.\n\n\n\n\n\n","category":"method"},{"location":"bindings/#ZMQ.lib.zmq_poll-Tuple{Any, Any, Any}","page":"Bindings","title":"ZMQ.lib.zmq_poll","text":"zmq_poll(items_, nitems_, timeout_)\n\nUpstream documentation.\n\n\n\n\n\n","category":"method"},{"location":"bindings/#ZMQ.lib.zmq_proxy-Tuple{Any, Any, Any}","page":"Bindings","title":"ZMQ.lib.zmq_proxy","text":"zmq_proxy(frontend_, backend_, capture_)\n\nUpstream documentation.\n\n\n\n\n\n","category":"method"},{"location":"bindings/#ZMQ.lib.zmq_proxy_steerable-NTuple{4, Any}","page":"Bindings","title":"ZMQ.lib.zmq_proxy_steerable","text":"zmq_proxy_steerable(frontend_, backend_, capture_, control_)\n\nUpstream documentation.\n\n\n\n\n\n","category":"method"},{"location":"bindings/#ZMQ.lib.zmq_recv-NTuple{4, Any}","page":"Bindings","title":"ZMQ.lib.zmq_recv","text":"zmq_recv(s_, buf_, len_, flags_)\n\nUpstream documentation.\n\n\n\n\n\n","category":"method"},{"location":"bindings/#ZMQ.lib.zmq_send-NTuple{4, Any}","page":"Bindings","title":"ZMQ.lib.zmq_send","text":"zmq_send(s_, buf_, len_, flags_)\n\nUpstream documentation.\n\n\n\n\n\n","category":"method"},{"location":"bindings/#ZMQ.lib.zmq_send_const-NTuple{4, Any}","page":"Bindings","title":"ZMQ.lib.zmq_send_const","text":"zmq_send_const(s_, buf_, len_, flags_)\n\nUpstream documentation.\n\n\n\n\n\n","category":"method"},{"location":"bindings/#ZMQ.lib.zmq_setsockopt-NTuple{4, Any}","page":"Bindings","title":"ZMQ.lib.zmq_setsockopt","text":"zmq_setsockopt(s_, option_, optval_, optvallen_)\n\nUpstream documentation.\n\n\n\n\n\n","category":"method"},{"location":"bindings/#ZMQ.lib.zmq_sleep-Tuple{Any}","page":"Bindings","title":"ZMQ.lib.zmq_sleep","text":"zmq_sleep(seconds_)\n\nThis is an undocumented function, not part of the formal ZMQ API.\n\n\n\n\n\n","category":"method"},{"location":"bindings/#ZMQ.lib.zmq_socket-Tuple{Any, Any}","page":"Bindings","title":"ZMQ.lib.zmq_socket","text":"zmq_socket(arg1, type_)\n\nUpstream documentation.\n\n\n\n\n\n","category":"method"},{"location":"bindings/#ZMQ.lib.zmq_socket_monitor-Tuple{Any, Any, Any}","page":"Bindings","title":"ZMQ.lib.zmq_socket_monitor","text":"zmq_socket_monitor(s_, addr_, events_)\n\nUpstream documentation.\n\n\n\n\n\n","category":"method"},{"location":"bindings/#ZMQ.lib.zmq_stopwatch_intermediate-Tuple{Any}","page":"Bindings","title":"ZMQ.lib.zmq_stopwatch_intermediate","text":"zmq_stopwatch_intermediate(watch_)\n\nThis is an undocumented function, not part of the formal ZMQ API.\n\n\n\n\n\n","category":"method"},{"location":"bindings/#ZMQ.lib.zmq_stopwatch_start-Tuple{}","page":"Bindings","title":"ZMQ.lib.zmq_stopwatch_start","text":"zmq_stopwatch_start()\n\nThis is an undocumented function, not part of the formal ZMQ API.\n\n\n\n\n\n","category":"method"},{"location":"bindings/#ZMQ.lib.zmq_stopwatch_stop-Tuple{Any}","page":"Bindings","title":"ZMQ.lib.zmq_stopwatch_stop","text":"zmq_stopwatch_stop(watch_)\n\nThis is an undocumented function, not part of the formal ZMQ API.\n\n\n\n\n\n","category":"method"},{"location":"bindings/#ZMQ.lib.zmq_strerror-Tuple{Any}","page":"Bindings","title":"ZMQ.lib.zmq_strerror","text":"zmq_strerror(errnum_)\n\nUpstream documentation.\n\n\n\n\n\n","category":"method"},{"location":"bindings/#ZMQ.lib.zmq_threadclose-Tuple{Any}","page":"Bindings","title":"ZMQ.lib.zmq_threadclose","text":"zmq_threadclose(thread_)\n\nThis is an undocumented function, not part of the formal ZMQ API.\n\n\n\n\n\n","category":"method"},{"location":"bindings/#ZMQ.lib.zmq_threadstart-Tuple{Any, Any}","page":"Bindings","title":"ZMQ.lib.zmq_threadstart","text":"zmq_threadstart(func_, arg_)\n\nThis is an undocumented function, not part of the formal ZMQ API.\n\n\n\n\n\n","category":"method"},{"location":"bindings/#ZMQ.lib.zmq_timers_add-NTuple{4, Any}","page":"Bindings","title":"ZMQ.lib.zmq_timers_add","text":"zmq_timers_add(timers, interval, handler, arg)\n\nUpstream documentation.\n\n\n\n\n\n","category":"method"},{"location":"bindings/#ZMQ.lib.zmq_timers_cancel-Tuple{Any, Any}","page":"Bindings","title":"ZMQ.lib.zmq_timers_cancel","text":"zmq_timers_cancel(timers, timer_id)\n\nUpstream documentation.\n\n\n\n\n\n","category":"method"},{"location":"bindings/#ZMQ.lib.zmq_timers_destroy-Tuple{Any}","page":"Bindings","title":"ZMQ.lib.zmq_timers_destroy","text":"zmq_timers_destroy(timers_p)\n\nUpstream documentation.\n\n\n\n\n\n","category":"method"},{"location":"bindings/#ZMQ.lib.zmq_timers_execute-Tuple{Any}","page":"Bindings","title":"ZMQ.lib.zmq_timers_execute","text":"zmq_timers_execute(timers)\n\nUpstream documentation.\n\n\n\n\n\n","category":"method"},{"location":"bindings/#ZMQ.lib.zmq_timers_new-Tuple{}","page":"Bindings","title":"ZMQ.lib.zmq_timers_new","text":"zmq_timers_new()\n\nUpstream documentation.\n\n\n\n\n\n","category":"method"},{"location":"bindings/#ZMQ.lib.zmq_timers_reset-Tuple{Any, Any}","page":"Bindings","title":"ZMQ.lib.zmq_timers_reset","text":"zmq_timers_reset(timers, timer_id)\n\nUpstream documentation.\n\n\n\n\n\n","category":"method"},{"location":"bindings/#ZMQ.lib.zmq_timers_set_interval-Tuple{Any, Any, Any}","page":"Bindings","title":"ZMQ.lib.zmq_timers_set_interval","text":"zmq_timers_set_interval(timers, timer_id, interval)\n\nUpstream documentation.\n\n\n\n\n\n","category":"method"},{"location":"bindings/#ZMQ.lib.zmq_timers_timeout-Tuple{Any}","page":"Bindings","title":"ZMQ.lib.zmq_timers_timeout","text":"zmq_timers_timeout(timers)\n\nUpstream documentation.\n\n\n\n\n\n","category":"method"},{"location":"bindings/#ZMQ.lib.zmq_unbind-Tuple{Any, Any}","page":"Bindings","title":"ZMQ.lib.zmq_unbind","text":"zmq_unbind(s_, addr_)\n\nUpstream documentation.\n\n\n\n\n\n","category":"method"},{"location":"bindings/#ZMQ.lib.zmq_version-Tuple{Any, Any, Any}","page":"Bindings","title":"ZMQ.lib.zmq_version","text":"zmq_version(major_, minor_, patch_)\n\nUpstream documentation.\n\n\n\n\n\n","category":"method"},{"location":"bindings/#ZMQ.lib.zmq_z85_decode-Tuple{Any, Any}","page":"Bindings","title":"ZMQ.lib.zmq_z85_decode","text":"zmq_z85_decode(dest_, string_)\n\nUpstream documentation.\n\n\n\n\n\n","category":"method"},{"location":"bindings/#ZMQ.lib.zmq_z85_encode-Tuple{Any, Any, Any}","page":"Bindings","title":"ZMQ.lib.zmq_z85_encode","text":"zmq_z85_encode(dest_, data_, size_)\n\nUpstream documentation.\n\n\n\n\n\n","category":"method"}] }