fastws

package module

v0.12.7 Latest Latest Go to latest Published: Apr 18, 2024 License: BSD-3-Clause Imports: 16 Imported by: 2

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/clubpay/ronykit

Links

Open Source Insights

Documentation ¶

Index ¶

func MustNew(opts ...Option) kit.Gateway
func New(opts ...Option) (kit.Gateway, error)
func RPCs(predicate ...string) []kit.RouteSelector
type Option
type Selector
- func RPC(predicate string) Selector
type SwitchProtocol
- func (sp *SwitchProtocol) Upgrade(conn io.ReadWriter) (hs ws.Handshake, err error)

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func MustNew ¶

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

func New ¶

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

func RPCs ¶ added in v0.10.40

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

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)

Source Files ¶

View all Source files

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