ws

Documentation

Index

• Variables
• func ClientIp(r *http.Request) string
• func Handler(ctx context.Context, origin bool, heartbeatInterval int64, ...) func(w http.ResponseWriter, r *http.Request)
• type Connection
  • func NewConnection(ctx context.Context, conn *websocket.Conn, realIP string, ...) *Connection
  • func (c *Connection) Close()
  • func (c *Connection) HeartbeatChecker()
  • func (c *Connection) IsAlive() bool
  • func (c *Connection) KeepAlive()
  • func (c *Connection) ReadMessage() ([]byte, error)
  • func (c *Connection) RemoteAddr() net.Addr
  • func (c *Connection) RemoteRealIP() string
  • func (c *Connection) WriteMessage(data []byte) error

Variables

var (
	ErrConnectionClosed = errors.New("connection is closed")
	ErrClientConnClosed = errors.New("client connection is closed")
)

Functions

func ClientIp

func ClientIp(r *http.Request) string

func Handler

func Handler(ctx context.Context, origin bool, heartbeatInterval int64, receive func(*Connection)) func(w http.ResponseWriter, r *http.Request)

Types

type Connection

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

func NewConnection

func NewConnection(ctx context.Context, conn *websocket.Conn, realIP string, heartbeatInterval int64) *Connection

func (*Connection) Close

func (c *Connection) Close()

func (*Connection) HeartbeatChecker

func (c *Connection) HeartbeatChecker()

func (*Connection) IsAlive

func (c *Connection) IsAlive() bool

func (*Connection) KeepAlive

func (c *Connection) KeepAlive()

func (*Connection) ReadMessage

func (c *Connection) ReadMessage() ([]byte, error)

func (*Connection) RemoteAddr

func (c *Connection) RemoteAddr() net.Addr

func (*Connection) RemoteRealIP

func (c *Connection) RemoteRealIP() string

func (*Connection) WriteMessage

func (c *Connection) WriteMessage(data []byte) error