From 2278015eb662c235aa223838f947abd6ab9214b8 Mon Sep 17 00:00:00 2001 From: Joel Wetzell Date: Fri, 19 Dec 2025 12:10:21 -0600 Subject: [PATCH] cleanup --- src/content/docs/modules/generator/interval.md | 2 +- src/content/docs/modules/generator/timer.md | 2 +- src/content/docs/modules/http/http-client.md | 2 +- src/content/docs/modules/http/http-server.md | 2 +- src/content/docs/modules/network/tcp-client.md | 4 +++- src/content/docs/modules/network/tcp-server.md | 4 +++- src/content/docs/modules/network/udp-client.md | 2 +- src/content/docs/modules/network/udp-server.md | 2 +- 8 files changed, 12 insertions(+), 8 deletions(-) diff --git a/src/content/docs/modules/generator/interval.md b/src/content/docs/modules/generator/interval.md index 35e2ad3..6f3b64e 100644 --- a/src/content/docs/modules/generator/interval.md +++ b/src/content/docs/modules/generator/interval.md @@ -3,7 +3,7 @@ title: Interval sidebar: order: 2 --- -The interval module emits a message at a specified duration +The `gen.interval` module emits a message at a specified duration - **type**: `gen.interval` - **params**: diff --git a/src/content/docs/modules/generator/timer.md b/src/content/docs/modules/generator/timer.md index 3a25d4d..2b2ee3e 100644 --- a/src/content/docs/modules/generator/timer.md +++ b/src/content/docs/modules/generator/timer.md @@ -3,7 +3,7 @@ title: Timer sidebar: order: 1 --- -The timer module emits only one message after a specified duration +The `gen.timer` module emits only one message after a specified duration. Output to this module currently does nothing. - **type**: `gen.timer` - **params**: diff --git a/src/content/docs/modules/http/http-client.md b/src/content/docs/modules/http/http-client.md index c50b258..de1538e 100644 --- a/src/content/docs/modules/http/http-client.md +++ b/src/content/docs/modules/http/http-client.md @@ -3,7 +3,7 @@ title: HTTP Client sidebar: order: 1 --- -The HTTP Client module emits a message contianing the response of the HTTP calls it makes. +The `http.client` module emits a message contianing the response of the HTTP calls it makes. - **type**: `http.client` - **params**: no params are needed for HTTP client diff --git a/src/content/docs/modules/http/http-server.md b/src/content/docs/modules/http/http-server.md index 0b96d6d..47a7f6c 100644 --- a/src/content/docs/modules/http/http-server.md +++ b/src/content/docs/modules/http/http-server.md @@ -3,7 +3,7 @@ title: HTTP Server sidebar: order: 2 --- -The HTTP server module emits a message for every HTTP request that is made to the server +The `http.server` module emits a message for every HTTP request that is made to the server - **type**: `http.server` - **params**: diff --git a/src/content/docs/modules/network/tcp-client.md b/src/content/docs/modules/network/tcp-client.md index 7db1040..08a0fb6 100644 --- a/src/content/docs/modules/network/tcp-client.md +++ b/src/content/docs/modules/network/tcp-client.md @@ -3,7 +3,7 @@ title: TCP Client sidebar: order: 1 --- -The TCP client module connects to TCP server and emits a message for every message it receives from the server that it connects to. Messages are determined by "framing" techniques as TCP is a stream based protocol. The module will attempt to reconnect anytime the connection is closed. +The `net.tcp.client` module connects to TCP server and emits messages based on the data it receives from the server that it connects to. Messages are determined by "framing" techniques as TCP is a stream based protocol. The module will attempt to reconnect anytime the connection is closed. - **type**: `net.tcp.client` - **params**: @@ -14,6 +14,8 @@ The TCP client module connects to TCP server and emits a message for every messa - CR `\r` - CRLF `\r\n` - [SLIP](https://en.wikipedia.org/wiki/Serial_Line_Internet_Protocol) + - RAW (no framing is done bytes are sent out as they are received) + ### Example Open a TCP connection to `127.0.0.1` port 8888, any incoming data will be split on line-feed (`\n`) diff --git a/src/content/docs/modules/network/tcp-server.md b/src/content/docs/modules/network/tcp-server.md index 3c652f8..9250120 100644 --- a/src/content/docs/modules/network/tcp-server.md +++ b/src/content/docs/modules/network/tcp-server.md @@ -3,7 +3,7 @@ title: TCP Server sidebar: order: 2 --- -The TCP server module emits a message for every message it receives from clients that connect to it. Messages are determined by "framing" techniques as TCP is a stream based protocol. +The `net.tcp.server` module emits a message messages based on the data it receives from clients that connect to it. Messages are determined by "framing" techniques as TCP is a stream based protocol. - **type**: `net.tcp.server` - **params**: @@ -14,6 +14,8 @@ The TCP server module emits a message for every message it receives from clients - CR `\r` - CRLF `\r\n` - [SLIP](https://en.wikipedia.org/wiki/Serial_Line_Internet_Protocol) + - RAW (no framing is done bytes are sent out as they are received) + ### Example Start a TCP server listening on port 8888, incoming data will be split on line-feed (`\n`) diff --git a/src/content/docs/modules/network/udp-client.md b/src/content/docs/modules/network/udp-client.md index 10c59be..237f873 100644 --- a/src/content/docs/modules/network/udp-client.md +++ b/src/content/docs/modules/network/udp-client.md @@ -3,7 +3,7 @@ title: UDP Client sidebar: order: 3 --- -The UDP client module sends messages to a the configured `host` and `port`. This module does not receive any message and so using it as an `input` to a [route](/concepts/routes) would be pointless. +The `net.udp.client` module sends messages to a the configured `host` and `port`. This module does not receive any message and so using it as an `input` to a [route](/concepts/routes) would be pointless. - **type**: `net.udp.client` - **params**: diff --git a/src/content/docs/modules/network/udp-server.md b/src/content/docs/modules/network/udp-server.md index 2bbc8f3..224ac35 100644 --- a/src/content/docs/modules/network/udp-server.md +++ b/src/content/docs/modules/network/udp-server.md @@ -3,7 +3,7 @@ title: UDP Server sidebar: order: 4 --- -The UDP server module emits a message for every incoming UDP datagram. +The `net.udp.server` module emits a message for every incoming UDP datagram. - **type**: `net.udp.server` - **params**: