7487dc8f61
Prior to this commit, each app documented its available config props in its README.adoc. Now that the functions have been moved to the function catalog, these inline docs are replaced w/ a link to the respective function catalog docs. See #524
33 lines
1.3 KiB
Plaintext
33 lines
1.3 KiB
Plaintext
//tag::ref-doc[]
|
|
= TCP
|
|
The `tcp` source acts as a server and allows a remote party to connect to it and submit data over a raw tcp socket.
|
|
|
|
TCP is a streaming protocol and some mechanism is needed to frame messages on the wire. A number of decoders are
|
|
available, the default being 'CRLF' which is compatible with Telnet.
|
|
|
|
Messages produced by the TCP source application have a `byte[]` payload.
|
|
|
|
== Options
|
|
|
|
//tag::configuration-properties[link-to-catalog=true]
|
|
https://github.com/spring-cloud/spring-functions-catalog/tree/main/supplier/spring-tcp-supplier#configuration-options[See Spring Functions Catalog for configuration options].
|
|
//end::configuration-properties[]
|
|
|
|
== Available Decoders
|
|
|
|
.Text Data
|
|
|
|
CRLF (default):: text terminated by carriage return (0x0d) followed by line feed (0x0a)
|
|
LF:: text terminated by line feed (0x0a)
|
|
NULL:: text terminated by a null byte (0x00)
|
|
STXETX:: text preceded by an STX (0x02) and terminated by an ETX (0x03)
|
|
|
|
.Text and Binary Data
|
|
|
|
RAW:: no structure - the client indicates a complete message by closing the socket
|
|
L1:: data preceded by a one byte (unsigned) length field (supports up to 255 bytes)
|
|
L2:: data preceded by a two byte (unsigned) length field (up to 2^16^-1 bytes)
|
|
L4:: data preceded by a four byte (signed) length field (up to 2^31^-1 bytes)
|
|
|
|
//end::ref-doc[]
|