Files
spring-functions-catalog/consumer/spring-websocket-consumer
Artem Bilan 69dade53de Add channel to the WebsocketConsumerServerHandler.CHANNELS before handshake
In attempt to fix a race condition in the tests

* Remove `log4j` deps as redundant: Spring Boot brings them anyway for logback compatibility
* Add `logback-test.xml` to the `spring-websocket-consumer.test` for test race condition failures
2024-10-16 10:52:06 -04:00
..

= Websocket Consumer

A consumer that allows you to send messages using websocket.

== Beans for injection

The `WebsocketConsumerConfiguration` auto-configuration provides the following bean:

`Consumer<Message<?>> websocketConsumer`

You can use `websocketConsumer` as a qualifier when injecting.

== Configuration Options

All configuration properties are prefixed with `websocket.consumer`.

For more information on the various options available, please see link:src/main/java/org/springframework/cloud/fn/consumer/websocket/WebsocketConsumerProperties.java[WebsocketConsumerProperties].

== Tests

See this link:src/test/java/org/springframework/cloud/fn/consumer/websocket[test suite] for the various ways, this consumer is used.

== Other usage

See this https://github.com/spring-cloud/stream-applications/blob/master/applications/sink/websocket-sink/README.adoc[README] where this consumer is used to create a Spring Cloud Stream application where it makes a TCP sink.