tcp server

The tcp server binding listens for inbound socket connections, producing higher level application streams for each remote TCP client.

tcp_server:
  type: tcp
  kind: server
  exit: echo_server
  options:
    host: 0.0.0.0
    port: 12345

Configuration (* required)

options

object

The tcp specific options.

options:
  host: 0.0.0.0
  port: 12345

options.host

string

Hostname or IP address.

options.port

integer, string, array

Port number(s), including port number ranges with the pattern: ^\\d+(-\\d+)?$.

options:
  port: 12345

options:
  port:
    - 12345
    - "54320-54330"

routes

array of object

Conditional tcp specific routes.

routes[].guarded

object as map of named array of string

List of roles required by each named guard to authorize this route.

routes[].when

array of object

List of conditions (any match) to match this route. Read more: When a route matches

when[].authority

string

Associated authority.

when[].cidr

string | Pattern: ^[0-9a-fA-F:.]+/(\\d{1,3})$

CIDR mask.

when[].port

integer, string, array

Port number(s), including port number ranges.

routes[].exit

string

Next binding when following this route, for kind server only.

routes:
  - when:
    ...
    exit: echo_server

exit

string

Default exit binding when no conditional routes are viable.

exit: echo_server

telemetry

object

Defines the desired telemetry for the binding.

telemetry.metrics

array

Telemetry metrics to track

telemetry:
  metrics:
    - stream.*