Skip to content

Update mkdocs #1130

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 16, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/async-await.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion docs/poller.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
Empty file removed docs/scheduler.md
Empty file.
Empty file removed docs/stream.md
Empty file.
3 changes: 2 additions & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
site_name: NetMQ

pages:
nav:
- Home: index.md
- Introduction: introduction.md
- Concepts:
Expand All @@ -16,6 +16,7 @@ pages:
- Timer: timer.md
- Queue: queue.md
- Proactor: proactor.md
- Devices: devices.md
- Patterns:
- Request-Response: request-response.md
- Pub-Sub: pub-sub.md
Expand Down
Loading