diff options
Diffstat (limited to 'plugins/websockets/doc/doc.go')
| -rw-r--r-- | plugins/websockets/doc/doc.go | 27 |
1 files changed, 0 insertions, 27 deletions
diff --git a/plugins/websockets/doc/doc.go b/plugins/websockets/doc/doc.go deleted file mode 100644 index fc214be8..00000000 --- a/plugins/websockets/doc/doc.go +++ /dev/null @@ -1,27 +0,0 @@ -package doc - -/* -RPC message structure: - -type Msg struct { - // Topic message been pushed into. - Topics_ []string `json:"topic"` - - // Command (join, leave, headers) - Command_ string `json:"command"` - - // Broker (redis, memory) - Broker_ string `json:"broker"` - - // Payload to be broadcasted - Payload_ []byte `json:"payload"` -} - -1. Topics - string array (slice) with topics to join or leave -2. Command - string, command to apply on the provided topics -3. Broker - string, pub-sub broker to use, for the one-node systems might be used `memory` broker or `redis`. For the multi-node - -`redis` broker should be used. -4. Payload - raw byte array to send to the subscribers (binary messages). - - -*/ |