From 14c3c12eaeb1f46e4cf36db3abfbf29527332c7a Mon Sep 17 00:00:00 2001 From: Alexandre Arpin Date: Wed, 27 Jul 2022 22:26:38 -0400 Subject: [PATCH] Update various documentation dead links and typos --- docs/async-await.md | 2 +- docs/devices.md | 10 ---------- docs/poller.md | 2 +- docs/scheduler.md | 0 docs/stream.md | 0 docs/transports.md | 2 +- 6 files changed, 3 insertions(+), 13 deletions(-) delete mode 100644 docs/devices.md delete mode 100644 docs/scheduler.md delete mode 100644 docs/stream.md diff --git a/docs/async-await.md b/docs/async-await.md index 719635012..4b7a46529 100644 --- a/docs/async-await.md +++ b/docs/async-await.md @@ -52,7 +52,7 @@ static void Main(string[] args) ``` NetMQRuntime is a wrapper over NetMQPoller, when calling an async function the socket is automatically added to the internal poller. -NetMQRuntime is also a NetMQScheduler and SyncrhonizationContext, so any awaited function is continuing on the runtime's thread. +NetMQRuntime is also a NetMQScheduler and SynchronizationContext, so any awaited function is continuing on the runtime's thread. NetMQSocket should still be used only within one thread. diff --git a/docs/devices.md b/docs/devices.md deleted file mode 100644 index a7775c380..000000000 --- a/docs/devices.md +++ /dev/null @@ -1,10 +0,0 @@ -Devices -=== - -See: - -* http://api.zeromq.org/2-1:zmq-device -* `IDevice` and `DeviceBase` -* `ForwarderDevice` -* `QueueDevice` -* `StreamerDevice` diff --git a/docs/poller.md b/docs/poller.md index c22b0ede4..18d7ed0d7 100644 --- a/docs/poller.md +++ b/docs/poller.md @@ -59,7 +59,7 @@ For ZeroMQ/NetMQ to give great performance, some restrictions exist on how we ca For example, consider socket A with a service loop in thread A, and socket B with a service loop in thread B. It would be invalid to receive a message from socket A (on thread A) and then attempt to send it on socket B. The socket is not threadsafe, and so attempts to use is simultaneously from threads A and B would cause errors. -In fact the pattern described here is known as a [proxy](proxy.md), and one is built into NetMQ. At this point you may not be surprised to learn that it is powered by a `NetMQPoller`. +In fact the pattern described here is known as a proxy, and one is built into NetMQ. At this point you may not be surprised to learn that it is powered by a `NetMQPoller`. ## Example: ReceiveReady diff --git a/docs/scheduler.md b/docs/scheduler.md deleted file mode 100644 index e69de29bb..000000000 diff --git a/docs/stream.md b/docs/stream.md deleted file mode 100644 index e69de29bb..000000000 diff --git a/docs/transports.md b/docs/transports.md index 5b33b7d45..6f9dc16f7 100644 --- a/docs/transports.md +++ b/docs/transports.md @@ -66,7 +66,7 @@ InProc (in-process) allows you to connect sockets running with the same process. + To do away with shared state/locks. When you send data down the wire (socket) there is no shared state to worry about. Each end of the socket will have its own copy. + Being able to communicate between very disparate parts of a system. -NetMQ comes with several components that use InProc, such the as [Actor model](actor.md) and [Devices](devices.md), which are discussed in their relevant documentation pages. +NetMQ comes with several components that use InProc, such the as [Actor model](actor.md) and[Devices, which are discussed in their relevant documentation pages. ### Example