summaryrefslogtreecommitdiff
path: root/docs/reference/src/proto/index.md
diff options
context:
space:
mode:
authorGarrett D'Amore <garrett@damore.org>2024-03-30 14:36:35 -0700
committerGarrett D'Amore <garrett@damore.org>2024-03-30 14:36:35 -0700
commitd38c90f0b429df3c13fb13f87481b73465d2eae5 (patch)
tree29b19caf79f82f9de3268333ceb8ffb3a45e973a /docs/reference/src/proto/index.md
parentf1a8d00adad337d7e7ef24b936a3f046f80370dd (diff)
downloadnng-d38c90f0b429df3c13fb13f87481b73465d2eae5.tar.gz
nng-d38c90f0b429df3c13fb13f87481b73465d2eae5.tar.bz2
nng-d38c90f0b429df3c13fb13f87481b73465d2eae5.zip
Reorganization in progress.
Diffstat (limited to 'docs/reference/src/proto/index.md')
-rw-r--r--docs/reference/src/proto/index.md27
1 files changed, 27 insertions, 0 deletions
diff --git a/docs/reference/src/proto/index.md b/docs/reference/src/proto/index.md
new file mode 100644
index 00000000..d131c78f
--- /dev/null
+++ b/docs/reference/src/proto/index.md
@@ -0,0 +1,27 @@
+# Protocols
+
+{{hi:protocol}}
+The Scalability Protocols are a principally a collection of common networking
+patterns found in applications.
+
+The following patterns are included:
+
+## Request/Reply
+
+The {{i:request/reply pattern}} is made up of the [_REQ_][req] and [_REP_][rep] protocols.
+This most often used when implementing RPC-like services, where
+a given request is matched by a single reply.
+
+## Pipeline
+
+The {{i:pipeline pattern}} is made up of the [_PUSH_][push] and [_PULL_][pull]
+protocols.
+
+In this pattern communication is {{i:half-duplex}}, in that one side sends
+data and another side receives.
+
+This pattern is also characterized by its ability to solve distribution
+problems, and the fact that it has {{i:back-pressure}}, providing a measure
+of {{i:flow control}} to data production and consumption.
+
+{{#include ../refs.md}}