fastws

Documentation

Index

• func MustNew(opts ...Option) kit.Gateway
• func New(opts ...Option) (kit.Gateway, error)
• func RPCs(predicate ...string) []kit.RouteSelector
• type Option
  • func Listen(protoAddr string) Option
  • func WithCustomRPC(in kit.IncomingRPCFactory, out kit.OutgoingRPCFactory) Option
  • func WithLogger(l kit.Logger) Option
  • func WithPredicateKey(key string) Option
  • func WithWebsocketBinaryMode() Option
  • func WithWebsocketTextMode() Option
• type Selector
  • func RPC(predicate string) Selector
  • func (r Selector) GetEncoding() kit.Encoding
  • func (r Selector) GetPredicate() string
  • func (r Selector) Query(q string) any
  • func (r Selector) SetEncoding(enc kit.Encoding) Selector
• type SwitchProtocol
  • func (sp *SwitchProtocol) Upgrade(conn io.ReadWriter) (hs ws.Handshake, err error)

Functions

func MustNew

func MustNew(opts ...Option) kit.Gateway

func New

func New(opts ...Option) (kit.Gateway, error)

func RPCs

func RPCs(predicate ...string) []kit.RouteSelector

RPCs is a shortcut for multiple RPC selectors

Types

type Option

type Option func(b *bundle)

func Listen

func Listen(protoAddr string) Option

func WithCustomRPC

func WithCustomRPC(in kit.IncomingRPCFactory, out kit.OutgoingRPCFactory) Option

WithCustomRPC lets you define your RPC message container. RPC message container will be represented as Envelope in your application. RPCContainer only defines the behavior of serialization and deserialization of the Envelope.

func WithLogger

func WithLogger(l kit.Logger) Option

func WithPredicateKey

func WithPredicateKey(key string) Option

func WithWebsocketBinaryMode

func WithWebsocketBinaryMode() Option

WithWebsocketBinaryMode sets the write mode of the websocket to binary opCode

func WithWebsocketTextMode

func WithWebsocketTextMode() Option

WithWebsocketTextMode sets the write mode of the websocket to text opCode This is the default behavior

type Selector

type Selector struct {
	Predicate string
	Encoding  kit.Encoding
}

func RPC

func RPC(predicate string) Selector

RPC returns a selector that acts on websocket messages

func (Selector) GetEncoding

func (r Selector) GetEncoding() kit.Encoding

func (Selector) GetPredicate

func (r Selector) GetPredicate() string

func (Selector) Query

func (r Selector) Query(q string) any

func (Selector) SetEncoding

func (r Selector) SetEncoding(enc kit.Encoding) Selector

type SwitchProtocol

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

func (*SwitchProtocol) Upgrade

func (sp *SwitchProtocol) Upgrade(conn io.ReadWriter) (hs ws.Handshake, err error)