mirror of
https://github.com/jwetzell/showbridge-docs.git
synced 2026-08-16 10:43:32 +00:00
work on auto-generating parts of docs from JSONSchema
This commit is contained in:
@@ -4,19 +4,11 @@ sidebar:
|
||||
label: Client
|
||||
order: 1
|
||||
---
|
||||
import SchemaInfo from '../../../../../components/SchemaInfo.astro';
|
||||
|
||||
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**:
|
||||
- **host**: IP or FQDN to connect to
|
||||
- **port**: TCP port to connect to
|
||||
- **framing**: how to chunk the TCP stream into "messages"
|
||||
- LF `\n`
|
||||
- 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)
|
||||
<SchemaInfo type="module" id="net.tcp.client"></SchemaInfo>
|
||||
|
||||
### Example
|
||||
|
||||
|
||||
Reference in New Issue
Block a user