websocket

Documentation

Index

• type DecodeIngressFunc
• type EncodeEgressFunc
• type RequestFunc
• type Server
  • func NewServer(e WebSocketEndpoint, dec DecodeIngressFunc, enc EncodeEgressFunc, ...) *Server
  • func (s Server) ServeHTTP(w http.ResponseWriter, r *http.Request)
• type ServerOption
  • func ServerBefore(before ...RequestFunc) ServerOption
  • func SetSocketConfig(socketConfig ...SocketConfigFunc) ServerOption
• type SocketConfigFunc
• type WebSocketEndpoint

Types

type DecodeIngressFunc

type DecodeIngressFunc func(context.Context, []byte) (request interface{}, err error)

Decode request on receiving.

type EncodeEgressFunc

type EncodeEgressFunc func(context.Context, interface{}) (response []byte, err error)

Encode response before sending.

type RequestFunc

type RequestFunc func(context.Context, *http.Request) context.Context

type Server

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

func NewServer

func NewServer(
	e WebSocketEndpoint,
	dec DecodeIngressFunc,
	enc EncodeEgressFunc,
	options ...ServerOption,
) *Server

func (Server) ServeHTTP

func (s Server) ServeHTTP(w http.ResponseWriter, r *http.Request)

type ServerOption

type ServerOption func(*Server)

func ServerBefore

func ServerBefore(before ...RequestFunc) ServerOption

func SetSocketConfig

func SetSocketConfig(socketConfig ...SocketConfigFunc) ServerOption

type SocketConfigFunc

type SocketConfigFunc func(context.Context, *websocket.Conn)

type WebSocketEndpoint

type WebSocketEndpoint func(ctx context.Context) (ingress chan interface{}, egress chan interface{}, err error)