@mark1russell7/machines 0.3.32 → 0.3.33

package/README.md

@@ -38,6 +38,8 @@ The algebra reads these documents. It gives the closed form of each timer, the f
 | `GO_TRANSPORT` | `go-nethttp-transport` | One connection of the `http.Transport` of Go 1.27.2 | driver | 7 implemented |
 | `PROCEDURES_WS_CLIENT` | `procedures-ws-client` | The WebSocket client of `@procedures/client` 0.22.0 (client 2408cea) | driver | 9 implemented, 1 documented |
 | `PROCEDURES_WS_SERVER` | `procedures-ws-server` | The WebSocket server of `@procedures/client` 0.22.0 (client 2408cea) | server | 5 implemented |
+| `SOCKETIO_CLIENT` | `socketio-client` | The connection of the `Manager` of socket.io-client 4.8.4, on engine.io-client 6.6.7 and ws 8.21.3 | driver | 8 implemented |
+| `SOCKETIO_SERVER` | `socketio-server` | One connection of the `Server` of socket.io 4.8.4, on engine.io 6.6.11 and ws 8.21.3 | server | 6 implemented |
 | `MONGODB_NODE` | `mongodb-node` | The MongoDB Node driver 7.7.0, for one server of a replica set | driver | 19 implemented |
 | `MONGOD_REPL` | `mongod-replication` | The replication of mongod 9.0.4: one member of a replica set | server | 29 implemented |
 | `MONGOD_SESSION` | `mongod-session` | One client connection of mongod 9.0.4 | server | 6 implemented |

package/build/index.d.ts

@@ -1,5 +1,4 @@
 import { Expr, Machine } from "@mark1russell7/algebra";
-//#region src/call.d.ts
 /**
  * This document is one call of a program on a socket of Linux TCP: a deadline for each try, and a
  * retry after each deadline. It is a generic client that the program configures, as the
@@ -15,8 +14,6 @@ import { Expr, Machine } from "@mark1russell7/algebra";
  * - The count of retries is the count of firings of `retry`. The caller gives it.
  */
 export declare const DEADLINE_CALL: Machine;
-//#endregion
-//#region src/grpc/grpc-go-server.d.ts
 /**
  * This document is a server of grpc-go v1.84.0 on its own listener: grpc.NewServer on net.Listen, at the
  * defaults, as in the server of the harness. Its keepalive is on (a PING after 2 h with no read). Thus the
@@ -34,8 +31,6 @@ export declare const GRPC_GO_SERVER: Machine;
  * count of Go stay. Thus an idle connection to a gone client ends 165 s after the last data: 30 + 9 × 15.
  */
 export declare const ETCD_SERVER: Machine;
-//#endregion
-//#region src/grpc/grpc-js.d.ts
 /**
  * This document is grpc-js 1.14.6 on Node, for one channel to one server with no TLS, its transport
  * (one HTTP/2 session on one TCP connection) and one unary call on it. It gives the states of the
@@ -51,8 +46,6 @@ export declare const ETCD_SERVER: Machine;
  * that finds the channel in TRANSIENT_FAILURE fails at once, unless it asks to wait for the channel.
  */
 export declare const GRPC_JS: Machine;
-//#endregion
-//#region src/http/go-transport.d.ts
 /**
  * This document is one connection of the `http.Transport` of Go 1.27.2 at its defaults, over its
  * Linux TCP socket. Each fact comes from the source at the tag `go1.27.2`. The comments give the
@@ -64,8 +57,6 @@ export declare const GRPC_JS: Machine;
  * request that it can replay again, on a new connection, by itself.
  */
 export declare const GO_TRANSPORT: Machine;
-//#endregion
-//#region src/http/node-agent.d.ts
 /**
  * This document is one socket of the `http.Agent` of Node v24.21.0, as its global agent sets it.
  * Its keep-alive is on, its free socket timeout is 5 s, and it is LIFO. It is over the Linux TCP socket. Each fact
@@ -81,8 +72,6 @@ export declare const GO_TRANSPORT: Machine;
  * adds it from a calibration (`HANDLING` in `packages/cells/src/http/race.ts`).
  */
 export declare const NODE_HTTP_AGENT: Machine;
-//#endregion
-//#region src/http/node-server.d.ts
 /**
  * This document is one connection as the `http.Server` of Node v24.21.0 holds it, over the Linux
  * TCP socket of the connection. Each fact comes from the source at the tag `v24.21.0`. The comments
@@ -94,8 +83,6 @@ export declare const NODE_HTTP_AGENT: Machine;
  * a reset when the receive queue has data that nothing read.
  */
 export declare const NODE_HTTP_SERVER: Machine;
-//#endregion
-//#region src/http/undici.d.ts
 /**
  * This document is the socket of an HTTP/1.1 `Client` of undici 8.12.2, over its Linux TCP socket.
  * Each fact comes from the published package at 8.12.2, with the file and the line.
@@ -111,8 +98,6 @@ export declare const NODE_HTTP_SERVER: Machine;
  * it from a calibration (`HANDLING` in `packages/cells/src/http/race.ts`).
  */
 export declare const UNDICI_CLIENT: Machine;
-//#endregion
-//#region src/http/undici-retry.d.ts
 /**
  * This document is one request through a `RetryAgent` of undici 8.12.2: the retries of a reply
  * whose status is retryable, for example 429 or 503. Each fact comes from the published package at
@@ -134,8 +119,6 @@ export declare const UNDICI_CLIENT: Machine;
  * request again for a status. Their retry window is 0.
  */
 export declare const UNDICI_RETRY: Machine;
-//#endregion
-//#region src/ioredis-sentinel.d.ts
 /**
  * This document is the Sentinel path of ioredis 6.0.0. It tells how ioredis finds the primary of a
  * group through the Sentinels, loses it, and connects to the new one. The standalone states of
@@ -144,8 +127,6 @@ export declare const UNDICI_RETRY: Machine;
  * subscribes to `+switch-master`, is off by default.
  */
 export declare const IOREDIS_SENTINEL: Machine;
-//#endregion
-//#region src/json.d.ts
 /** This document is TCP as Linux 6.6 implements it: one full socket, from the source of the kernel and the RFCs. */
 export declare const LINUX_TCP: Machine;
 /** This document is the TCP state machine of conntrack on Linux 6.6.87.2: the state of a router or a NAT for one flow. */
@@ -160,8 +141,6 @@ export declare const IOREDIS_STATUS: Machine;
  * process continues to send ACKs, thus `rx.ack` arrives.
  */
 export declare const MANIFESTATIONS: Readonly<Record<string, readonly string[]>>;
-//#endregion
-//#region src/k8s/kubelet-readiness.d.ts
 /**
  * This document is the readiness probe of the kubelet of Kubernetes 1.37.0 for one container. Each
  * fact comes from the source at the tag v1.37.0, with the file and the line. The defaults are a
@@ -182,8 +161,6 @@ export declare const MANIFESTATIONS: Readonly<Record<string, readonly string[]>>
  * random part of a period before its first probe.
  */
 export declare const KUBELET_READINESS: Machine;
-//#endregion
-//#region src/kafka/group.d.ts
 /**
  * This document is Apache Kafka 4.3.2, for one member of a consumer group that a process stop holds.
  * It gives when the coordinator removes the member, and when another member gets its partition. It
@@ -201,8 +178,6 @@ export declare const KUBELET_READINESS: Machine;
  * the committed offset back while another member owns the partition.
  */
 export declare const KAFKA_CONSUMER_GROUP: Machine;
-//#endregion
-//#region src/kafka/partition.d.ts
 /**
  * This document is Apache Kafka 4.3.2, for one broker that leads one partition, in KRaft mode. It
  * gives what the broker answers at each `acks`, and how the high watermark moves. It also gives how
@@ -221,8 +196,6 @@ export declare const KAFKA_CONSUMER_GROUP: Machine;
  * truncates to that offset, not to the high watermark.
  */
 export declare const KAFKA_PARTITION: Machine;
-//#endregion
-//#region src/mongo/mongod-replication.d.ts
 /**
  * This document is the replication of mongod 9.0.4. It gives one member of a replica set, its view
  * of the primary, and the election that it can hold. The states are the states of the member. The
@@ -241,8 +214,6 @@ export declare const KAFKA_PARTITION: Machine;
  * position of that secondary only from the response to each heartbeat.
  */
 export declare const MONGOD_REPL: Machine;
-//#endregion
-//#region src/mongo/mongod-session.d.ts
 /**
  * This document is the hold of mongod 9.0.4 on one client connection, over its socket. `mongod`
  * turns keepalive on for each TCP session. It lowers two keepalive options of the socket to a
@@ -257,8 +228,6 @@ export declare const MONGOD_REPL: Machine;
  * Then `mongod` sends the reply, and it starts the next hello of the stream at once.
  */
 export declare const MONGOD_SESSION: Machine;
-//#endregion
-//#region src/mongo/mongodb-node.d.ts
 /**
  * This document is the MongoDB Node driver 7.7.0, for one server of a replica set. It gives one
  * connection of the driver by its role, and the timers that act on it. The roles are the monitor
@@ -272,8 +241,6 @@ export declare const MONGOD_SESSION: Machine;
  * `serverSelectionTimeoutMS`.
  */
 export declare const MONGODB_NODE: Machine;
-//#endregion
-//#region src/pg/hikaricp-pgjdbc.d.ts
 /**
  * This document is HikariCP 7.1.0 over pgjdbc 42.7.13, for one connection of a pool. It gives the
  * states of the connection, from its creation to its close, and the timers that act on it. The
@@ -301,8 +268,6 @@ export declare const MONGODB_NODE: Machine;
  * connection. HikariCP does not send a statement again.
  */
 export declare const HIKARICP_PGJDBC: Machine;
-//#endregion
-//#region src/pg/node-postgres.d.ts
 /**
  * This document is node-postgres 8.23.1 (the npm package pg) with pg-pool 3.14.0, for one client
  * of a `pg.Pool`. It gives the states of the client, from its connect to its end, and the timers
@@ -324,8 +289,6 @@ export declare const HIKARICP_PGJDBC: Machine;
  * throws.
  */
 export declare const NODE_POSTGRES: Machine;
-//#endregion
-//#region src/pg/pgbouncer.d.ts
 /**
  * This document is PgBouncer 1.26.1 in transaction pooling, for one client connection. It gives the
  * states of the client, from its accept to its close, and the timers that act on it.
@@ -341,8 +304,6 @@ export declare const NODE_POSTGRES: Machine;
  * fires, and the failure of the linked server, close the client with a FATAL error of SQLSTATE 08P01.
  */
 export declare const PGBOUNCER_CLIENT: Machine;
-//#endregion
-//#region src/pg/pgbouncer-server.d.ts
 /**
  * This document is PgBouncer 1.26.1 in transaction pooling, for one server connection of a pool:
  * from its launch to its close. It also gives the wait of the pool before its next connection after
@@ -361,8 +322,6 @@ export declare const PGBOUNCER_CLIENT: Machine;
  * each client that needs a server fails at once, and a waiting client stays in the queue.
  */
 export declare const PGBOUNCER_SERVER: Machine;
-//#endregion
-//#region src/pg/pgpool.d.ts
 /**
  * This document is Pgpool-II 4.7.3 with one backend, for one session of a client. It gives the states
  * of the session in its child process, from the accept of the client to its close. It also gives the
@@ -382,8 +341,6 @@ export declare const PGBOUNCER_SERVER: Machine;
  * (failover_on_backend_error).
  */
 export declare const PGPOOL_SESSION: Machine;
-//#endregion
-//#region src/pg/postgres-session.d.ts
 /**
  * This document is the hold of a PostgreSQL 17.11 backend on one client connection, over its TCP
  * socket on Linux. The backend turns on SO_KEEPALIVE for each TCP socket. At the defaults of its
@@ -405,8 +362,6 @@ export declare const PGPOOL_SESSION: Machine;
  * `idle_session_timeout` and `client_connection_check_interval`.
  */
 export declare const POSTGRES_SESSION: Machine;
-//#endregion
-//#region src/pg/supavisor-client.d.ts
 /**
  * This document is Supavisor 2.9.13 in transaction mode, for one client connection. It gives the
  * states of the client handler (a gen_statem) from the accept to the close, and the timers that act
@@ -427,8 +382,6 @@ export declare const POSTGRES_SESSION: Machine;
  * behind the data that the kernel did not send.
  */
 export declare const SUPAVISOR_CLIENT: Machine;
-//#endregion
-//#region src/pg/supavisor-server.d.ts
 /**
  * This document is Supavisor 2.9.13 in transaction mode, for one server connection of the pool of a
  * tenant. It is one DbHandler, a gen_statem, from its start by the pool to its end.
@@ -443,8 +396,6 @@ export declare const SUPAVISOR_CLIENT: Machine;
  * TCP_NODELAY and no keepalive, and no timer of Supavisor bounds a query.
  */
 export declare const SUPAVISOR_SERVER: Machine;
-//#endregion
-//#region src/procedures-ws.d.ts
 /**
  * This document is the connection of the WebSocket client of `@procedures/client` 0.22.0 at
  * commit 2408cea (`WebSocketTransport`), over its socket class and its Linux TCP socket. The
@@ -475,8 +426,6 @@ export declare const PROCEDURES_WS_CLIENT: Machine;
  * adds. Its `http.Server` sets no SO_KEEPALIVE when `keepAlive` is off, the default of Node.
  */
 export declare const PROCEDURES_WS_SERVER: Machine;
-//#endregion
-//#region src/proxy/caddy.d.ts
 /**
  * This document is Caddy 2.11.7 as an HTTP/2 proxy of gRPC, for one connection of a client. Its
  * configuration is the one of the harness: one server of h1 and h2c, and `reverse_proxy` to one upstream
@@ -488,8 +437,6 @@ export declare const PROCEDURES_WS_SERVER: Machine;
  * sends no PING. At SIGTERM it sends GOAWAY at once, and it waits for each stream at its defaults.
  */
 export declare const CADDY_HTTP2: Machine;
-//#endregion
-//#region src/proxy/envoy.d.ts
 /**
  * This document is Envoy 1.39.4 as an HTTP/2 proxy of gRPC, for one connection of a client. Its static
  * configuration is the one of the harness. It has one listener with the HTTP connection manager, one
@@ -502,8 +449,6 @@ export declare const CADDY_HTTP2: Machine;
  * SIGTERM it closes each connection with no GOAWAY.
  */
 export declare const ENVOY_HTTP2: Machine;
-//#endregion
-//#region src/proxy/haproxy.d.ts
 /**
  * This document is one connection of HAProxy 3.2.25 in TCP mode, with the configuration of T02:
  * `mode tcp`, `timeout client`, `timeout server`, `option clitcpka` and `option srvtcpka`. It sets
@@ -521,8 +466,6 @@ export declare const ENVOY_HTTP2: Machine;
  *   and one step of the loop early or late.
  */
 export declare const HAPROXY_TCP: Machine;
-//#endregion
-//#region src/proxy/istio.d.ts
 /** A side of a sidecar is the listener of the connection: outbound from the app, or inbound to the app. */
 type SidecarSide = "outbound" | "inbound";
 /**
@@ -548,8 +491,6 @@ export declare const ISTIO_SIDECAR_INBOUND: Machine;
  * minimum drain, then polls the active connections each 1 s.
  */
 export declare const PILOT_AGENT: Machine;
-//#endregion
-//#region src/proxy/nginx.d.ts
 /**
  * This document is nginx 1.29.6 as an HTTP/2 proxy of gRPC, for one connection of a client. Its
  * configuration is the one of the harness: one worker (the default), one server of h2c, and `grpc_pass`
@@ -571,8 +512,6 @@ export declare const PILOT_AGENT: Machine;
  *   no GOAWAY.
  */
 export declare const NGINX_GRPC: Machine;
-//#endregion
-//#region src/proxy/traefik.d.ts
 /**
  * This document is Traefik 3.7.15 as an HTTP/2 proxy of gRPC, for one connection of a client. Its
  * configuration is the one of the harness. It has one entrypoint of h2c and the file provider over a
@@ -589,8 +528,6 @@ export declare const NGINX_GRPC: Machine;
  * - At SIGTERM, Traefik sends GOAWAY, and it closes each connection after graceTimeOut (10 s).
  */
 export declare const TRAEFIK_HTTP2: Machine;
-//#endregion
-//#region src/proxy/tcp-proxies.d.ts
 /**
  * This document is one proxied connection of Toxiproxy 2.12.0, with no toxic. Toxiproxy copies TCP, and it
  * knows no protocol above it. It has no timer on a link. Each socket gets the TCP keepalive of Go. It has
@@ -606,8 +543,6 @@ export declare const TOXIPROXY_LINK: Machine;
  * container, closes each connection fully.
  */
 export declare const DOCKER_PROXY_LINK: Machine;
-//#endregion
-//#region src/proxy/ztunnel.d.ts
 /**
  * This document is ztunnel 1.31.3 in the ambient mesh of Istio, in in-pod mode. It is one HBONE
  * connection from the ztunnel of a client pod to the port 15008 of a server pod. The flows of the
@@ -626,8 +561,6 @@ export declare const DOCKER_PROXY_LINK: Machine;
  * come. The kubelet sends SIGKILL to ztunnel at the end of the grace, and the kernel closes each socket.
  */
 export declare const ZTUNNEL_HBONE: Machine;
-//#endregion
-//#region src/rabbit/amqplib.d.ts
 /**
  * This document is amqplib 2.2.0 on Node, for one connection to a broker of AMQP 0-9-1 and one channel
  * on it. It gives the states of the connection, from its connect to its end, and the timers that act on
@@ -644,8 +577,6 @@ export declare const ZTUNNEL_HBONE: Machine;
  * by itself. Its recovery is a wrapper that this document does not hold.
  */
 export declare const AMQPLIB: Machine;
-//#endregion
-//#region src/rabbit/aten.d.ts
 /**
  * This document is aten 0.6.0, the failure detector between the nodes of RabbitMQ 4.3.6. It gives one
  * node that another node watches: up or down, as the detector of the watching node sees it.
@@ -664,8 +595,6 @@ export declare const AMQPLIB: Machine;
  * sink. The next poll then reports the node down.
  */
 export declare const ATEN_DETECTOR: Machine;
-//#endregion
-//#region src/rabbit/ra-member.d.ts
 /**
  * This document is ra 3.1.10, for one member of the Raft cluster of a quorum queue of RabbitMQ 4.3.6.
  * It gives the roles of the member, the election timers, and the change of leader.
@@ -685,8 +614,6 @@ export declare const ATEN_DETECTOR: Machine;
  * minority, and it commits nothing, until it sees a higher term.
  */
 export declare const RA_MEMBER: Machine;
-//#endregion
-//#region src/rabbit/rabbitmq-connection.d.ts
 /**
  * This document is RabbitMQ 4.3.6, for one connection of AMQP 0-9-1 on the broker. It gives the reader of
  * the connection, from the accept to the close, and the timers that act on it.
@@ -702,8 +629,6 @@ export declare const RA_MEMBER: Machine;
  * its socket, and the receive check pauses.
  */
 export declare const RABBITMQ_CONNECTION: Machine;
-//#endregion
-//#region src/sentinel.d.ts
 /**
  * This document is the Sentinel of Valkey 9.1.2. It gives the view of one Sentinel on the primary
  * of a group that it monitors, and the failover that it can lead. The states are the down states
@@ -711,8 +636,33 @@ export declare const RABBITMQ_CONNECTION: Machine;
  * Each timer of a period checks at the next tick of the Sentinel, thus its lateness is one tick.
  */
 export declare const SENTINEL: Machine;
-//#endregion
-//#region src/http/timers.d.ts
+/**
+ * This document is the connection of the Manager of socket.io-client 4.8.4 over engine.io-client
+ * 6.6.7, with the Node WebSocket transport (the ws package), over its Linux TCP socket.
+ *
+ * - The client waits pingInterval + pingTimeout for each ping. The handshake arms the timer, and
+ *   each ping arms it again. No other packet and no write moves it. At its end the client closes
+ *   the connection with the reason "ping timeout".
+ * - The close of the client is close() of ws: a close frame. The socket stays open below it until
+ *   the peer answers, or for the close timeout of ws (30 s).
+ * - Each close starts the reconnect of the Manager, when it is on. The wait of try n + 1 is
+ *   min(reconnectionDelay × 2^n, reconnectionDelayMax), with a jitter of ± randomizationFactor of
+ *   the backoff before its cap. An open sets n to 0, and so does each close of an open connection.
+ * - Each try has a time limit (`timeout` of the Manager).
+ * - A call with an acknowledgement has its own time limit, and the connection stays.
+ */
+export declare const SOCKETIO_CLIENT: Machine;
+/**
+ * This document is one connection as the Server of socket.io 4.8.4 on engine.io 6.6.11 holds it.
+ * The transport is WebSocket (ws 8.21.3), over its Linux TCP socket.
+ *
+ * - pingInterval after the handshake, or after the last pong, the server writes a ping. Then it
+ *   waits pingTimeout for the pong, and at its end it closes the connection: close() of ws, a close
+ *   frame. Thus the drop comes pingTimeout after the first ping without an answer.
+ * - In that wait, the first packet that is not a pong starts the wait again, once for each ping.
+ * - The http.Server of Node sets no SO_KEEPALIVE when keepAlive is off, its default.
+ */
+export declare const SOCKETIO_SERVER: Machine;
 /**
  * This function gives the lateness of a Node timer of `ms` milliseconds. The lateness is the slack
  * of its sleep, 1 ms for the truncation of the loop clock, and the step of the coarse clock. The
@@ -755,13 +705,9 @@ export declare const undiciFastEarly: (ms: string) => Expr;
  * of 499 ms (`lib/util/timers.js:190-207`), with the lateness of a Node timer.
  */
 export declare const undiciFastLateness: (ms: string) => Expr;
-//#endregion
-//#region src/index.d.ts
 /**
  * This map holds each document of the package by its identifier, for example `linux-tcp`. A
  * document on another machine names that machine in `over.machine` as `systems.machine.<id>`.
  */
 export declare const MACHINES: Readonly<Record<string, Machine>>;
-//#endregion
-export type { SidecarSide };
-//# sourceMappingURL=index.d.ts.map
+export type { SidecarSide };