Files
showbridge-docs/src/content/docs/modules/network/tcp-client.md
T
2025-12-11 19:37:45 -06:00

877 B

title, sidebar
title sidebar
TCP Client
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.

  • 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

Example

Open a TCP connection to 127.0.0.1 port 8888, any incoming data will be split on line-feed (\n)

- id: tcpClient
  type: net.tcp.client
  params:
    host: 127.0.0.1
    port: 8888
    framing: LF