websocket

Documentation

Index

• type Handler
• type Websocket
  • func New() *Websocket
  • func (ws *Websocket) Open(ctx context.Context, w http.ResponseWriter, r *http.Request, handler Handler) error

Types

type Handler

type Handler interface {
	// Handler start
	Connect() error

	// Handler closure
	Close()

	// An incoming message sink
	Incoming([]byte) error

	// A channel for outgoing messages
	Outgoing() (<-chan []byte, error)

	// Basically a passthru to outer ctx.Done()
	Done() <-chan struct{}
}

type Websocket

type Websocket struct {
	// the websocket connection
	*websocket.Conn
	// contains filtered or unexported fields
}

func New

func New() *Websocket

func (*Websocket) Open

func (ws *Websocket) Open(ctx context.Context, w http.ResponseWriter, r *http.Request, handler Handler) error