diff --git a/dev/.documenter-siteinfo.json b/dev/.documenter-siteinfo.json index 276d683..80bda6a 100644 --- a/dev/.documenter-siteinfo.json +++ b/dev/.documenter-siteinfo.json @@ -1 +1 @@ -{"documenter":{"julia_version":"1.10.4","generation_timestamp":"2024-06-13T13:39:34","documenter_version":"1.4.1"}} \ No newline at end of file +{"documenter":{"julia_version":"1.10.4","generation_timestamp":"2024-06-17T12:56:55","documenter_version":"1.4.1"}} \ No newline at end of file diff --git a/dev/_changelog/index.html b/dev/_changelog/index.html index c65cb66..b99c689 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.

[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.

[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/changelog/index.html b/dev/changelog/index.html index c1ca040..027f646 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.

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.

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 992082b..c95f902 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 e50552b..12e3599 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 719b5d7..6f756a9 100644 --- a/dev/man/guide/index.html +++ b/dev/man/guide/index.html @@ -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/reference/index.html b/dev/reference/index.html index a429ba0..a879893 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

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

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