From e8d6c2bf692dbcb4c503caa676314a6a626a8a68 Mon Sep 17 00:00:00 2001 From: Garrett D'Amore Date: Mon, 14 Oct 2024 18:08:13 -0700 Subject: Converted protocols to mdbook. Started an introductory section too. --- docs/ref/proto/index.md | 42 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 42 insertions(+) create mode 100644 docs/ref/proto/index.md (limited to 'docs/ref/proto/index.md') diff --git a/docs/ref/proto/index.md b/docs/ref/proto/index.md new file mode 100644 index 00000000..e7a4619f --- /dev/null +++ b/docs/ref/proto/index.md @@ -0,0 +1,42 @@ +# 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. + +## Publish - Subscribe + +## Bus + +## Pair + +[bus]: bus.md +[pair]: pair.md +[push]: push.md +[pull]: pull.md +[req]: req.md +[rep]: rep.md +[sub]: sub.md +[pub]: pub.md +[respondent]: respondent.md +[surveyor]: surveyor.md -- cgit v1.2.3-70-g09d2