Files
Chris Bono 7487dc8f61 Link to function catalog docs for config props (#526)
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
2024-03-28 10:44:08 -05:00

46 lines
1.0 KiB
Plaintext

//tag::ref-doc[]
= ZeroMQ Source
The "zeromq" source enables receiving messages from ZeroMQ.
== Input
N/A
== Output
=== Payload
* `byte[]`
== Options
The **$$zeromq$$** $$source$$ has the following options:
//tag::configuration-properties[link-to-catalog=true]
https://github.com/spring-cloud/spring-functions-catalog/tree/main/supplier/spring-zeromq-supplier#configuration-options[See Spring Functions Catalog for configuration options].
//end::configuration-properties[]
Also see the https://docs.spring.io/spring-boot/docs/current/reference/html/common-application-properties.html[Spring Boot Documentation]
for addition properties for the broker connections and listener properties.
== Build
```
$ ./mvnw clean install -PgenerateApps
$ cd apps
```
You can find the corresponding binder based projects here.
You can then cd into one of the folders and build it:
```
$ ./mvnw clean package
```
== Examples
```
java -jar zeromq-source.jar --zeromq.supplier.connectUrl=tcp://server:port --zeromq.supplier.topics=
```
//end::ref-doc[]