wsp

Documentation

Index

• type Config
• type Connection
  • func NewConnection(pool *Pool, ws *websocket.Conn) *Connection
  • func (c *Connection) Close()
  • func (c *Connection) Release()
  • func (c *Connection) Take() bool
  • func (c *Connection) WritePump()
• type ConnectionStatus
• type Message
• type Pool
  • func NewPool(timeout, idleTimeout time.Duration, id PoolID) *Pool
  • func (p *Pool) Clean()
  • func (p *Pool) GetIdleConnection(ctx context.Context) (conn *Connection)
  • func (p *Pool) IsEmpty() bool
  • func (p *Pool) Offer(connection *Connection)
  • func (p *Pool) RegisterConnection(ws *websocket.Conn)
  • func (p *Pool) SetSize(size int)
  • func (p *Pool) Shutdown()
  • func (p *Pool) Size() (ps *PoolSize)
• type PoolID
• type PoolSize
• type Pools
  • func NewPools(timeout, idleTimeout time.Duration) *Pools
  • func (p *Pools) Clean()
  • func (p *Pools) GetPool(id PoolID) (pool *Pool, ok bool)
  • func (p *Pools) IsEmpty() bool
  • func (p *Pools) MoreThenOne() bool
  • func (p *Pools) RegisterConnection(ws *websocket.Conn) (err error)
  • func (p *Pools) Shutdown()
• type Server
  • func NewServer(config *Config) (server *Server)
  • func (s *Server) GetServerID(r *http.Request) (serverID string, err error)
  • func (s *Server) Register(w http.ResponseWriter, r *http.Request)
  • func (s *Server) Request(w http.ResponseWriter, r *http.Request)
  • func (s *Server) Shutdown()
  • func (s *Server) Start()
  • func (s *Server) Ws(w http.ResponseWriter, r *http.Request)

Types

type Config

type Config struct {
	Timeout     time.Duration
	IdleTimeout time.Duration
	SecretKey   string
}

type Connection

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

Connection manages a single websocket connection from the peer. wsp supports multiple connections from a single peer at the same time.

func NewConnection

func NewConnection(pool *Pool, ws *websocket.Conn) *Connection

NewConnection returns a new Connection.

func (*Connection) Close

func (c *Connection) Close()

Close the connection

func (*Connection) Release

func (c *Connection) Release()

Release notifies that this connection is ready to use again

func (*Connection) Take

func (c *Connection) Take() bool

Take notifies that this connection is going to be used

func (*Connection) WritePump

func (c *Connection) WritePump()

type ConnectionStatus

type ConnectionStatus int

ConnectionStatus is an enumeration type which represents the status of WebSocket connection.

const (
	// Idle state means it is opened but not working now.
	// The default value for Connection is Idle, so it is ok to use zero-value(int: 0) for Idle status.
	Idle ConnectionStatus = iota
	Busy
	Closed
)

type Message

type Message struct {
	Type  int
	Value []byte
}

type Pool

type Pool struct {
	sync.RWMutex
	// contains filtered or unexported fields
}

Pool handles all connections from the peer.

func NewPool

func NewPool(timeout, idleTimeout time.Duration, id PoolID) *Pool

NewPool creates a new Pool

func (*Pool) Clean

func (p *Pool) Clean()

func (*Pool) GetIdleConnection

func (p *Pool) GetIdleConnection(ctx context.Context) (conn *Connection)

func (*Pool) IsEmpty

func (p *Pool) IsEmpty() bool

IsEmpty clean the pool and return true if the pool is empty

func (*Pool) Offer

func (p *Pool) Offer(connection *Connection)

func (*Pool) RegisterConnection

func (p *Pool) RegisterConnection(ws *websocket.Conn)

RegisterConnection creates a new Connection and adds it to the pool

func (*Pool) SetSize

func (p *Pool) SetSize(size int)

func (*Pool) Shutdown

func (p *Pool) Shutdown()

Shutdown closes every connections in the pool and cleans it

func (*Pool) Size

func (p *Pool) Size() (ps *PoolSize)

Size return the number of connection in each state in the pool

type PoolID

type PoolID string

PoolID represents the identifier of the connected WebSocket client.

type PoolSize

type PoolSize struct {
	Idle   int
	Busy   int
	Closed int
}

PoolSize is the number of connection in each state in the pool

type Pools

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

func NewPools

func NewPools(timeout, idleTimeout time.Duration) *Pools

func (*Pools) Clean

func (p *Pools) Clean()

func (*Pools) GetPool

func (p *Pools) GetPool(id PoolID) (pool *Pool, ok bool)

func (*Pools) IsEmpty

func (p *Pools) IsEmpty() bool

func (*Pools) MoreThenOne

func (p *Pools) MoreThenOne() bool

func (*Pools) RegisterConnection

func (p *Pools) RegisterConnection(ws *websocket.Conn) (err error)

func (*Pools) Shutdown

func (p *Pools) Shutdown()

type Server

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

Server is a Reverse HTTP Proxy over WebSocket This is the Server part, Clients will offer websocket connections, those will be pooled to transfer HTTP Request and response

func NewServer

func NewServer(config *Config) (server *Server)

func (*Server) GetServerID

func (s *Server) GetServerID(r *http.Request) (serverID string, err error)

func (*Server) Register

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

Request receives the WebSocket upgrade handshake request from wsp_client.

func (*Server) Request

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

func (*Server) Shutdown

func (s *Server) Shutdown()

Shutdown stop the Server

func (*Server) Start

func (s *Server) Start()

Start Server HTTP server

func (*Server) Ws

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