tcp Binding

Zilla runtime tcp binding.

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

Summary

Defines a binding with tcp protocol support, with server or client behavior.

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

The client kind tcp binding receives inbound application streams and initiates outbound tcp network connections to a remote tcp server address.

Conditional routes based on the hostname authority and network address mask are used to route these streams to an exit binding.

Configuration

Properties

• kind*
• options
• options.host
• options.port
• exit
• routes
• routes[].guarded
• routes[].when
  • when[].authority
  • when[].cidr
  • when[].port
• routes[].exit*

* required

kind*

enum [ "client", "server" ]

Behave as a tcp client or server.

options

object

tcp-specific options.

options:
  host: 0.0.0.0
  port: 12345

options.host

string

Hostname or IP address.

options.port

integer | string | array of integer | array of string

Port number(s), including port number ranges.

exit

string

Default exit binding when no conditional routes are viable, for kind server only.

exit: echo_server

routes

array of object

Conditional tcp-specific routes.

routes[].guarded

object as named map of string:string array

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

CIDR mask.

when[].port

integer | string | array of integer | array of string

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

---

* required