Websocket

The websocket producer opens up a websocket.

Parameters

Enable (default: true)

Switches this plugin on or off.

Address (default: :81)

This value defines the host and port to bind to. This is allowed be any ip address/dns and port like “localhost:5880”. By default this parameter is set to “:81”.

Path (default: /)

This value defines the url path to listen for. By default this parameter is set to “/”

ReadTimeoutSec (default: 3, unit: sec)

This value specifies the maximum duration in seconds before timing out read of the request. By default this parameter is set to “3” seconds.

IgnoreOrigin (default: false)

Ignore origin check from websocket server. By default this parameter is set to “false”.

Parameters (from core.BufferedProducer)

Channel

This value defines the capacity of the message buffer. By default this parameter is set to “8192”.

ChannelTimeoutMs (default: 0, unit: ms)

This value defines a timeout for each message before the message will discarded. To disable the timeout, set this parameter to 0. By default this parameter is set to “0”.

Parameters (from core.SimpleProducer)

Streams

Defines a list of streams the producer will receive from. This parameter is mandatory. Specifying “*” causes the producer to receive messages from all streams except internal internal ones (e.g. _GOLLUM_). By default this parameter is set to an empty list.

FallbackStream

Defines a stream to route messages to if delivery fails. The message is reset to its original state before being routed, i.e. all modifications done to the message after leaving the consumer are removed. Setting this paramater to “” will cause messages to be discared when delivery fails.

ShutdownTimeoutMs (default: 1000, unit: ms)

Defines the maximum time in milliseconds a producer is allowed to take to shut down. After this timeout the producer is always considered to have shut down. Decreasing this value may lead to lost messages during shutdown. Raising it may increase shutdown time.

Modulators

Defines a list of modulators to be applied to a message when it arrives at this producer. If a modulator changes the stream of a message the message is NOT routed to this stream anymore. By default this parameter is set to an empty list.

Examples

This example starts a default Websocket producer on port 8080:

WebsocketOut:
  Type: producer.Websocket
  Address: ":8080"