Overview

The Websocket Proxy Plugin connects remote plugins to Thymian via WebSockets. This allows plugins to be implemented in any programming language, as long as it supports communication via WebSockets. Thereby, the Websocket Proxy Plugin provides an interface similar to the ThymianEmitter for remote plugins. If you just want to connect a plugin via Websockets, see here. If you want to implement a remote plugin using Websockets, see here.

The idea of the Websocket Proxy Plugin

The basic idea of this plugin is to provide an interface for plugins running in a separate process to communicate with Thymian. Therefore the plugin acts as a proxy between the two. It simply listens to every event and actions and forwards them to the remote plugins. The logic for doing this via WebSockets is completely implemented in the proxy plugin. The core will never know whether an event comes from or goes to a local or remote plugin.

sequenceDiagram
  participant Local Plugin
  participant Core
  participant Websocket Proxy Plugin
  participant Remote Plugin

  Local Plugin->>+Core: Action A
  Core->>+Websocket Proxy Plugin: Action A
  rect rgb(255, 0, 0)
  Note over Websocket Proxy Plugin,Remote Plugin: Via the Websocket protocol
  Websocket Proxy Plugin->>+Remote Plugin: Action A
  Remote Plugin-->>-Websocket Proxy Plugin: Response to Action A
  end
  Websocket Proxy Plugin-->>-Core: Response to Action A
  Core-->>- Local Plugin: Response to Action A