websocketDialer

Documentation

Index

• Constants
• Variables
• func ClientConnect(ctx context.Context, wsURL string, headers http.Header, tlsConfig *tls.Config, ...)
• func DefaultErrorWriter(rw http.ResponseWriter, req *http.Request, code int, err error)
• type Authorizer
• type CleanCredentials
• type ConnectAuthorizer
• type Dialer
• type ErrorWriter
• type Server
  • func New(auth Authorizer, errorWriter ErrorWriter, clean CleanCredentials) *Server
  • func (s *Server) AddPeer(url, id, token string)
  • func (s *Server) Dial(clientKey string, deadline time.Duration, proto, address string) (net.Conn, error)
  • func (s *Server) Dialer(clientKey string, deadline time.Duration) Dialer
  • func (s *Server) HasSession(clientKey string) bool
  • func (s *Server) RemovePeer(id string)
  • func (s *Server) ServeHTTP(rw http.ResponseWriter, req *http.Request)
• type Session
  • func NewClientSession(auth ConnectAuthorizer, conn *websocket.Conn) *Session
  • func (s *Session) Close()
  • func (s *Session) Serve(ctx context.Context) (int, error)

Constants

const (
	Data messageType = iota + 1
	Connect
	Error
	AddClient
	RemoveClient
)

const (
	PingWaitDuration  = 60 * time.Second
	PingWriteInterval = 5 * time.Second
	MaxRead           = 8192
	HandshakeTimeOut  = 10 * time.Second
)

Variables

var (
	Token = "BCS-API-Tunnel-Token"
	ID    = "BCS-API-Tunnel-ID"
)

var PrintTunnelData bool

PrintTunnelData No tunnel logging by default

Functions

func ClientConnect

func ClientConnect(ctx context.Context, wsURL string, headers http.Header, tlsConfig *tls.Config, dialer *websocket.Dialer, auth ConnectAuthorizer)

func DefaultErrorWriter

func DefaultErrorWriter(rw http.ResponseWriter, req *http.Request, code int, err error)

Types

type Authorizer

type Authorizer func(req *http.Request) (clientKey string, authed bool, err error)

type CleanCredentials

type CleanCredentials func(clientKey string)

type ConnectAuthorizer

type ConnectAuthorizer func(proto, address string) bool

type Dialer

type Dialer func(network, address string) (net.Conn, error)

type ErrorWriter

type ErrorWriter func(rw http.ResponseWriter, req *http.Request, code int, err error)

type Server

type Server struct {
	PeerID    string
	PeerToken string
	// contains filtered or unexported fields
}

func New

func New(auth Authorizer, errorWriter ErrorWriter, clean CleanCredentials) *Server

func (*Server) AddPeer

func (s *Server) AddPeer(url, id, token string)

func (*Server) Dial

func (s *Server) Dial(clientKey string, deadline time.Duration, proto, address string) (net.Conn, error)

func (*Server) Dialer

func (s *Server) Dialer(clientKey string, deadline time.Duration) Dialer

func (*Server) HasSession

func (s *Server) HasSession(clientKey string) bool

func (*Server) RemovePeer

func (s *Server) RemovePeer(id string)

func (*Server) ServeHTTP

func (s *Server) ServeHTTP(rw http.ResponseWriter, req *http.Request)

type Session

type Session struct {
	sync.Mutex
	// contains filtered or unexported fields
}

func NewClientSession

func NewClientSession(auth ConnectAuthorizer, conn *websocket.Conn) *Session

func (*Session) Close

func (s *Session) Close()

func (*Session) Serve

func (s *Session) Serve(ctx context.Context) (int, error)