websocket

README

WEBSOCKET

Send event received over a ws connection to connected clients

Synopsys

SETTING	TYPE	REQUIRED	DEFAULT VALUE
Codec	codec	false	"json"
Uri	string	false	"wsout"

Details

Codec

• Value type is codec
• Default value is "json"

The codec used for outputed data.

Uri

• Value type is string
• Default value is "wsout"

URI path

Configuration blueprint

websocket{
	codec => "json"
	uri => "wsout"
}

Documentation

Overview

Code generated by "bitfanDoc "; DO NOT EDIT

Send event received over a ws connection to connected clients

Index

• func New() processors.Processor
• type Client
• type Hub

Functions

func New

func New() processors.Processor

expose events thought a websocket

Types

type Client

type Client struct {
	// contains filtered or unexported fields
}

Client is a middleman between the websocket connection and the hub.

type Hub

type Hub struct {

	// Inbound messages from the clients.
	Broadcast chan []byte

	Wellcome func() [][]byte
	// contains filtered or unexported fields
}

hub maintains the set of active clients and Broadcasts messages to the clients.