mirror of
https://github.com/jwetzell/showbridge-docs.git
synced 2026-05-13 21:14:17 +00:00
cleanup
This commit is contained in:
@@ -3,7 +3,7 @@ title: Interval
|
|||||||
sidebar:
|
sidebar:
|
||||||
order: 2
|
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`
|
- **type**: `gen.interval`
|
||||||
- **params**:
|
- **params**:
|
||||||
|
|||||||
@@ -3,7 +3,7 @@ title: Timer
|
|||||||
sidebar:
|
sidebar:
|
||||||
order: 1
|
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`
|
- **type**: `gen.timer`
|
||||||
- **params**:
|
- **params**:
|
||||||
|
|||||||
@@ -3,7 +3,7 @@ title: HTTP Client
|
|||||||
sidebar:
|
sidebar:
|
||||||
order: 1
|
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`
|
- **type**: `http.client`
|
||||||
- **params**: no params are needed for HTTP client
|
- **params**: no params are needed for HTTP client
|
||||||
|
|||||||
@@ -3,7 +3,7 @@ title: HTTP Server
|
|||||||
sidebar:
|
sidebar:
|
||||||
order: 2
|
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`
|
- **type**: `http.server`
|
||||||
- **params**:
|
- **params**:
|
||||||
|
|||||||
@@ -3,7 +3,7 @@ title: TCP Client
|
|||||||
sidebar:
|
sidebar:
|
||||||
order: 1
|
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`
|
- **type**: `net.tcp.client`
|
||||||
- **params**:
|
- **params**:
|
||||||
@@ -14,6 +14,8 @@ The TCP client module connects to TCP server and emits a message for every messa
|
|||||||
- CR `\r`
|
- CR `\r`
|
||||||
- CRLF `\r\n`
|
- CRLF `\r\n`
|
||||||
- [SLIP](https://en.wikipedia.org/wiki/Serial_Line_Internet_Protocol)
|
- [SLIP](https://en.wikipedia.org/wiki/Serial_Line_Internet_Protocol)
|
||||||
|
- RAW (no framing is done bytes are sent out as they are received)
|
||||||
|
|
||||||
|
|
||||||
### Example
|
### Example
|
||||||
Open a TCP connection to `127.0.0.1` port 8888, any incoming data will be split on line-feed (`\n`)
|
Open a TCP connection to `127.0.0.1` port 8888, any incoming data will be split on line-feed (`\n`)
|
||||||
|
|||||||
@@ -3,7 +3,7 @@ title: TCP Server
|
|||||||
sidebar:
|
sidebar:
|
||||||
order: 2
|
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`
|
- **type**: `net.tcp.server`
|
||||||
- **params**:
|
- **params**:
|
||||||
@@ -14,6 +14,8 @@ The TCP server module emits a message for every message it receives from clients
|
|||||||
- CR `\r`
|
- CR `\r`
|
||||||
- CRLF `\r\n`
|
- CRLF `\r\n`
|
||||||
- [SLIP](https://en.wikipedia.org/wiki/Serial_Line_Internet_Protocol)
|
- [SLIP](https://en.wikipedia.org/wiki/Serial_Line_Internet_Protocol)
|
||||||
|
- RAW (no framing is done bytes are sent out as they are received)
|
||||||
|
|
||||||
|
|
||||||
### Example
|
### Example
|
||||||
Start a TCP server listening on port 8888, incoming data will be split on line-feed (`\n`)
|
Start a TCP server listening on port 8888, incoming data will be split on line-feed (`\n`)
|
||||||
|
|||||||
@@ -3,7 +3,7 @@ title: UDP Client
|
|||||||
sidebar:
|
sidebar:
|
||||||
order: 3
|
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`
|
- **type**: `net.udp.client`
|
||||||
- **params**:
|
- **params**:
|
||||||
|
|||||||
@@ -3,7 +3,7 @@ title: UDP Server
|
|||||||
sidebar:
|
sidebar:
|
||||||
order: 4
|
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`
|
- **type**: `net.udp.server`
|
||||||
- **params**:
|
- **params**:
|
||||||
|
|||||||
Reference in New Issue
Block a user