mirror of
https://github.com/jwetzell/showbridge-docs.git
synced 2026-05-13 21:14:17 +00:00
move HTTP module to own section
This commit is contained in:
@@ -40,6 +40,11 @@ export default defineConfig({
|
|||||||
collapsed: true,
|
collapsed: true,
|
||||||
autogenerate: { directory: 'modules/network' }
|
autogenerate: { directory: 'modules/network' }
|
||||||
},
|
},
|
||||||
|
{
|
||||||
|
label: "HTTP",
|
||||||
|
collapsed: true,
|
||||||
|
autogenerate: { directory: 'modules/http' }
|
||||||
|
},
|
||||||
]
|
]
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
|
|||||||
+2
-2
@@ -5,11 +5,11 @@ sidebar:
|
|||||||
---
|
---
|
||||||
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**: `net.http.client`
|
- **type**: `http.client`
|
||||||
- **params**: no params are needed for HTTP client
|
- **params**: no params are needed for HTTP client
|
||||||
|
|
||||||
### Example
|
### Example
|
||||||
```
|
```
|
||||||
- id: httpSender1
|
- id: httpSender1
|
||||||
type: net.http.client
|
type: http.client
|
||||||
```
|
```
|
||||||
+2
-2
@@ -5,7 +5,7 @@ sidebar:
|
|||||||
---
|
---
|
||||||
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**: `net.http.server`
|
- **type**: `http.server`
|
||||||
- **params**:
|
- **params**:
|
||||||
- **port**: TCP port to listen for HTTP requests on
|
- **port**: TCP port to listen for HTTP requests on
|
||||||
|
|
||||||
@@ -13,7 +13,7 @@ The HTTP server module emits a message for every HTTP request that is made to th
|
|||||||
Start an HTTP server listening on port 3000
|
Start an HTTP server listening on port 3000
|
||||||
```
|
```
|
||||||
- id: httpServer
|
- id: httpServer
|
||||||
type: net.http.server
|
type: http.server
|
||||||
params:
|
params:
|
||||||
port: 3000
|
port: 3000
|
||||||
```
|
```
|
||||||
@@ -1,7 +1,7 @@
|
|||||||
---
|
---
|
||||||
title: TCP Client
|
title: TCP Client
|
||||||
sidebar:
|
sidebar:
|
||||||
order: 3
|
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 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.
|
||||||
|
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
---
|
---
|
||||||
title: TCP Server
|
title: TCP Server
|
||||||
sidebar:
|
sidebar:
|
||||||
order: 4
|
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 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.
|
||||||
|
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
---
|
---
|
||||||
title: UDP Client
|
title: UDP Client
|
||||||
sidebar:
|
sidebar:
|
||||||
order: 5
|
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 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.
|
||||||
|
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
---
|
---
|
||||||
title: UDP Server
|
title: UDP Server
|
||||||
sidebar:
|
sidebar:
|
||||||
order: 6
|
order: 4
|
||||||
---
|
---
|
||||||
The UDP server module emits a message for every incoming UDP datagram.
|
The UDP server module emits a message for every incoming UDP datagram.
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user