1549 lines
72 KiB
HTML
1549 lines
72 KiB
HTML
<!DOCTYPE html>
|
||
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head>
|
||
|
||
<meta charset="utf-8">
|
||
<meta name="generator" content="quarto-1.10.18">
|
||
|
||
<meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">
|
||
|
||
|
||
<title>9 Part IX — MQTT – Process Control</title>
|
||
<style>
|
||
/* Default styles provided by pandoc.
|
||
** See https://pandoc.org/MANUAL.html#variables-for-html for config info.
|
||
*/
|
||
span.smallcaps{font-variant: small-caps;}
|
||
div.columns{display: flex; gap: 1.5em;}
|
||
div.column{flex: auto;}
|
||
@media screen {
|
||
div.columns{gap: min(4vw, 1.5em);}
|
||
div.column{overflow-x: auto;}
|
||
}
|
||
div.hanging-indent{margin-left: 1.5em; text-indent: -1.5em;}
|
||
ul.task-list{list-style: none;}
|
||
ul.task-list li input[type="checkbox"] {
|
||
width: 0.8em;
|
||
margin: 0 0.8em 0.2em -1em; /* quarto-specific, see https://github.com/quarto-dev/quarto-cli/issues/4556 */
|
||
vertical-align: middle;
|
||
}
|
||
/* CSS for syntax highlighting */
|
||
html { -webkit-text-size-adjust: 100%; }
|
||
pre > code.sourceCode { white-space: pre; position: relative; }
|
||
pre > code.sourceCode > span { display: inline-block; line-height: 1.25; }
|
||
pre > code.sourceCode > span:empty { height: 1.2em; }
|
||
.sourceCode { overflow: visible; }
|
||
code.sourceCode > span { color: inherit; text-decoration: inherit; }
|
||
div.sourceCode { margin: 1em 0; }
|
||
pre.sourceCode { margin: 0; }
|
||
@media screen {
|
||
div.sourceCode { overflow: auto; }
|
||
}
|
||
@media print {
|
||
pre > code.sourceCode { white-space: pre-wrap; }
|
||
pre > code.sourceCode > span { text-indent: -5em; padding-left: 5em; }
|
||
}
|
||
pre.numberSource code
|
||
{ counter-reset: source-line 0; }
|
||
pre.numberSource code > span
|
||
{ position: relative; left: -4em; counter-increment: source-line; }
|
||
pre.numberSource code > span > a:first-child::before
|
||
{ content: counter(source-line);
|
||
position: relative; left: -1em; text-align: right; vertical-align: baseline;
|
||
border: none; display: inline-block;
|
||
-webkit-touch-callout: none; -webkit-user-select: none;
|
||
-khtml-user-select: none; -moz-user-select: none;
|
||
-ms-user-select: none; user-select: none;
|
||
padding: 0 4px; width: 4em;
|
||
}
|
||
pre.numberSource { margin-left: 3em; padding-left: 4px; }
|
||
div.sourceCode
|
||
{ }
|
||
@media screen {
|
||
pre > code.sourceCode > span > a:first-child::before { text-decoration: underline; }
|
||
}
|
||
</style>
|
||
|
||
|
||
<script src="site_libs/quarto-nav/quarto-nav.js"></script>
|
||
<script src="site_libs/quarto-nav/headroom.min.js"></script>
|
||
<script src="site_libs/clipboard/clipboard.min.js"></script>
|
||
<script src="site_libs/quarto-search/autocomplete.umd.js"></script>
|
||
<script src="site_libs/quarto-search/fuse.min.js"></script>
|
||
<script src="site_libs/quarto-search/quarto-search.js"></script>
|
||
<meta name="quarto:offset" content="./">
|
||
<link href="./glossary.html" rel="next">
|
||
<link href="./07-part-vii-mediation.html" rel="prev">
|
||
<script src="site_libs/quarto-html/quarto.js" type="module"></script>
|
||
<script src="site_libs/quarto-html/tabsets/tabsets.js" type="module"></script>
|
||
<script src="site_libs/quarto-html/popper.min.js"></script>
|
||
<script src="site_libs/quarto-html/tippy.umd.min.js"></script>
|
||
<script src="site_libs/quarto-html/anchor.min.js"></script>
|
||
<link href="site_libs/quarto-html/tippy.css" rel="stylesheet">
|
||
<link href="site_libs/quarto-html/quarto-syntax-highlighting-210757d7e60e9c473d8941953b4a5eb7.css" rel="stylesheet" class="quarto-color-scheme" id="quarto-text-highlighting-styles">
|
||
<link href="site_libs/quarto-html/quarto-syntax-highlighting-dark-a3970363346c256deb16f4449f99893b.css" rel="stylesheet" class="quarto-color-scheme quarto-color-alternate" id="quarto-text-highlighting-styles">
|
||
<link href="site_libs/quarto-html/quarto-syntax-highlighting-210757d7e60e9c473d8941953b4a5eb7.css" rel="stylesheet" class="quarto-color-scheme-extra" id="quarto-text-highlighting-styles">
|
||
<script src="site_libs/bootstrap/bootstrap.min.js"></script>
|
||
<link href="site_libs/bootstrap/bootstrap-icons.css" rel="stylesheet">
|
||
<link href="site_libs/bootstrap/bootstrap-e333b860288efea83b591af437d45305.min.css" rel="stylesheet" append-hash="true" class="quarto-color-scheme" id="quarto-bootstrap" data-mode="light">
|
||
<link href="site_libs/bootstrap/bootstrap-dark-0fb591fb534e4de6e0a74f855bd29ac7.min.css" rel="stylesheet" append-hash="true" class="quarto-color-scheme quarto-color-alternate" id="quarto-bootstrap" data-mode="dark">
|
||
<link href="site_libs/bootstrap/bootstrap-e333b860288efea83b591af437d45305.min.css" rel="stylesheet" append-hash="true" class="quarto-color-scheme-extra" id="quarto-bootstrap" data-mode="light">
|
||
<script src="site_libs/quarto-contrib/calc-exo-2.10.0/exo.js"></script>
|
||
<link href="site_libs/quarto-contrib/calc-exo-2.10.0/exo.css" rel="stylesheet">
|
||
<script src="site_libs/quarto-contrib/calc-quiz-2.10.0/quiz.js"></script>
|
||
<link href="site_libs/quarto-contrib/calc-quiz-2.10.0/quiz.css" rel="stylesheet">
|
||
<link href="site_libs/quarto-contrib/calc-further-2.10.0/further.css" rel="stylesheet">
|
||
<link href="site_libs/quarto-contrib/calc-history-2.10.0/history.css" rel="stylesheet">
|
||
<link href="site_libs/quarto-contrib/calc-latex-tables-2.10.0/latex-tables.css" rel="stylesheet">
|
||
<script src="site_libs/quarto-contrib/calc-notes-2.10.0/calc-notes.js"></script>
|
||
<link href="site_libs/quarto-contrib/calc-notes-2.10.0/theme.css" rel="stylesheet">
|
||
<link href="site_libs/quarto-contrib/calc-notes-2.10.0/high-contrast.css" rel="stylesheet">
|
||
<link href="site_libs/quarto-contrib/calc-notes-2.10.0/calc-notes.css" rel="stylesheet">
|
||
<link href="site_libs/quarto-contrib/calc-notes-2.10.0/narrow.css" rel="stylesheet">
|
||
<script src="site_libs/quarto-contrib/calc-glossary-2.10.0/glossary.js"></script>
|
||
<link href="site_libs/quarto-contrib/calc-glossary-2.10.0/glossary.css" rel="stylesheet">
|
||
<script id="quarto-search-options" type="application/json">{
|
||
"location": "sidebar",
|
||
"copy-button": false,
|
||
"collapse-after": 3,
|
||
"panel-placement": "start",
|
||
"type": "textbox",
|
||
"limit": 50,
|
||
"keyboard-shortcut": [
|
||
"f",
|
||
"/",
|
||
"s"
|
||
],
|
||
"show-item-context": false,
|
||
"language": {
|
||
"search-no-results-text": "No results",
|
||
"search-matching-documents-text": "matching documents",
|
||
"search-copy-link-title": "Copy link to search",
|
||
"search-hide-matches-text": "Hide additional matches",
|
||
"search-more-match-text": "more match in this document",
|
||
"search-more-matches-text": "more matches in this document",
|
||
"search-clear-button-title": "Clear",
|
||
"search-text-placeholder": "",
|
||
"search-detached-cancel-button-title": "Cancel",
|
||
"search-submit-button-title": "Submit",
|
||
"search-label": "Search"
|
||
}
|
||
}</script>
|
||
<style>html{ scroll-behavior: smooth; }</style>
|
||
<!-- Language switcher for the html output only (included in the <head>).
|
||
|
||
Each profile's sidebar translate menu links to the start page of the other
|
||
languages (_book/ English, _book/fr/, _book/de/). All three books share the
|
||
same file names and section ids (#sec-...), so a click is sent to the same
|
||
page and section of the other language instead.
|
||
|
||
Quarto's page scripts rewrite those links in the browser (to an absolute
|
||
address without index.html), and can do so after this script runs. So
|
||
nothing is attached to the links themselves: one capture-phase listener on
|
||
the document reads the link's final address at click time.
|
||
|
||
If a language has not been built, its pages do not exist:
|
||
the target is checked first and a short note is shown instead of a
|
||
"Not Found" page.
|
||
|
||
The language picked in the menu is remembered for a year in a cookie
|
||
(notes-lang, limited to the book's address). A later visit to a page in
|
||
another language goes straight to the same page in the remembered one; this
|
||
runs in the <head>, before anything is drawn. Not in the local preview
|
||
(file:, localhost), where the other languages may not be built. -->
|
||
|
||
<script>
|
||
(function () {
|
||
var CODE = { 'Deutsch': 'de', 'Français': 'fr', 'English': 'en' };
|
||
var ROOT_LANG = 'en'; // the language at the top of _book/
|
||
var COOKIE = 'notes-lang';
|
||
var NOTE = {
|
||
de: 'Diese Sprache ist hier noch nicht verfügbar.',
|
||
fr: 'Cette langue n’est pas encore disponible ici.',
|
||
en: 'This language is not available here yet.'
|
||
};
|
||
|
||
var here = (document.documentElement.lang || ROOT_LANG).slice(0, 2);
|
||
// the book's top folder: /…/fr/page.html -> /…/ ; /…/page.html -> /…/
|
||
var dir = location.pathname.replace(/[^\/]*$/, '');
|
||
var root = (here !== ROOT_LANG && dir.slice(-(here.length + 2)) === '/' + here + '/')
|
||
? dir.slice(0, -(here.length + 1)) : dir;
|
||
var page = location.pathname.slice(dir.length); // "" for a folder
|
||
|
||
function remembered() {
|
||
var m = document.cookie.match(/(?:^|;\s*)notes-lang=(de|fr|en)(?:;|$)/);
|
||
return m ? m[1] : null;
|
||
}
|
||
// path '/' on purpose: every book of these notes is served from one host,
|
||
// each under its own folder, so a language picked in any of them is the
|
||
// language all of them open in. A book hosted on its own would be no worse
|
||
// off -- the cookie simply has nothing else to reach.
|
||
var COOKIE_PATH = '/';
|
||
function remember(code) {
|
||
document.cookie = COOKIE + '=' + code + '; path=' + COOKIE_PATH
|
||
+ '; max-age=31536000; SameSite=Lax'
|
||
+ (location.protocol === 'https:' ? '; Secure' : '');
|
||
// a copy written under the book's own path by an earlier version would be
|
||
// the more specific one and would shadow the shared cookie for good
|
||
if (root !== COOKIE_PATH) {
|
||
document.cookie = COOKIE + '=; path=' + root + '; max-age=0';
|
||
}
|
||
}
|
||
|
||
// a returning reader lands in the language picked last time
|
||
var live = /^https?:$/.test(location.protocol)
|
||
&& !/^(localhost|127\.0\.0\.1|\[::1\])$/.test(location.hostname);
|
||
var wanted = remembered();
|
||
if (live && wanted && wanted !== here) {
|
||
location.replace(root + (wanted === ROOT_LANG ? '' : wanted + '/') + page
|
||
+ location.search + location.hash);
|
||
return;
|
||
}
|
||
|
||
function note() {
|
||
var lang = (document.documentElement.lang || 'en').slice(0, 2);
|
||
var box = document.createElement('div');
|
||
box.setAttribute('role', 'status');
|
||
box.className = 'i18n-note';
|
||
box.textContent = NOTE[lang] || NOTE.en;
|
||
box.style.cssText = 'position:fixed;left:50%;bottom:1.25rem;transform:translateX(-50%);'
|
||
+ 'max-width:min(34rem,calc(100vw - 2rem));padding:.6rem .9rem;border-radius:6px;'
|
||
+ 'background:#1f2328;color:#fff;font-size:.85rem;line-height:1.4;z-index:2000;'
|
||
// a status message, so it keeps its own dark surface in either mode; the
|
||
// hairline is the page's rule colour, invisible on a light page and an
|
||
// edge against a dark one, where the shadow alone no longer separates it
|
||
+ 'border:1px solid var(--calc-line,#444);'
|
||
+ 'box-shadow:0 4px 16px var(--calc-shadow,rgba(0,0,0,.25))';
|
||
document.body.appendChild(box);
|
||
setTimeout(function () { box.remove(); }, 7000);
|
||
}
|
||
|
||
function exists(url) {
|
||
return fetch(url, { method: 'HEAD', cache: 'no-store' })
|
||
.then(function (r) { return r.status !== 404; }, function () { return true; });
|
||
}
|
||
|
||
document.addEventListener('click', function (ev) {
|
||
if (ev.button !== 0 || ev.metaKey || ev.ctrlKey || ev.shiftKey || ev.altKey) return;
|
||
var a = ev.target.closest && ev.target.closest('a.sidebar-tools-main-item');
|
||
if (!a || !a.href) return;
|
||
var code = CODE[a.textContent.trim()];
|
||
if (!code) return; // some other tool link
|
||
ev.preventDefault();
|
||
// the language being read already: just remember it
|
||
if (code === here) { remember(code); return; }
|
||
|
||
var link = new URL(a.href, location.href);
|
||
var target_root = link.pathname.replace(/index\.html$/, ''); // "/" or "/fr/"
|
||
if (target_root.slice(-1) !== '/') target_root += '/';
|
||
var target = link.origin + target_root + (page || 'index.html');
|
||
|
||
if (location.protocol === 'file:' || !window.fetch) {
|
||
remember(code);
|
||
location.href = target + location.hash;
|
||
return;
|
||
}
|
||
// same page in the other language, else its start page, else explain
|
||
exists(target).then(function (ok) {
|
||
if (ok) { remember(code); location.href = target + location.hash; return; }
|
||
return exists(link.origin + target_root).then(function (rootOk) {
|
||
if (rootOk) { remember(code); location.href = link.origin + target_root; }
|
||
else note();
|
||
});
|
||
});
|
||
}, true);
|
||
})();
|
||
</script>
|
||
<style>:root {
|
||
--calc-furthercolor-src: #6B3FA0;
|
||
--calc-furthercolor: var(--calc-furthercolor-src);
|
||
|
||
}</style>
|
||
<meta name="notes-field" content="cs">
|
||
<style>:root {
|
||
--calc-notecolor-src: #20666f;
|
||
--calc-notecolor: var(--calc-notecolor-src);
|
||
|
||
}</style>
|
||
<script>(function (e) {
|
||
var KEY = 'notes-contrast', forced = false;
|
||
var picked = null;
|
||
try { picked = localStorage.getItem(KEY); } catch (err) {}
|
||
var q = null;
|
||
try { q = window.matchMedia && window.matchMedia('(prefers-contrast: more)'); } catch (err) {}
|
||
if (picked === 'more' || (picked !== 'normal' && (forced || (q && q.matches)))) {
|
||
e.classList.add('hc');
|
||
}
|
||
if (q) {
|
||
var f = function () {
|
||
var p = null;
|
||
try { p = localStorage.getItem(KEY); } catch (err) {}
|
||
if (p === null) e.classList.toggle('hc', forced || q.matches);
|
||
};
|
||
if (q.addEventListener) q.addEventListener('change', f);
|
||
else if (q.addListener) q.addListener(f);
|
||
}
|
||
})(document.documentElement);</script>
|
||
|
||
|
||
</head>
|
||
|
||
<body class="nav-sidebar docked quarto-light"><script id="quarto-html-before-body" type="application/javascript">
|
||
const toggleBodyColorMode = (bsSheetEl) => {
|
||
const mode = bsSheetEl.getAttribute("data-mode");
|
||
const bodyEl = window.document.querySelector("body");
|
||
if (mode === "dark") {
|
||
bodyEl.classList.add("quarto-dark");
|
||
bodyEl.classList.remove("quarto-light");
|
||
} else {
|
||
bodyEl.classList.add("quarto-light");
|
||
bodyEl.classList.remove("quarto-dark");
|
||
}
|
||
}
|
||
const toggleBodyColorPrimary = () => {
|
||
const bsSheetEl = window.document.querySelector("link#quarto-bootstrap:not([rel=disabled-stylesheet])");
|
||
if (bsSheetEl) {
|
||
toggleBodyColorMode(bsSheetEl);
|
||
}
|
||
}
|
||
const setColorSchemeToggle = (alternate) => {
|
||
const toggles = window.document.querySelectorAll('.quarto-color-scheme-toggle');
|
||
for (let i=0; i < toggles.length; i++) {
|
||
const toggle = toggles[i];
|
||
if (toggle) {
|
||
if (alternate) {
|
||
toggle.classList.add("alternate");
|
||
} else {
|
||
toggle.classList.remove("alternate");
|
||
}
|
||
}
|
||
}
|
||
};
|
||
const toggleColorMode = (alternate) => {
|
||
// Switch the stylesheets
|
||
const primaryStylesheets = window.document.querySelectorAll('link.quarto-color-scheme:not(.quarto-color-alternate)');
|
||
const alternateStylesheets = window.document.querySelectorAll('link.quarto-color-scheme.quarto-color-alternate');
|
||
manageTransitions('#quarto-margin-sidebar .nav-link', false);
|
||
if (alternate) {
|
||
// note: dark is layered on light, we don't disable primary!
|
||
enableStylesheet(alternateStylesheets);
|
||
for (const sheetNode of alternateStylesheets) {
|
||
if (sheetNode.id === "quarto-bootstrap") {
|
||
toggleBodyColorMode(sheetNode);
|
||
}
|
||
}
|
||
} else {
|
||
disableStylesheet(alternateStylesheets);
|
||
enableStylesheet(primaryStylesheets)
|
||
toggleBodyColorPrimary();
|
||
}
|
||
manageTransitions('#quarto-margin-sidebar .nav-link', true);
|
||
// Switch the toggles
|
||
setColorSchemeToggle(alternate)
|
||
// Hack to workaround the fact that safari doesn't
|
||
// properly recolor the scrollbar when toggling (#1455)
|
||
if (navigator.userAgent.indexOf('Safari') > 0 && navigator.userAgent.indexOf('Chrome') == -1) {
|
||
manageTransitions("body", false);
|
||
window.scrollTo(0, 1);
|
||
setTimeout(() => {
|
||
window.scrollTo(0, 0);
|
||
manageTransitions("body", true);
|
||
}, 40);
|
||
}
|
||
}
|
||
const disableStylesheet = (stylesheets) => {
|
||
for (let i=0; i < stylesheets.length; i++) {
|
||
const stylesheet = stylesheets[i];
|
||
stylesheet.rel = 'disabled-stylesheet';
|
||
}
|
||
}
|
||
const enableStylesheet = (stylesheets) => {
|
||
for (let i=0; i < stylesheets.length; i++) {
|
||
const stylesheet = stylesheets[i];
|
||
if(stylesheet.rel !== 'stylesheet') { // for Chrome, which will still FOUC without this check
|
||
stylesheet.rel = 'stylesheet';
|
||
}
|
||
}
|
||
}
|
||
const manageTransitions = (selector, allowTransitions) => {
|
||
const els = window.document.querySelectorAll(selector);
|
||
for (let i=0; i < els.length; i++) {
|
||
const el = els[i];
|
||
if (allowTransitions) {
|
||
el.classList.remove('notransition');
|
||
} else {
|
||
el.classList.add('notransition');
|
||
}
|
||
}
|
||
}
|
||
const isFileUrl = () => {
|
||
return window.location.protocol === 'file:';
|
||
}
|
||
const hasAlternateSentinel = () => {
|
||
let styleSentinel = getColorSchemeSentinel();
|
||
if (styleSentinel !== null) {
|
||
return styleSentinel === "alternate";
|
||
} else {
|
||
return false;
|
||
}
|
||
}
|
||
const setStyleSentinel = (alternate) => {
|
||
const value = alternate ? "alternate" : "default";
|
||
if (!isFileUrl()) {
|
||
window.localStorage.setItem("quarto-color-scheme", value);
|
||
} else {
|
||
localAlternateSentinel = value;
|
||
}
|
||
}
|
||
const getColorSchemeSentinel = () => {
|
||
if (!isFileUrl()) {
|
||
const storageValue = window.localStorage.getItem("quarto-color-scheme");
|
||
return storageValue != null ? storageValue : localAlternateSentinel;
|
||
} else {
|
||
return localAlternateSentinel;
|
||
}
|
||
}
|
||
const toggleGiscusIfUsed = (isAlternate, darkModeDefault) => {
|
||
const baseTheme = document.querySelector('#giscus-base-theme')?.value ?? 'light';
|
||
const alternateTheme = document.querySelector('#giscus-alt-theme')?.value ?? 'dark';
|
||
let newTheme = '';
|
||
if(authorPrefersDark) {
|
||
newTheme = isAlternate ? baseTheme : alternateTheme;
|
||
} else {
|
||
newTheme = isAlternate ? alternateTheme : baseTheme;
|
||
}
|
||
const changeGiscusTheme = () => {
|
||
// From: https://github.com/giscus/giscus/issues/336
|
||
const sendMessage = (message) => {
|
||
const iframe = document.querySelector('iframe.giscus-frame');
|
||
if (!iframe) return;
|
||
iframe.contentWindow.postMessage({ giscus: message }, 'https://giscus.app');
|
||
}
|
||
sendMessage({
|
||
setConfig: {
|
||
theme: newTheme
|
||
}
|
||
});
|
||
}
|
||
const isGiscussLoaded = window.document.querySelector('iframe.giscus-frame') !== null;
|
||
if (isGiscussLoaded) {
|
||
changeGiscusTheme();
|
||
}
|
||
};
|
||
const authorPrefersDark = false;
|
||
const darkModeDefault = authorPrefersDark;
|
||
document.querySelector('link#quarto-text-highlighting-styles.quarto-color-scheme-extra').rel = 'disabled-stylesheet';
|
||
document.querySelector('link#quarto-bootstrap.quarto-color-scheme-extra').rel = 'disabled-stylesheet';
|
||
let localAlternateSentinel = darkModeDefault ? 'alternate' : 'default';
|
||
// Dark / light mode switch
|
||
window.quartoToggleColorScheme = () => {
|
||
// Read the current dark / light value
|
||
let toAlternate = !hasAlternateSentinel();
|
||
toggleColorMode(toAlternate);
|
||
setStyleSentinel(toAlternate);
|
||
toggleGiscusIfUsed(toAlternate, darkModeDefault);
|
||
window.dispatchEvent(new Event('resize'));
|
||
};
|
||
// Switch to dark mode if need be
|
||
if (hasAlternateSentinel()) {
|
||
toggleColorMode(true);
|
||
} else {
|
||
toggleColorMode(false);
|
||
}
|
||
</script>
|
||
|
||
<div id="quarto-search-results"></div>
|
||
<header id="quarto-header" class="headroom fixed-top">
|
||
<nav class="quarto-secondary-nav">
|
||
<div class="container-fluid d-flex">
|
||
<button type="button" class="quarto-btn-toggle btn" data-bs-toggle="collapse" role="button" data-bs-target=".quarto-sidebar-collapse-item" aria-controls="quarto-sidebar" aria-expanded="false" aria-label="Toggle sidebar navigation" onclick="if (window.quartoToggleHeadroom) { window.quartoToggleHeadroom(); }">
|
||
<i class="bi bi-layout-text-sidebar-reverse"></i>
|
||
</button>
|
||
<nav class="quarto-page-breadcrumbs" aria-label="breadcrumb"><ol class="breadcrumb"><li class="breadcrumb-item"><a href="./08-part-ix-mqtt.html"><span class="chapter-number">9</span> <span class="chapter-title">Part IX — MQTT</span></a></li></ol></nav>
|
||
<a class="flex-grow-1" role="navigation" data-bs-toggle="collapse" data-bs-target=".quarto-sidebar-collapse-item" aria-controls="quarto-sidebar" aria-expanded="false" aria-label="Toggle sidebar navigation" onclick="if (window.quartoToggleHeadroom) { window.quartoToggleHeadroom(); }">
|
||
</a>
|
||
<button type="button" class="btn quarto-search-button" aria-label="Search" onclick="window.quartoOpenSearch();">
|
||
<i class="bi bi-search"></i>
|
||
</button>
|
||
</div>
|
||
</nav>
|
||
</header>
|
||
<!-- content -->
|
||
<div id="quarto-content" class="quarto-container page-columns page-rows-contents page-layout-article">
|
||
<!-- sidebar -->
|
||
<nav id="quarto-sidebar" class="sidebar collapse collapse-horizontal quarto-sidebar-collapse-item sidebar-navigation docked overflow-auto">
|
||
<div class="pt-lg-2 mt-2 text-left sidebar-header">
|
||
<div class="sidebar-title mb-0 py-0">
|
||
<a href="./">Process Control</a>
|
||
<div class="sidebar-tools-main tools-wide">
|
||
<div class="dropdown">
|
||
<a href="" title="" id="quarto-navigation-tool-dropdown-0" class="quarto-navigation-tool dropdown-toggle px-1" data-bs-toggle="dropdown" aria-expanded="false" role="link" aria-label=""><i class="bi bi-translate"></i></a>
|
||
<ul class="dropdown-menu" aria-labelledby="quarto-navigation-tool-dropdown-0">
|
||
<li>
|
||
<a class="dropdown-item sidebar-tools-main-item" href="./index.html">
|
||
English
|
||
</a>
|
||
</li>
|
||
<li>
|
||
<a class="dropdown-item sidebar-tools-main-item" href="./fr/index.html">
|
||
Français
|
||
</a>
|
||
</li>
|
||
<li>
|
||
<a class="dropdown-item sidebar-tools-main-item" href="./de/index.html">
|
||
Deutsch
|
||
</a>
|
||
</li>
|
||
</ul>
|
||
</div>
|
||
<a href="./Process-Control.pdf" title="Download PDF" class="quarto-navigation-tool px-1" aria-label="Download PDF"><i class="bi bi-file-pdf"></i></a>
|
||
<a href="" class="quarto-color-scheme-toggle quarto-navigation-tool px-1" onclick="window.quartoToggleColorScheme(); return false;" title="Toggle dark mode"><i class="bi"></i></a>
|
||
<a href="" class="quarto-reader-toggle quarto-navigation-tool px-1" onclick="window.quartoToggleReader(); return false;" title="Toggle reader mode">
|
||
<div class="quarto-reader-toggle-btn">
|
||
<i class="bi"></i>
|
||
</div>
|
||
</a>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="mt-2 flex-shrink-0 align-items-center">
|
||
<div class="sidebar-search">
|
||
<div id="quarto-search" class="" title="Search"></div>
|
||
</div>
|
||
</div>
|
||
<div class="sidebar-menu-container">
|
||
<ul class="list-unstyled mt-1">
|
||
<li class="sidebar-item">
|
||
<div class="sidebar-item-container">
|
||
<a href="./index.html" class="sidebar-item-text sidebar-link">
|
||
<span class="menu-text">About these notes</span></a>
|
||
</div>
|
||
</li>
|
||
<li class="sidebar-item">
|
||
<div class="sidebar-item-container">
|
||
<a href="./00-orientation.html" class="sidebar-item-text sidebar-link">
|
||
<span class="menu-text"><span class="chapter-number">1</span> <span class="chapter-title">Step 0 — What this is about</span></span></a>
|
||
</div>
|
||
</li>
|
||
<li class="sidebar-item">
|
||
<div class="sidebar-item-container">
|
||
<a href="./01-part-i-calls.html" class="sidebar-item-text sidebar-link">
|
||
<span class="menu-text"><span class="chapter-number">2</span> <span class="chapter-title">Part I — Start with what you already know</span></span></a>
|
||
</div>
|
||
</li>
|
||
<li class="sidebar-item">
|
||
<div class="sidebar-item-container">
|
||
<a href="./02-part-ii-processes.html" class="sidebar-item-text sidebar-link">
|
||
<span class="menu-text"><span class="chapter-number">3</span> <span class="chapter-title">Part II — Cross the process boundary</span></span></a>
|
||
</div>
|
||
</li>
|
||
<li class="sidebar-item">
|
||
<div class="sidebar-item-container">
|
||
<a href="./03-part-iii-distributed.html" class="sidebar-item-text sidebar-link">
|
||
<span class="menu-text"><span class="chapter-number">4</span> <span class="chapter-title">Part III — Make it actually distributed</span></span></a>
|
||
</div>
|
||
</li>
|
||
<li class="sidebar-item">
|
||
<div class="sidebar-item-container">
|
||
<a href="./04-part-iv-rewind.html" class="sidebar-item-text sidebar-link">
|
||
<span class="menu-text"><span class="chapter-number">5</span> <span class="chapter-title">Part IV — Rewind</span></span></a>
|
||
</div>
|
||
</li>
|
||
<li class="sidebar-item">
|
||
<div class="sidebar-item-container">
|
||
<a href="./05-part-v-subscriptions.html" class="sidebar-item-text sidebar-link">
|
||
<span class="menu-text"><span class="chapter-number">6</span> <span class="chapter-title">Part V — Replay the dynamic idea across processes</span></span></a>
|
||
</div>
|
||
</li>
|
||
<li class="sidebar-item">
|
||
<div class="sidebar-item-container">
|
||
<a href="./06-part-vi-vocabulary.html" class="sidebar-item-text sidebar-link">
|
||
<span class="menu-text"><span class="chapter-number">7</span> <span class="chapter-title">Part VI — Replay it over Syncthing, and name the messages</span></span></a>
|
||
</div>
|
||
</li>
|
||
<li class="sidebar-item">
|
||
<div class="sidebar-item-container">
|
||
<a href="./07-part-vii-mediation.html" class="sidebar-item-text sidebar-link">
|
||
<span class="menu-text"><span class="chapter-number">8</span> <span class="chapter-title">Part VII — Now merge the two architectural ideas</span></span></a>
|
||
</div>
|
||
</li>
|
||
<li class="sidebar-item">
|
||
<div class="sidebar-item-container">
|
||
<a href="./08-part-ix-mqtt.html" class="sidebar-item-text sidebar-link active">
|
||
<span class="menu-text"><span class="chapter-number">9</span> <span class="chapter-title">Part IX — MQTT</span></span></a>
|
||
</div>
|
||
</li>
|
||
<li class="sidebar-item sidebar-item-section">
|
||
<div class="sidebar-item-container">
|
||
<a class="sidebar-item-text sidebar-link text-start collapsed" data-bs-toggle="collapse" data-bs-target="#quarto-sidebar-section-1" role="navigation" aria-expanded="false">
|
||
<span class="menu-text">Appendices</span></a>
|
||
<a class="sidebar-item-toggle text-start collapsed" data-bs-toggle="collapse" data-bs-target="#quarto-sidebar-section-1" role="navigation" aria-expanded="false" aria-label="Toggle section">
|
||
<i class="bi bi-chevron-right ms-2"></i>
|
||
</a>
|
||
</div>
|
||
<ul id="quarto-sidebar-section-1" class="collapse list-unstyled sidebar-section depth1 ">
|
||
<li class="sidebar-item">
|
||
<div class="sidebar-item-container">
|
||
<a href="./glossary.html" class="sidebar-item-text sidebar-link">
|
||
<span class="menu-text">Glossary</span></a>
|
||
</div>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</div>
|
||
</nav>
|
||
<div id="quarto-sidebar-glass" class="quarto-sidebar-collapse-item" data-bs-toggle="collapse" data-bs-target=".quarto-sidebar-collapse-item"></div>
|
||
<!-- margin-sidebar -->
|
||
<div id="quarto-margin-sidebar" class="sidebar margin-sidebar">
|
||
<nav id="TOC" role="doc-toc" class="toc-active">
|
||
<h2 id="toc-title">On this page</h2>
|
||
|
||
<ul>
|
||
<li><a href="#sec-filesystem-verdict" id="toc-sec-filesystem-verdict" class="nav-link active" data-scroll-target="#sec-filesystem-verdict"><span class="header-section-number">9.1</span> What the filesystem taught, and what it is not for</a></li>
|
||
<li><a href="#sec-mqtt-mapping" id="toc-sec-mqtt-mapping" class="nav-link" data-scroll-target="#sec-mqtt-mapping"><span class="header-section-number">9.2</span> MQTT should look familiar</a></li>
|
||
<li><a href="#sec-paho" id="toc-sec-paho" class="nav-link" data-scroll-target="#sec-paho"><span class="header-section-number">9.3</span> The library, the client id and the broker address</a></li>
|
||
<li><a href="#sec-structured-intent" id="toc-sec-structured-intent" class="nav-link" data-scroll-target="#sec-structured-intent"><span class="header-section-number">9.4</span> Structured Intent, and two object mappers</a></li>
|
||
<li><a href="#sec-duise" id="toc-sec-duise" class="nav-link" data-scroll-target="#sec-duise"><span class="header-section-number">9.5</span> DUISE, and rewiring a running system</a></li>
|
||
<li><a href="#sec-retained-and-will" id="toc-sec-retained-and-will" class="nav-link" data-scroll-target="#sec-retained-and-will"><span class="header-section-number">9.6</span> What a new subscriber learns, and what a dead one admits</a></li>
|
||
<li><a href="#sec-coupling-remains" id="toc-sec-coupling-remains" class="nav-link" data-scroll-target="#sec-coupling-remains"><span class="header-section-number">9.7</span> What survived the transport, and what coupling remains</a></li>
|
||
<li><a href="#sec-whole-journey" id="toc-sec-whole-journey" class="nav-link" data-scroll-target="#sec-whole-journey"><span class="header-section-number">9.8</span> The whole journey</a></li>
|
||
<li><a href="#sec-sentences" id="toc-sec-sentences" class="nav-link" data-scroll-target="#sec-sentences"><span class="header-section-number">9.9</span> The sentences to remember</a></li>
|
||
</ul>
|
||
</nav>
|
||
</div>
|
||
<!-- main -->
|
||
<main class="content" id="quarto-document-content">
|
||
|
||
|
||
<header id="title-block-header" class="quarto-title-block default">
|
||
<div class="quarto-title">
|
||
<h1 class="title"><span id="sec-part-ix" class="quarto-section-identifier"><span class="chapter-number">9</span> <span class="chapter-title">Part IX — MQTT</span></span></h1>
|
||
</div>
|
||
|
||
|
||
|
||
<div class="quarto-title-meta">
|
||
|
||
|
||
|
||
|
||
</div>
|
||
|
||
|
||
|
||
</header>
|
||
|
||
|
||
<!-- MULTILINGUAL: see the comment at the top of index.qmd.
|
||
Part VIII (step 53) is one step and opens this chapter rather than
|
||
standing alone. -->
|
||
<section id="sec-filesystem-verdict" class="level2" data-number="9.1">
|
||
<h2 data-number="9.1" class="anchored" data-anchor-id="sec-filesystem-verdict"><span class="header-section-number">9.1</span> What the filesystem taught, and what it is not for</h2>
|
||
<p>The filesystem taught publication boundaries, directories as addresses, observation, independent processes, independent languages, synchronisation latency, runtime wiring, State, Intent, Events, mediator costs, service ownership and transformer services. It was a good teacher and it is not an elegant message broker: by the end the architecture was clean and the transport was a pile of <code>.tmp</code> files, atomic moves, rescanning, shared paths and replication delay.</p>
|
||
<p>The conclusion is <strong>not</strong> “files bad, MQTT good”. The filesystem has an advantage MQTT cannot match — it routinely stores gigabytes or terabytes, while brokers and clients are built for small messages, and chunking a huge payload over MQTT means inventing a file-transfer protocol inside a message protocol. So:</p>
|
||
<blockquote class="blockquote">
|
||
<p>Use messages for coordination and events. Use an appropriate file or object store for large data. A message can carry the <strong>location, identity and metadata</strong> of that data instead of the terabytes themselves.</p>
|
||
</blockquote>
|
||
<p>A replicated filesystem also gives every machine a local copy, which is a genuine strength — though replication is not a backup: deletion and corruption replicate too, unless versioning preserves older copies.</p>
|
||
</section>
|
||
<section id="sec-mqtt-mapping" class="level2" data-number="9.2">
|
||
<h2 data-number="9.2" class="anchored" data-anchor-id="sec-mqtt-mapping"><span class="header-section-number">9.2</span> MQTT should look familiar</h2>
|
||
<table class="caption-top table">
|
||
<thead>
|
||
<tr class="header">
|
||
<th>filesystem / Syncthing</th>
|
||
<th>MQTT</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr class="odd">
|
||
<td>synchronised message-board root</td>
|
||
<td>broker / namespace</td>
|
||
</tr>
|
||
<tr class="even">
|
||
<td>directory path</td>
|
||
<td>topic</td>
|
||
</tr>
|
||
<tr class="odd">
|
||
<td><code>.msg</code> file</td>
|
||
<td>publication</td>
|
||
</tr>
|
||
<tr class="even">
|
||
<td>file contents</td>
|
||
<td>payload</td>
|
||
</tr>
|
||
<tr class="odd">
|
||
<td><code>WatchService</code></td>
|
||
<td>subscription</td>
|
||
</tr>
|
||
<tr class="even">
|
||
<td>dynamic directory</td>
|
||
<td>topic / filter</td>
|
||
</tr>
|
||
<tr class="odd">
|
||
<td>control directory</td>
|
||
<td><code>I</code></td>
|
||
</tr>
|
||
<tr class="even">
|
||
<td>state directory</td>
|
||
<td><code>S/…</code></td>
|
||
</tr>
|
||
<tr class="odd">
|
||
<td>event directory</td>
|
||
<td><code>E/…</code></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<p>The reaction the material is after: <em>“Oh. We already know this architecture.”</em> MQTT is a transport change, not an architectural claim.</p>
|
||
<p>Two things a directory could not do, both visible in a minute at the command line. A publication made <strong>before</strong> a subscriber exists never reaches it — the stranded-message problem for the third time, now with an answer the filesystem never had. And a filter like <code>test/#</code> matches <code>test/a</code> and <code>test/a/b/c</code> but not <code>testing/x</code>, because <code>#</code> works on <strong>levels</strong>, not string prefixes; <code>test/+</code> would match only one level down.</p>
|
||
<p>The deeper correction: <strong>a topic is not a container.</strong> There is no object called <code>test/a</code> on the broker. A topic is a routing key carried by each publication and matched against the filters of whoever is subscribed at that instant. Directories <em>hold</em> messages; topics <em>match</em> them. One subscription therefore covers topics that do not exist yet — where a message board needed a new directory and a new registration.</p>
|
||
</section>
|
||
<section id="sec-paho" class="level2" data-number="9.3">
|
||
<h2 data-number="9.3" class="anchored" data-anchor-id="sec-paho"><span class="header-section-number">9.3</span> The library, the client id and the broker address</h2>
|
||
<p>Java has no MQTT client in its standard library, so Paho arrives now — after the need, like the mediator in step 7 and Jackson in step 64. Four things are needed from it: connect, publish, subscribe, callback. Connecting is deliberately anticlimactic: <em>“Nothing architectural happened here. We merely attached our process to the transport.”</em></p>
|
||
<p>Two details of connecting carry weight:</p>
|
||
<ul>
|
||
<li><strong>the client id</strong> is not merely a uniqueness token. The broker recognises a returning client by it and keeps session state for it: subscriptions, messages queued at QoS > 0, and the association with its Last Will. A directory never knew who was watching, which is exactly why a restarted watcher’s backlog was never replayed.</li>
|
||
<li><strong>the broker address</strong> is deployment configuration: every runnable reads <code>System.getProperty("mqtt.broker", "tcp://localhost:1883")</code>. It is also the one piece of configuration that cannot arrive as Intent, because Intent travels <em>through</em> the broker. Topology can be published; the address of the thing that publishes it cannot.</li>
|
||
</ul>
|
||
<p>Subscribing costs one packet, and <strong>the broker keeps the subscription list</strong>. There is no standard way to ask it what another client subscribed to — which is why <code>S/subscriptions</code> exists: a component’s own declaration of its wiring, published so the architecture can know what the transport keeps private. Only its owner may publish it, by the one-writer rule, because only its owner knows what it accepted.</p>
|
||
</section>
|
||
<section id="sec-structured-intent" class="level2" data-number="9.4">
|
||
<h2 data-number="9.4" class="anchored" data-anchor-id="sec-structured-intent"><span class="header-section-number">9.4</span> Structured Intent, and two object mappers</h2>
|
||
<p><code>TOPIC some/path</code> has one field and one meaning. It cannot say which <em>kind</em> of Intent this is, carry a second parameter, nest, or be extended; and there is nothing for a receiver to validate against. Richer Intent wants structure:</p>
|
||
<div class="code-copy-outer-scaffold"><div class="sourceCode" id="cb1"><pre class="sourceCode yaml code-with-copy"><code class="sourceCode yaml"><span id="cb1-1"><a href="#cb1-1" aria-hidden="true" tabindex="-1"></a><span class="fu">subscribe</span><span class="kw">:</span></span>
|
||
<span id="cb1-2"><a href="#cb1-2" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">topic</span><span class="kw">:</span><span class="at"> Demo/ConsoleIn/U/alice/E/text</span></span></code></pre></div><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></div>
|
||
<p>Only then does a serialisation library have a clear job. <code>JsonTools</code> keeps <strong>two</strong> mappers, and the asymmetry is deliberate:</p>
|
||
<ul>
|
||
<li>reading uses a <strong>YAML</strong> factory with <code>FAIL_ON_UNKNOWN_PROPERTIES</code> off — JSON is a subset of YAML, so hand-typed Intent is accepted, and a newer configurator can send fields an older service ignores;</li>
|
||
<li>writing uses plain <strong>JSON</strong> with <code>INDENT_OUTPUT</code> on, so published payloads are strict and readable.</li>
|
||
</ul>
|
||
<p>Tolerant in, strict out. A single shared mapper would have to give up one of those.</p>
|
||
</section>
|
||
<section id="sec-duise" class="level2" data-number="9.5">
|
||
<h2 data-number="9.5" class="anchored" data-anchor-id="sec-duise"><span class="header-section-number">9.5</span> DUISE, and rewiring a running system</h2>
|
||
<p>The naming scheme finally gets its name: <strong>D</strong>escription (what contracts this service understands and publishes), <strong>U</strong>nit (which instance), <strong>I</strong>ntent (requested behaviour), <strong>S</strong>tatus (what is true now), <strong>E</strong>vent (what happened).</p>
|
||
<pre class="text"><code>Demo/ROT13/U/alice/{I, S/online, S/subscriptions/text, E/crypted}</code></pre>
|
||
<p><code>U/<unit></code> is what the filesystem never needed: each machine had its own replica of the same relative path, so instance identity was implicit. MQTT has one shared namespace, so a topic must say <em>which</em> copy. Hard-coding <code>U/alice</code> in a capability is therefore worse than hard-coding <code>consoleIn.outbox</code> ever was: it binds the build to one deployment. Configured by Intent, <strong>one build serves everyone</strong> — which is why <code>MqttConfigure</code> takes three unit names as arguments. The unit names <em>are</em> the topology.</p>
|
||
<p>Rewiring, observed on a running system: publish a new Intent naming a different source topic, and the service unsubscribes from the old one, subscribes to the new one, and republishes <code>S/subscriptions</code> to match. No restart, no edit. Send an invalid filter instead — <code>Demo/#/E/text</code>, where <code>#</code> is not the last level — and <code>MqttTools.isValidFilter</code> rejects it; the old subscription stands and the Status still tells the truth.</p>
|
||
<p>That rejection exposes a real gap, worth naming rather than hiding: it is logged locally only. The configurator cannot tell whether its Intent was applied or refused, and a monitor cannot distinguish “refused” from “not yet processed”. In this design a sender learns the outcome by reading Status and comparing it with what it asked for. Publishing refusals as an Event, or a last-error Status, would close that gap; neither is in the material, so it is a design decision to justify.</p>
|
||
</section>
|
||
<section id="sec-retained-and-will" class="level2" data-number="9.6">
|
||
<h2 data-number="9.6" class="anchored" data-anchor-id="sec-retained-and-will"><span class="header-section-number">9.6</span> What a new subscriber learns, and what a dead one admits</h2>
|
||
<p>Subscribing to <code>Demo/#</code> for three seconds, with nothing being published, returns this:</p>
|
||
<pre class="text"><code>Demo/ROT13/U/nitro5/S/online {"value":true}
|
||
Demo/ROT13/U/nitro5/S/subscriptions/text "Demo/ConsoleIn/U/nitro5/E/text"
|
||
Demo/ConsoleOut/U/nitro5/S/online {"value":true}
|
||
Demo/ConsoleOut/U/nitro5/S/subscriptions/text "Demo/ROT13/U/nitro5/E/crypted"</code></pre>
|
||
<p>A late arrival learns the entire current wiring of the system, instantly, without asking anyone and without any component knowing a monitor exists. That is retained <strong>Status</strong>. No Events arrive, because Events are published non-retained — “retained State, non-retained Events”. It is also the proper answer to the instinct of <em>asking</em> a service what it is doing: nobody asks; the service states it, once, and the broker keeps it for whoever turns up.</p>
|
||
<p>Retained Status alone would lie, though. Kill a service with <code>Ctrl+C</code> and its <code>S/online = true</code> stays on the broker forever. Hence the <strong>Last Will</strong>, registered at connect time:</p>
|
||
<div class="code-copy-outer-scaffold"><div class="sourceCode" id="cb4"><pre class="sourceCode java code-with-copy"><code class="sourceCode java"><span id="cb4-1"><a href="#cb4-1" aria-hidden="true" tabindex="-1"></a><span class="dt">var</span> will <span class="op">=</span> <span class="kw">new</span> <span class="fu">MqttMessage</span><span class="op">(</span><span class="st">"{</span><span class="sc">\"</span><span class="st">value</span><span class="sc">\"</span><span class="st">:false}"</span><span class="op">.</span><span class="fu">getBytes</span><span class="op">(</span>UTF_8<span class="op">),</span> <span class="dv">1</span><span class="op">,</span> <span class="kw">true</span><span class="op">,</span> <span class="kw">new</span> <span class="fu">MqttProperties</span><span class="op">());</span></span>
|
||
<span id="cb4-2"><a href="#cb4-2" aria-hidden="true" tabindex="-1"></a>options<span class="op">.</span><span class="fu">setWill</span><span class="op">(</span>lastWillTopic<span class="op">,</span> will<span class="op">);</span></span></code></pre></div><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></div>
|
||
<p>The will is <strong>retained</strong>, so when the broker publishes it on the client’s behalf it replaces the stale <code>true</code>. The component that fails is not the component that reports the failure — which is the only arrangement that can work. One caveat: a clean DISCONNECT does <strong>not</strong> trigger a will, so a well-behaved service publishes <code>online=false</code> itself on the way out, and the will covers the ugly deaths.</p>
|
||
</section>
|
||
<section id="sec-coupling-remains" class="level2" data-number="9.7">
|
||
<h2 data-number="9.7" class="anchored" data-anchor-id="sec-coupling-remains"><span class="header-section-number">9.7</span> What survived the transport, and what coupling remains</h2>
|
||
<p>The lower half of the filesystem→MQTT table is the point: <code>I</code>, <code>S</code>, <code>E</code>, egoistic services, runtime topology and “transformer if needed” are <strong>unchanged</strong>. The architecture survived the transport replacement, and that is the strongest available evidence that the architecture was never about the transport.</p>
|
||
<p>Loose coupling does not mean nothing knows anything. What remains, necessarily, is agreement on: message syntax, message semantics, topic contracts, Intent, ownership, the meaning of State and the meaning of Events. The goal is not to eliminate coupling but to <strong>eliminate unnecessary knowledge</strong>. Concretely, in this system each service must understand exactly one foreign Event contract — ROT13 understands ConsoleIn’s <code>E/text</code>, ConsoleOut understands ROT13’s <code>E/crypted</code> — plus the Intent schema it accepts on its own <code>I</code>. That list is the irreducible minimum.</p>
|
||
<p>Separately, the broker is a shared infrastructure dependency: everyone needs its address and nothing works without it. Real, but a different kind of thing from one component knowing another.</p>
|
||
<p>The step-78 checklist is the tool to keep. Twelve questions, of which these six carry the argument for this system:</p>
|
||
<table class="caption-top table">
|
||
<colgroup>
|
||
<col style="width: 50%">
|
||
<col style="width: 50%">
|
||
</colgroup>
|
||
<thead>
|
||
<tr class="header">
|
||
<th>question</th>
|
||
<th>answer here</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr class="odd">
|
||
<td>does a capability contain a hard-coded producer identity?</td>
|
||
<td>no — it arrives as Intent</td>
|
||
</tr>
|
||
<tr class="even">
|
||
<td>which foreign contracts must it understand?</td>
|
||
<td>one Event contract each, plus its own Intent schema</td>
|
||
</tr>
|
||
<tr class="odd">
|
||
<td>where is topology defined?</td>
|
||
<td>in the configurator, outside the data path</td>
|
||
</tr>
|
||
<tr class="even">
|
||
<td>can topology change without recompiling?</td>
|
||
<td>yes — demonstrated on a running system</td>
|
||
</tr>
|
||
<tr class="odd">
|
||
<td>could the transport be replaced?</td>
|
||
<td>yes — demonstrated, filesystem then MQTT</td>
|
||
</tr>
|
||
<tr class="even">
|
||
<td>does every mediator do something that needs mediation?</td>
|
||
<td>yes, vacuously: <code>TEXT → TEXT</code> needs none, and none exists</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<p>The material’s own caution applies: the answers need not all be “no”. They need to be <strong>intentional</strong>.</p>
|
||
</section>
|
||
<section id="sec-whole-journey" class="level2" data-number="9.8">
|
||
<h2 data-number="9.8" class="anchored" data-anchor-id="sec-whole-journey"><span class="header-section-number">9.8</span> The whole journey</h2>
|
||
<p>The program never changed: a line goes in, the same line comes out rotated by 13 letters. What changed, eleven times, is how the parts are joined and who holds the knowledge of how they are joined.</p>
|
||
<table class="caption-top table">
|
||
<colgroup>
|
||
<col style="width: 25%">
|
||
<col style="width: 25%">
|
||
<col style="width: 25%">
|
||
<col style="width: 25%">
|
||
</colgroup>
|
||
<thead>
|
||
<tr class="header">
|
||
<th>stage</th>
|
||
<th>how the parts are joined</th>
|
||
<th>where the topology lives</th>
|
||
<th>in the data path besides the capabilities</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr class="odd">
|
||
<td>1 procedural</td>
|
||
<td>direct calls</td>
|
||
<td>inside the capability code</td>
|
||
<td>—</td>
|
||
</tr>
|
||
<tr class="even">
|
||
<td>2 egoistic services</td>
|
||
<td>not joined at all</td>
|
||
<td>nowhere — that is the problem</td>
|
||
<td>—</td>
|
||
</tr>
|
||
<tr class="odd">
|
||
<td>3 static mediation, one JVM</td>
|
||
<td>mailboxes, copied by mediators</td>
|
||
<td>the mediators, started in <code>main()</code></td>
|
||
<td>two mediators</td>
|
||
</tr>
|
||
<tr class="even">
|
||
<td>4 static mediation, filesystem</td>
|
||
<td>directories, copied by mediator processes</td>
|
||
<td>the operator’s command lines</td>
|
||
<td>two mediator processes</td>
|
||
</tr>
|
||
<tr class="odd">
|
||
<td>5 static mediation, Syncthing</td>
|
||
<td>replicated directories</td>
|
||
<td>the operator’s command lines</td>
|
||
<td>two mediator processes, plus replication delay</td>
|
||
</tr>
|
||
<tr class="even">
|
||
<td>6 named, configurable mediators</td>
|
||
<td><code>ROUTE</code> Intent from an orchestrator</td>
|
||
<td>the orchestrator, outside the path</td>
|
||
<td>the mediators, still</td>
|
||
</tr>
|
||
<tr class="odd">
|
||
<td>7 dynamic, one JVM</td>
|
||
<td>services listen, told by <code>TOPIC</code> Intent</td>
|
||
<td>the configurator</td>
|
||
<td>nothing</td>
|
||
</tr>
|
||
<tr class="even">
|
||
<td>8 dynamic, filesystem</td>
|
||
<td>the same, over directories</td>
|
||
<td>the configurator</td>
|
||
<td>nothing</td>
|
||
</tr>
|
||
<tr class="odd">
|
||
<td>9 dynamic, Syncthing</td>
|
||
<td>the same, over replicated directories</td>
|
||
<td>the configurator</td>
|
||
<td>nothing — transport hops only</td>
|
||
</tr>
|
||
<tr class="even">
|
||
<td>10 contracts</td>
|
||
<td>compatible: direct; incompatible: a transformer</td>
|
||
<td>the configurator</td>
|
||
<td>a transformer, only where contracts differ</td>
|
||
</tr>
|
||
<tr class="odd">
|
||
<td>11 MQTT</td>
|
||
<td>topics on a broker</td>
|
||
<td>the configurator</td>
|
||
<td>nothing — the broker is transport</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<p>Read the third column from top to bottom: the topology moves outward, one stage at a time, until no capability holds any of it. Read the last one: the price of that move falls to zero at stage 7 and stays there while the transport changes underneath three times. Same architecture, better transport.</p>
|
||
</section>
|
||
<section id="sec-sentences" class="level2" data-number="9.9">
|
||
<h2 data-number="9.9" class="anchored" data-anchor-id="sec-sentences"><span class="header-section-number">9.9</span> The sentences to remember</h2>
|
||
<ul>
|
||
<li><strong>Event-driven describes how information and control flow.</strong></li>
|
||
<li><strong>Loose coupling describes how much participants need to know about one another.</strong></li>
|
||
<li><strong>Publish what happened.</strong></li>
|
||
<li><strong>Declare what you want.</strong></li>
|
||
<li><strong>Publish your own State.</strong></li>
|
||
<li><strong>Keep capabilities egoistic.</strong></li>
|
||
<li><strong>Keep topology out of capabilities.</strong></li>
|
||
<li><strong>Do not pay for a mediator unless it actually mediates something.</strong></li>
|
||
</ul>
|
||
<p>And whenever an architecture becomes confusing, go back to the first question of this book: <strong>who knows whom?</strong></p>
|
||
|
||
|
||
</section>
|
||
|
||
</main> <!-- /main -->
|
||
<!-- figures/flow-player.html -- the web version's interactive diagrams.
|
||
Injected at the end of <body> by include-in-header's sibling
|
||
include-after-body in _quarto.yml, so it is a no-op on a page that holds
|
||
no img.flow-figure.
|
||
|
||
A chapter writes an ordinary Quarto figure and adds the class:
|
||
|
||
{#fig-x .flow-figure}
|
||
|
||
That keeps the PDF and the no-JavaScript case working: the built svg is
|
||
already the whole picture. Here the image is fetched, inlined, and given
|
||
a play bar that walks a message through the mailboxes, one hop per
|
||
[data-flow] edge of the svg, highlighting the [data-flow-node] each hop
|
||
ends at. Colours are the extension's --calc-… tokens, the same ones
|
||
diagram.css uses, so the figure, the token and the bar stay in step in
|
||
light mode, in night mode and in high contrast. Nothing here keys off
|
||
prefers-color-scheme: the page's own toggle decides. -->
|
||
|
||
<style>
|
||
.flow-wrap { margin: 0; }
|
||
.flow-wrap svg { width: 100%; height: auto; display: block; }
|
||
|
||
.flow-token {
|
||
fill: var(--calc-accent-b, #D1541F);
|
||
stroke: var(--calc-surface, #fbfcfd);
|
||
stroke-width: 1.2;
|
||
}
|
||
.flow-wrap .flow-on .box,
|
||
.flow-wrap .flow-on .box-plain,
|
||
.flow-wrap .flow-on .box-accent { stroke-width: 3; }
|
||
.flow-wrap .flow-done { stroke: var(--calc-accent-b, #D1541F); }
|
||
|
||
.flow-bar {
|
||
display: flex; align-items: center; gap: .5rem; flex-wrap: wrap;
|
||
max-width: 100%; margin: .45rem 0 0;
|
||
}
|
||
.flow-bar button {
|
||
font: inherit; font-size: .82rem; padding: .18rem .7rem; cursor: pointer;
|
||
border: 1px solid var(--calc-grid, #dae0e8); border-radius: 999px;
|
||
background: var(--calc-surface, #fbfcfd); color: var(--calc-muted, #5a6879);
|
||
}
|
||
.flow-bar button:hover {
|
||
border-color: var(--calc-notecolor, #20666f);
|
||
color: var(--calc-notecolor, #20666f);
|
||
}
|
||
.flow-bar button[disabled] { opacity: .45; cursor: default; }
|
||
.flow-status { font-size: .8rem; color: var(--calc-muted, #5a6879); }
|
||
.flow-status b { color: var(--calc-notecolor, #20666f); font-weight: 600; }
|
||
</style>
|
||
|
||
<script>
|
||
(() => {
|
||
const images = document.querySelectorAll("img.flow-figure");
|
||
if (!images.length) return;
|
||
|
||
const LANG = (document.documentElement.lang || "en").slice(0, 2);
|
||
const WORDS = {
|
||
en: { play: "Play", pause: "Pause", step: "One hop", reset: "Reset",
|
||
idle: "the message has not been sent yet", done: "arrived" },
|
||
fr: { play: "Lancer", pause: "Pause", step: "Un saut", reset: "Réinitialiser",
|
||
idle: "le message n'est pas encore parti", done: "arrivé" },
|
||
de: { play: "Abspielen", pause: "Pause", step: "Ein Sprung", reset: "Zurücksetzen",
|
||
idle: "die Nachricht ist noch nicht unterwegs", done: "angekommen" },
|
||
};
|
||
const W = WORDS[LANG] || WORDS.en;
|
||
const STILL = window.matchMedia("(prefers-reduced-motion: reduce)").matches;
|
||
const HOP = 620; // ms per hop
|
||
|
||
const label = (node) => {
|
||
const text = node && node.querySelector("text");
|
||
return text ? text.textContent.trim() : "";
|
||
};
|
||
|
||
async function upgrade(img) {
|
||
let svg;
|
||
try {
|
||
const response = await fetch(img.currentSrc || img.src);
|
||
if (!response.ok) return; // leave the plain image in place
|
||
const doc = new DOMParser().parseFromString(await response.text(), "image/svg+xml");
|
||
svg = doc.documentElement;
|
||
if (!svg || svg.nodeName !== "svg" || doc.querySelector("parsererror")) return;
|
||
} catch { return; } // file:// or offline: plain image
|
||
|
||
const edges = [...svg.querySelectorAll("[data-flow]")]
|
||
.sort((a, b) => Number(a.dataset.flow) - Number(b.dataset.flow));
|
||
if (!edges.length) return;
|
||
|
||
svg.removeAttribute("width");
|
||
svg.removeAttribute("height");
|
||
|
||
const wrap = document.createElement("div");
|
||
wrap.className = "flow-wrap";
|
||
wrap.appendChild(svg);
|
||
|
||
const bar = document.createElement("div");
|
||
bar.className = "flow-bar";
|
||
const make = (name) => {
|
||
const button = document.createElement("button");
|
||
button.type = "button";
|
||
button.textContent = W[name];
|
||
bar.appendChild(button);
|
||
return button;
|
||
};
|
||
const playButton = make("play");
|
||
const stepButton = make("step");
|
||
const resetButton = make("reset");
|
||
const status = document.createElement("span");
|
||
status.className = "flow-status";
|
||
bar.appendChild(status);
|
||
wrap.appendChild(bar);
|
||
|
||
img.hidden = true;
|
||
img.after(wrap);
|
||
|
||
const token = document.createElementNS("http://www.w3.org/2000/svg", "circle");
|
||
token.setAttribute("r", "6");
|
||
token.setAttribute("class", "flow-token");
|
||
token.style.display = "none";
|
||
svg.appendChild(token);
|
||
|
||
let at = 0; // hops already made
|
||
let playing = false;
|
||
let frame = null;
|
||
|
||
const nodeOf = (edge) =>
|
||
edge.dataset.flowTo
|
||
? svg.querySelector(`[data-flow-node="${edge.dataset.flowTo}"]`)
|
||
: null;
|
||
|
||
const say = () => {
|
||
if (at === 0) { status.textContent = W.idle; return; }
|
||
const here = label(nodeOf(edges[at - 1]));
|
||
status.innerHTML = `${at} / ${edges.length} — <b></b>`;
|
||
status.querySelector("b").textContent =
|
||
at === edges.length ? `${here} (${W.done})` : here;
|
||
};
|
||
|
||
const clear = () => {
|
||
svg.querySelectorAll(".flow-on").forEach((n) => n.classList.remove("flow-on"));
|
||
edges.forEach((e) => e.classList.remove("flow-done"));
|
||
};
|
||
|
||
const place = (edge, fraction) => {
|
||
const length = edge.getTotalLength();
|
||
const point = edge.getPointAtLength(length * fraction);
|
||
token.setAttribute("cx", point.x);
|
||
token.setAttribute("cy", point.y);
|
||
token.style.display = "";
|
||
};
|
||
|
||
function hop(then) {
|
||
const edge = edges[at];
|
||
if (!edge) { then && then(false); return; }
|
||
clear();
|
||
const arrive = () => {
|
||
edge.classList.add("flow-done");
|
||
const node = nodeOf(edge);
|
||
if (node) node.classList.add("flow-on");
|
||
at += 1;
|
||
say();
|
||
buttons();
|
||
then && then(at < edges.length);
|
||
};
|
||
if (STILL) { place(edge, 1); arrive(); return; }
|
||
const start = performance.now();
|
||
const tick = (now) => {
|
||
const done = Math.min((now - start) / HOP, 1);
|
||
place(edge, done);
|
||
if (done < 1) { frame = requestAnimationFrame(tick); } else { frame = null; arrive(); }
|
||
};
|
||
frame = requestAnimationFrame(tick);
|
||
}
|
||
|
||
function buttons() {
|
||
const end = at >= edges.length;
|
||
playButton.textContent = playing ? W.pause : W.play;
|
||
playButton.disabled = end && !playing;
|
||
stepButton.disabled = end || playing;
|
||
resetButton.disabled = at === 0 && !playing;
|
||
}
|
||
|
||
function stop() {
|
||
playing = false;
|
||
if (frame) { cancelAnimationFrame(frame); frame = null; }
|
||
buttons();
|
||
}
|
||
|
||
function run() {
|
||
if (at >= edges.length) at = 0;
|
||
playing = true;
|
||
buttons();
|
||
const next = (more) => {
|
||
if (!playing) return;
|
||
if (more) { hop(next); } else { stop(); }
|
||
};
|
||
hop(next);
|
||
}
|
||
|
||
playButton.addEventListener("click", () => (playing ? stop() : run()));
|
||
stepButton.addEventListener("click", () => { stop(); hop(); });
|
||
resetButton.addEventListener("click", () => {
|
||
stop();
|
||
at = 0;
|
||
clear();
|
||
token.style.display = "none";
|
||
say();
|
||
buttons();
|
||
});
|
||
|
||
say();
|
||
buttons();
|
||
}
|
||
|
||
images.forEach(upgrade);
|
||
})();
|
||
</script>
|
||
<script id="quarto-html-after-body" type="application/javascript">
|
||
window.document.addEventListener("DOMContentLoaded", function (event) {
|
||
// Ensure there is a toggle, if there isn't float one in the top right
|
||
if (window.document.querySelector('.quarto-color-scheme-toggle') === null) {
|
||
const a = window.document.createElement('a');
|
||
a.classList.add('top-right');
|
||
a.classList.add('quarto-color-scheme-toggle');
|
||
a.href = "";
|
||
a.onclick = function() { try { window.quartoToggleColorScheme(); } catch {} return false; };
|
||
const i = window.document.createElement("i");
|
||
i.classList.add('bi');
|
||
a.appendChild(i);
|
||
window.document.body.appendChild(a);
|
||
}
|
||
setColorSchemeToggle(hasAlternateSentinel())
|
||
const icon = "";
|
||
const anchorJS = new window.AnchorJS();
|
||
anchorJS.options = {
|
||
placement: 'right',
|
||
icon: icon
|
||
};
|
||
anchorJS.add('.anchored');
|
||
const isCodeAnnotation = (el) => {
|
||
for (const clz of el.classList) {
|
||
if (clz.startsWith('code-annotation-')) {
|
||
return true;
|
||
}
|
||
}
|
||
return false;
|
||
}
|
||
const onCopySuccess = function(e) {
|
||
// button target
|
||
const button = e.trigger;
|
||
// don't keep focus
|
||
button.blur();
|
||
// flash "checked"
|
||
button.classList.add('code-copy-button-checked');
|
||
var currentTitle = button.getAttribute("title");
|
||
button.setAttribute("title", "Copied!");
|
||
let tooltip;
|
||
if (window.bootstrap) {
|
||
button.setAttribute("data-bs-toggle", "tooltip");
|
||
button.setAttribute("data-bs-placement", "left");
|
||
button.setAttribute("data-bs-title", "Copied!");
|
||
tooltip = new bootstrap.Tooltip(button,
|
||
{ trigger: "manual",
|
||
customClass: "code-copy-button-tooltip",
|
||
offset: [0, -8]});
|
||
tooltip.show();
|
||
}
|
||
setTimeout(function() {
|
||
if (tooltip) {
|
||
tooltip.hide();
|
||
button.removeAttribute("data-bs-title");
|
||
button.removeAttribute("data-bs-toggle");
|
||
button.removeAttribute("data-bs-placement");
|
||
}
|
||
button.setAttribute("title", currentTitle);
|
||
button.classList.remove('code-copy-button-checked');
|
||
}, 1000);
|
||
// clear code selection
|
||
e.clearSelection();
|
||
}
|
||
const getTextToCopy = function(trigger) {
|
||
const outerScaffold = trigger.parentElement.cloneNode(true);
|
||
const codeEl = outerScaffold.querySelector('code');
|
||
for (const childEl of codeEl.children) {
|
||
if (isCodeAnnotation(childEl)) {
|
||
childEl.remove();
|
||
}
|
||
}
|
||
return codeEl.innerText;
|
||
}
|
||
const clipboard = new window.ClipboardJS('.code-copy-button:not([data-in-quarto-modal])', {
|
||
text: getTextToCopy
|
||
});
|
||
clipboard.on('success', onCopySuccess);
|
||
if (window.document.getElementById('quarto-embedded-source-code-modal')) {
|
||
const clipboardModal = new window.ClipboardJS('.code-copy-button[data-in-quarto-modal]', {
|
||
text: getTextToCopy,
|
||
container: window.document.getElementById('quarto-embedded-source-code-modal')
|
||
});
|
||
clipboardModal.on('success', onCopySuccess);
|
||
}
|
||
var localhostRegex = new RegExp(/^(?:http|https):\/\/localhost\:?[0-9]*\//);
|
||
var mailtoRegex = new RegExp(/^mailto:/);
|
||
var filterRegex = new RegExp('/' + window.location.host + '/');
|
||
var isInternal = (href) => {
|
||
return filterRegex.test(href) || localhostRegex.test(href) || mailtoRegex.test(href);
|
||
}
|
||
// Inspect non-navigation links and adorn them if external
|
||
var links = window.document.querySelectorAll('a[href]:not(.nav-link):not(.navbar-brand):not(.toc-action):not(.sidebar-link):not(.sidebar-item-toggle):not(.pagination-link):not(.no-external):not([aria-hidden]):not(.dropdown-item):not(.quarto-navigation-tool):not(.about-link)');
|
||
for (var i=0; i<links.length; i++) {
|
||
const link = links[i];
|
||
if (!isInternal(link.href)) {
|
||
// undo the damage that might have been done by quarto-nav.js in the case of
|
||
// links that we want to consider external
|
||
if (link.dataset.originalHref !== undefined) {
|
||
link.href = link.dataset.originalHref;
|
||
}
|
||
// target, if specified
|
||
link.setAttribute("target", "_blank");
|
||
if (link.getAttribute("rel") === null) {
|
||
link.setAttribute("rel", "noopener");
|
||
}
|
||
}
|
||
}
|
||
function tippyHover(el, contentFn, onTriggerFn, onUntriggerFn) {
|
||
const config = {
|
||
allowHTML: true,
|
||
maxWidth: 500,
|
||
delay: 100,
|
||
arrow: false,
|
||
appendTo: function(el) {
|
||
return el.parentElement;
|
||
},
|
||
interactive: true,
|
||
interactiveBorder: 10,
|
||
theme: 'quarto',
|
||
placement: 'bottom-start',
|
||
};
|
||
if (contentFn) {
|
||
config.content = contentFn;
|
||
}
|
||
if (onTriggerFn) {
|
||
config.onTrigger = onTriggerFn;
|
||
}
|
||
if (onUntriggerFn) {
|
||
config.onUntrigger = onUntriggerFn;
|
||
}
|
||
window.tippy(el, config);
|
||
}
|
||
const noterefs = window.document.querySelectorAll('a[role="doc-noteref"]');
|
||
for (var i=0; i<noterefs.length; i++) {
|
||
const ref = noterefs[i];
|
||
tippyHover(ref, function() {
|
||
// use id or data attribute instead here
|
||
let href = ref.getAttribute('data-footnote-href') || ref.getAttribute('href');
|
||
try { href = new URL(href).hash; } catch {}
|
||
const id = href.replace(/^#\/?/, "");
|
||
const note = window.document.getElementById(id);
|
||
if (note) {
|
||
return note.innerHTML;
|
||
} else {
|
||
return "";
|
||
}
|
||
});
|
||
}
|
||
const xrefs = window.document.querySelectorAll('a.quarto-xref');
|
||
const processXRef = (id, note) => {
|
||
// Strip column container classes
|
||
const stripColumnClz = (el) => {
|
||
el.classList.remove("page-full", "page-columns");
|
||
if (el.children) {
|
||
for (const child of el.children) {
|
||
stripColumnClz(child);
|
||
}
|
||
}
|
||
}
|
||
stripColumnClz(note)
|
||
if (id === null || id.startsWith('sec-')) {
|
||
// Special case sections, only their first couple elements
|
||
const container = document.createElement("div");
|
||
if (note.children && note.children.length > 2) {
|
||
container.appendChild(note.children[0].cloneNode(true));
|
||
for (let i = 1; i < note.children.length; i++) {
|
||
const child = note.children[i];
|
||
if (child.tagName === "P" && child.innerText === "") {
|
||
continue;
|
||
} else {
|
||
container.appendChild(child.cloneNode(true));
|
||
break;
|
||
}
|
||
}
|
||
if (window.Quarto?.typesetMath) {
|
||
window.Quarto.typesetMath(container);
|
||
}
|
||
return container.innerHTML
|
||
} else {
|
||
if (window.Quarto?.typesetMath) {
|
||
window.Quarto.typesetMath(note);
|
||
}
|
||
return note.innerHTML;
|
||
}
|
||
} else {
|
||
// Remove any anchor links if they are present
|
||
const anchorLink = note.querySelector('a.anchorjs-link');
|
||
if (anchorLink) {
|
||
anchorLink.remove();
|
||
}
|
||
if (window.Quarto?.typesetMath) {
|
||
window.Quarto.typesetMath(note);
|
||
}
|
||
if (note.classList.contains("callout")) {
|
||
return note.outerHTML;
|
||
} else {
|
||
return note.innerHTML;
|
||
}
|
||
}
|
||
}
|
||
for (var i=0; i<xrefs.length; i++) {
|
||
const xref = xrefs[i];
|
||
tippyHover(xref, undefined, function(instance) {
|
||
instance.disable();
|
||
let url = xref.getAttribute('href');
|
||
let hash = undefined;
|
||
if (url.startsWith('#')) {
|
||
hash = url;
|
||
} else {
|
||
try { hash = new URL(url).hash; } catch {}
|
||
}
|
||
if (hash) {
|
||
const id = hash.replace(/^#\/?/, "");
|
||
const note = window.document.getElementById(id);
|
||
if (note !== null) {
|
||
try {
|
||
const html = processXRef(id, note.cloneNode(true));
|
||
instance.setContent(html);
|
||
} finally {
|
||
instance.enable();
|
||
instance.show();
|
||
}
|
||
} else {
|
||
// See if we can fetch this
|
||
fetch(url.split('#')[0])
|
||
.then(res => res.text())
|
||
.then(html => {
|
||
const parser = new DOMParser();
|
||
const htmlDoc = parser.parseFromString(html, "text/html");
|
||
const note = htmlDoc.getElementById(id);
|
||
if (note !== null) {
|
||
const html = processXRef(id, note);
|
||
instance.setContent(html);
|
||
}
|
||
}).finally(() => {
|
||
instance.enable();
|
||
instance.show();
|
||
});
|
||
}
|
||
} else {
|
||
// See if we can fetch a full url (with no hash to target)
|
||
// This is a special case and we should probably do some content thinning / targeting
|
||
fetch(url)
|
||
.then(res => res.text())
|
||
.then(html => {
|
||
const parser = new DOMParser();
|
||
const htmlDoc = parser.parseFromString(html, "text/html");
|
||
const note = htmlDoc.querySelector('main.content');
|
||
if (note !== null) {
|
||
// This should only happen for chapter cross references
|
||
// (since there is no id in the URL)
|
||
// remove the first header
|
||
if (note.children.length > 0 && note.children[0].tagName === "HEADER") {
|
||
note.children[0].remove();
|
||
}
|
||
const html = processXRef(null, note);
|
||
instance.setContent(html);
|
||
}
|
||
}).finally(() => {
|
||
instance.enable();
|
||
instance.show();
|
||
});
|
||
}
|
||
}, function(instance) {
|
||
});
|
||
}
|
||
let selectedAnnoteEl;
|
||
const selectorForAnnotation = ( cell, annotation) => {
|
||
let cellAttr = 'data-code-cell="' + cell + '"';
|
||
let lineAttr = 'data-code-annotation="' + annotation + '"';
|
||
const selector = 'span[' + cellAttr + '][' + lineAttr + ']';
|
||
return selector;
|
||
}
|
||
const selectCodeLines = (annoteEl) => {
|
||
const doc = window.document;
|
||
const targetCell = annoteEl.getAttribute("data-target-cell");
|
||
const targetAnnotation = annoteEl.getAttribute("data-target-annotation");
|
||
const annoteSpan = window.document.querySelector(selectorForAnnotation(targetCell, targetAnnotation));
|
||
const lines = annoteSpan.getAttribute("data-code-lines").split(",");
|
||
const lineIds = lines.map((line) => {
|
||
return targetCell + "-" + line;
|
||
})
|
||
let top = null;
|
||
let height = null;
|
||
let parent = null;
|
||
if (lineIds.length > 0) {
|
||
//compute the position of the single el (top and bottom and make a div)
|
||
const el = window.document.getElementById(lineIds[0]);
|
||
top = el.offsetTop;
|
||
height = el.offsetHeight;
|
||
parent = el.parentElement.parentElement;
|
||
if (lineIds.length > 1) {
|
||
const lastEl = window.document.getElementById(lineIds[lineIds.length - 1]);
|
||
const bottom = lastEl.offsetTop + lastEl.offsetHeight;
|
||
height = bottom - top;
|
||
}
|
||
if (top !== null && height !== null && parent !== null) {
|
||
// cook up a div (if necessary) and position it
|
||
let div = window.document.getElementById("code-annotation-line-highlight");
|
||
if (div === null) {
|
||
div = window.document.createElement("div");
|
||
div.setAttribute("id", "code-annotation-line-highlight");
|
||
div.style.position = 'absolute';
|
||
parent.appendChild(div);
|
||
}
|
||
div.style.top = top - 2 + "px";
|
||
div.style.height = height + 4 + "px";
|
||
div.style.left = 0;
|
||
let gutterDiv = window.document.getElementById("code-annotation-line-highlight-gutter");
|
||
if (gutterDiv === null) {
|
||
gutterDiv = window.document.createElement("div");
|
||
gutterDiv.setAttribute("id", "code-annotation-line-highlight-gutter");
|
||
gutterDiv.style.position = 'absolute';
|
||
const codeCell = window.document.getElementById(targetCell);
|
||
const gutter = codeCell.querySelector('.code-annotation-gutter');
|
||
gutter.appendChild(gutterDiv);
|
||
}
|
||
gutterDiv.style.top = top - 2 + "px";
|
||
gutterDiv.style.height = height + 4 + "px";
|
||
}
|
||
selectedAnnoteEl = annoteEl;
|
||
}
|
||
};
|
||
const unselectCodeLines = () => {
|
||
const elementsIds = ["code-annotation-line-highlight", "code-annotation-line-highlight-gutter"];
|
||
elementsIds.forEach((elId) => {
|
||
const div = window.document.getElementById(elId);
|
||
if (div) {
|
||
div.remove();
|
||
}
|
||
});
|
||
selectedAnnoteEl = undefined;
|
||
};
|
||
// Handle positioning of the toggle
|
||
window.addEventListener(
|
||
"resize",
|
||
throttle(() => {
|
||
elRect = undefined;
|
||
if (selectedAnnoteEl) {
|
||
selectCodeLines(selectedAnnoteEl);
|
||
}
|
||
}, 10)
|
||
);
|
||
function throttle(fn, ms) {
|
||
let throttle = false;
|
||
let timer;
|
||
return (...args) => {
|
||
if(!throttle) { // first call gets through
|
||
fn.apply(this, args);
|
||
throttle = true;
|
||
} else { // all the others get throttled
|
||
if(timer) clearTimeout(timer); // cancel #2
|
||
timer = setTimeout(() => {
|
||
fn.apply(this, args);
|
||
timer = throttle = false;
|
||
}, ms);
|
||
}
|
||
};
|
||
}
|
||
// Attach click handler to the DT
|
||
const annoteDls = window.document.querySelectorAll('dt[data-target-cell]');
|
||
for (const annoteDlNode of annoteDls) {
|
||
annoteDlNode.addEventListener('click', (event) => {
|
||
const clickedEl = event.target;
|
||
if (clickedEl !== selectedAnnoteEl) {
|
||
unselectCodeLines();
|
||
const activeEl = window.document.querySelector('dt[data-target-cell].code-annotation-active');
|
||
if (activeEl) {
|
||
activeEl.classList.remove('code-annotation-active');
|
||
}
|
||
selectCodeLines(clickedEl);
|
||
clickedEl.classList.add('code-annotation-active');
|
||
} else {
|
||
// Unselect the line
|
||
unselectCodeLines();
|
||
clickedEl.classList.remove('code-annotation-active');
|
||
}
|
||
});
|
||
}
|
||
const findCites = (el) => {
|
||
const parentEl = el.parentElement;
|
||
if (parentEl) {
|
||
const cites = parentEl.dataset.cites;
|
||
if (cites) {
|
||
return {
|
||
el,
|
||
cites: cites.split(' ')
|
||
};
|
||
} else {
|
||
return findCites(el.parentElement)
|
||
}
|
||
} else {
|
||
return undefined;
|
||
}
|
||
};
|
||
var bibliorefs = window.document.querySelectorAll('a[role="doc-biblioref"]');
|
||
for (var i=0; i<bibliorefs.length; i++) {
|
||
const ref = bibliorefs[i];
|
||
const citeInfo = findCites(ref);
|
||
if (citeInfo) {
|
||
tippyHover(citeInfo.el, function() {
|
||
var popup = window.document.createElement('div');
|
||
citeInfo.cites.forEach(function(cite) {
|
||
var citeDiv = window.document.createElement('div');
|
||
citeDiv.classList.add('hanging-indent');
|
||
citeDiv.classList.add('csl-entry');
|
||
var biblioDiv = window.document.getElementById('ref-' + cite);
|
||
if (biblioDiv) {
|
||
citeDiv.innerHTML = biblioDiv.innerHTML;
|
||
}
|
||
popup.appendChild(citeDiv);
|
||
});
|
||
return popup.innerHTML;
|
||
});
|
||
}
|
||
}
|
||
});
|
||
</script>
|
||
<nav class="page-navigation">
|
||
<div class="nav-page nav-page-previous">
|
||
<a href="./07-part-vii-mediation.html" class="pagination-link" aria-label="[Part VII — Now merge the two architectural ideas]{.en}[Partie VII — Fusionner les deux idées architecturales]{.fr}[Teil VII — Die zwei architektonischen Ideen zusammenführen]{.de}">
|
||
<i class="bi bi-arrow-left-short"></i> <span class="nav-page-text"><span class="chapter-number">8</span> <span class="chapter-title">Part VII — Now merge the two architectural ideas</span></span>
|
||
</a>
|
||
</div>
|
||
<div class="nav-page nav-page-next">
|
||
<a href="./glossary.html" class="pagination-link" aria-label="[Glossary]{.en}[Glossaire]{.fr}[Glossar]{.de}">
|
||
<span class="nav-page-text">Glossary</span> <i class="bi bi-arrow-right-short"></i>
|
||
</a>
|
||
</div>
|
||
</nav>
|
||
</div> <!-- /content -->
|
||
|
||
|
||
|
||
|
||
<script src="site_libs/quarto-html/zenscroll-min.js"></script>
|
||
</body></html> |