websocket_server

package

Go to main page

Versions in this module

v0

v0.0.10

Feb 17, 2024

v0.0.9

Jan 14, 2024

v0.0.8

Nov 1, 2023

Changes in this version

type Client

+ GetMeta func() *Metadata

v0.0.7

Oct 4, 2023

v0.0.6

Oct 4, 2023

v0.0.5

Oct 4, 2023

v0.0.4

Oct 3, 2023

Changes in this version

type Adapter

+ Register func(method string, fn RPCFunc) error

+ Unregister func(method string)

type Endpoint

+ func (ep *Endpoint) GetAdapter() Adapter

type WebSocketServer

+ func (wss *WebSocketServer) GetEndpoint(uri string) *Endpoint

v0.0.3

Oct 3, 2023

v0.0.2

Oct 1, 2023

v0.0.1

Oct 1, 2023

Changes in this version

+ const ErrorCode_InternalError

+ const ErrorCode_InvalidParams

+ const ErrorCode_InvalidParams_Insufficient_Arguments

+ const ErrorCode_InvalidParams_Invalid_Arguments

+ const ErrorCode_InvalidRequest

+ const ErrorCode_NotFound

+ const ErrorCode_NotFound_No_Such_Method

+ const ErrorCode_NotFound_No_Such_Service

+ const ErrorCode_ServerError

+ const RequestQueueSize

+ var ErrAdapterNotImplemented = errors.New("adapter: not implemented")

+ var ErrBackendNotImplemented = errors.New("backend: not implemented")

+ var ErrConnectionClosed = errors.New("client: conn closed")

+ var ErrMethodNotFound = errors.New("rpc: method not found")

+ func Module(scope string) fx.Option

+ type Adapter interface

+ HandleMessage func(Client) error

+ PrepareNotification func(eventName string, payload []byte) ([]byte, error)

+ PrepareResponse func(*RPCResponse) ([]byte, error)

+ func NewAdapter() Adapter

+ type Backend interface

+ ParseRequest func(r io.Reader) (*RPCRequest, error)

+ PrepareNotification func(eventName string, payload interface{}) ([]byte, error)

+ PrepareResponse func(*RPCResponse) ([]byte, error)

+ func NewBackend() Backend

+ type Client interface

+ Close func()

+ CreateRunner func(func(*Runner)) *Runner

+ GetClientID func() uuid.UUID

+ GetConnection func() net.Conn

+ GetOptions func() *Options

+ GetReader func() io.Reader

+ Notify func(eventName string, payload []byte) error

+ Release func()

+ Respond func(res *RPCResponse) error

+ Resume func() error

+ Send func(data []byte) error

+ func NewClient(options *Options, conn net.Conn) Client

+ type ClientManager struct

+ func NewClientManager() *ClientManager

+ func (clientMgr *ClientManager) Close()

+ func (clientMgr *ClientManager) Register(c Client)

+ func (clientMgr *ClientManager) Run()

+ func (clientMgr *ClientManager) Unregister(c Client)

+ type Context struct

+ func NewContext(client Client, req *RPCRequest) *Context

+ func (ctx *Context) Error(code RPCErrorCode, data string) error

+ func (ctx *Context) GetClient() Client

+ func (ctx *Context) GetMeta() *Metadata

+ func (ctx *Context) GetReader() io.Reader

+ func (ctx *Context) GetRequest() *RPCRequest

+ func (ctx *Context) Notify(eventName string, payload []byte) error

+ func (ctx *Context) Respond(res *RPCResponse) error

+ func (ctx *Context) Send(data []byte) error

+ type Endpoint struct

+ func NewEndpoint(uri string, options *Options) *Endpoint

+ func (ep *Endpoint) Establish(c *gin.Context)

+ func (ep *Endpoint) GetUri() string

+ type Metadata struct

+ func NewMetadata() *Metadata

+ func (md *Metadata) Delete(key string)

+ func (md *Metadata) Get(key string) interface{}

+ func (md *Metadata) GetInt(key string) int

+ func (md *Metadata) GetString(key string) string

+ func (md *Metadata) Set(key string, value interface{})

+ type Options struct

+ Adapter Adapter

+ MaxClients int

+ OnConnected func(Client) error

+ OnDisconnected func(Client) error

+ OnMessage func(Client) error

+ func NewOptions() *Options

+ type Packet struct

+ Length int

+ Payload []byte

+ type Params struct

+ HTTPServer *http_server.HTTPServer

+ Lifecycle fx.Lifecycle

+ Logger *zap.Logger

+ type PollerPool struct

+ func NewPollerPool() *PollerPool

+ func (pp *PollerPool) Add(c Client) error

+ func (pp *PollerPool) Remove(c Client) error

+ func (pp *PollerPool) Wait(fn func([]Client))

+ type RPCAdapter struct

+ func NewRPCAdapter(opts ...RPCAdapterOpt) *RPCAdapter

+ func (ra *RPCAdapter) HandleMessage(c Client) error

+ func (ra *RPCAdapter) PrepareNotification(eventName string, payload []byte) ([]byte, error)

+ func (ra *RPCAdapter) PrepareResponse(res *RPCResponse) ([]byte, error)

+ func (ra *RPCAdapter) Register(method string, fn RPCFunc) error

+ func (ra *RPCAdapter) Unregister(method string)

+ type RPCAdapterOpt func(*RPCAdapter)

+ func WithRPCBackend(b Backend) RPCAdapterOpt

+ type RPCError struct

+ Code RPCErrorCode

+ Data interface{}

+ Message string

+ func NewError(code RPCErrorCode, data interface{}) *RPCError

+ func (e *RPCError) Error() string

+ type RPCErrorCode int32

+ type RPCFunc func(*Context) (interface{}, error)

+ type RPCRequest struct

+ ID int64

+ Method string

+ Params interface{}

+ type RPCResponse struct

+ Error error

+ ID int64

+ Result interface{}

+ type RequestHandler func(*Context) error

+ type RequestQueue struct

+ func NewRequestQueue() *RequestQueue

+ func (rq *RequestQueue) Consume(fn RequestHandler) error

+ func (rq *RequestQueue) Push(c *Context)

+ type RequestTask struct

+ Ctx *Context

+ type Runner struct

+ IsRunning bool

+ func NewRunner(fn RunnerFunc) *Runner

+ func (r *Runner) Start()

+ func (r *Runner) Stop()

+ func (r *Runner) WaitForClose()

+ type RunnerFunc func(*Runner)

+ type WebSocketServer struct

+ func (wss *WebSocketServer) CreateEndpoint(uri string, opts *Options) (*Endpoint, error)

+ func (wss *WebSocketServer) RemoveEndpoint(ep *Endpoint) error

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL