websocket

Documentation

Index

• Constants
• Variables
• func FilterHeader(header http.Header) http.Header
• func Send(ws *websocket.Conn, reader io.Reader, close <-chan struct{}) error
• func SendStream(server string, reader io.Reader, close <-chan struct{}) error
• func Write(ws *websocket.Conn, reader ReadBytes, stop <-chan struct{}, ...) error
• type ReadBytes

Constants

const (
	// WriteWait defines time allowed to write a message to the peer.
	WriteWait = 10 * time.Second

	// PongWait defines time allowed to read the next pong message from the peer.
	PongWait = 30 * time.Second

	// PingPeriod defines send pings to peer with this period. Must be less than pongWait.
	PingPeriod = (PongWait * 9) / 10
)

Variables

var Upgrader = socket.Upgrader{

	CheckOrigin:     func(r *http.Request) bool { return true },
	ReadBufferSize:  1024,
	WriteBufferSize: 1024,
}

Upgrader ...

Functions

func FilterHeader

func FilterHeader(header http.Header) http.Header

FilterHeader filters the headers for upgrading the HTTP server connection to the WebSocket protocol.

func Send

func Send(ws *websocket.Conn, reader io.Reader, close <-chan struct{}) error

Send sends stream from reader by websocket

func SendStream

func SendStream(server string, reader io.Reader, close <-chan struct{}) error

SendStream sends stream from reader to a remote websocket

func Write

func Write(ws *websocket.Conn, reader ReadBytes, stop <-chan struct{}, stopDelaySeconds time.Duration) error

Write writes message from reader to websocket

Types

type ReadBytes

type ReadBytes interface {
	ReadBytes(delim byte) ([]byte, error)
}

ReadBytes reads and returns a single byte. If no byte is available, returns an error.