com

Documentation

Index

• Constants
• Variables
• type Client
  • func (c *Client) Connect(addr url.URL) (*Connection, error)
• type Connection
  • func (c Connection) IsServer() bool
• type HasCallId
• type Map
  • func (m *Map[K, V]) Find(key K) (v V, ok bool)
  • func (m *Map[K, V]) FindBy(fn func(v V) bool) (v V, ok bool)
  • func (m *Map[K, V]) ForEach(fn func(v V))
  • func (m *Map[K, _]) Has(key K) bool
  • func (m *Map[_, _]) Len() int
  • func (m *Map[K, V]) Pop(key K) V
  • func (m *Map[K, V]) Put(key K, v V)
  • func (m *Map[K, _]) Remove(key K)
• type NetClient
• type NetMap
  • func NewNetMap[T NetClient]() NetMap[T]
  • func (m *NetMap[T]) Add(client T)
  • func (m *NetMap[T]) Remove(client T)
  • func (m *NetMap[T]) RemoveDisconnect(client T)
• type Packet
• type Packet2
• type RPC
  • func NewRPC[T ~uint8, P Packet[T]]() *RPC[T, P]
  • func (t *RPC[_, _]) Call(w Writer, rq HasCallId) ([]byte, error)
  • func (t *RPC[_, _]) Cleanup()
  • func (t *RPC[_, _]) Send(w Writer, packet any) error
• type Server
  • func (s *Server) Connect(w http.ResponseWriter, r *http.Request) (*Connection, error)
  • func (s *Server) Origin(host string)
• type SocketClient
  • func NewConnection[T ~uint8, P Packet[T], X any, P2 Packet2[X]](conn *Connection, id Uid, log *logger.Logger) *SocketClient[T, P, X, P2]
  • func (c *SocketClient[_, _, _, _]) Disconnect()
  • func (c *SocketClient[_, _, _, _]) Id() Uid
  • func (c *SocketClient[T, P, X, P2]) Notify(t T, data any)
  • func (c *SocketClient[T, P, _, _]) ProcessPackets(fn func(in P) error) chan struct{}
  • func (c *SocketClient[_, P, X, P2]) Route(in P, out P2)
  • func (c *SocketClient[T, P, X, P2]) Send(t T, data any) ([]byte, error)
  • func (c *SocketClient[_, _, _, _]) String() string
• type Transport
• type Uid
  • func NewUid() Uid
  • func UidFromString(id string) (Uid, error)
  • func (u Uid) Short() string
• type Writer

Constants

const DefaultCallTimeout = 7 * time.Second

Variables

var NilUid = Uid{xid.NilID()}

Types

type Client

type Client struct {
	websocket.Client
}

func (*Client) Connect

func (c *Client) Connect(addr url.URL) (*Connection, error)

type Connection

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

func (Connection) IsServer

func (c Connection) IsServer() bool

type HasCallId

type HasCallId interface {
	SetGetId(fmt.Stringer)
}

type Map

type Map[K comparable, V any] struct {
	// contains filtered or unexported fields
}

Map defines a concurrent-safe map structure. Keep in mind that the underlying map structure will grow indefinitely.

func (*Map[K, V]) Find

func (m *Map[K, V]) Find(key K) (v V, ok bool)

Find returns the first value found and a boolean flag if its found or not.

func (*Map[K, V]) FindBy

func (m *Map[K, V]) FindBy(fn func(v V) bool) (v V, ok bool)

FindBy searches the first key-value with the provided predicate function.

func (*Map[K, V]) ForEach

func (m *Map[K, V]) ForEach(fn func(v V))

ForEach processes every element with the provided callback function.

func (*Map[K, _]) Has

func (m *Map[K, _]) Has(key K) bool

func (*Map[_, _]) Len

func (m *Map[_, _]) Len() int

func (*Map[K, V]) Pop

func (m *Map[K, V]) Pop(key K) V

func (*Map[K, V]) Put

func (m *Map[K, V]) Put(key K, v V)

func (*Map[K, _]) Remove

func (m *Map[K, _]) Remove(key K)

type NetClient

type NetClient interface {
	Disconnect()
	Id() Uid
}

type NetMap

type NetMap[T NetClient] struct{ Map[Uid, T] }

func NewNetMap

func NewNetMap[T NetClient]() NetMap[T]

func (*NetMap[T]) Add

func (m *NetMap[T]) Add(client T)

func (*NetMap[T]) Remove

func (m *NetMap[T]) Remove(client T)

func (*NetMap[T]) RemoveDisconnect

func (m *NetMap[T]) RemoveDisconnect(client T)

type Packet

type Packet[T ~uint8] interface {
	GetId() Uid
	GetType() T
	GetPayload() []byte
}

type Packet2

type Packet2[T any] interface {
	SetId(string)
	SetType(uint8)
	SetPayload(any)
	SetGetId(fmt.Stringer)
	GetPayload() any
	*T // non-interface type constraint element
}

type RPC

type RPC[T ~uint8, P Packet[T]] struct {
	CallTimeout time.Duration
	Handler     func(P)
	Transport   Transport
	// contains filtered or unexported fields
}

func NewRPC

func NewRPC[T ~uint8, P Packet[T]]() *RPC[T, P]

func (*RPC[_, _]) Call

func (t *RPC[_, _]) Call(w Writer, rq HasCallId) ([]byte, error)

func (*RPC[_, _]) Cleanup

func (t *RPC[_, _]) Cleanup()

func (*RPC[_, _]) Send

func (t *RPC[_, _]) Send(w Writer, packet any) error

type Server

type Server struct {
	websocket.Server
}

func (*Server) Connect

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

func (*Server) Origin

func (s *Server) Origin(host string)

type SocketClient

type SocketClient[T ~uint8, P Packet[T], X any, P2 Packet2[X]] struct {
	// contains filtered or unexported fields
}

func NewConnection

func NewConnection[T ~uint8, P Packet[T], X any, P2 Packet2[X]](conn *Connection, id Uid, log *logger.Logger) *SocketClient[T, P, X, P2]

func (*SocketClient[_, _, _, _]) Disconnect

func (c *SocketClient[_, _, _, _]) Disconnect()

func (*SocketClient[_, _, _, _]) Id

func (c *SocketClient[_, _, _, _]) Id() Uid

func (*SocketClient[T, P, X, P2]) Notify

func (c *SocketClient[T, P, X, P2]) Notify(t T, data any)

Notify just sends a message and goes further.

func (*SocketClient[T, P, _, _]) ProcessPackets

func (c *SocketClient[T, P, _, _]) ProcessPackets(fn func(in P) error) chan struct{}

func (*SocketClient[_, P, X, P2]) Route

func (c *SocketClient[_, P, X, P2]) Route(in P, out P2)

func (*SocketClient[T, P, X, P2]) Send

func (c *SocketClient[T, P, X, P2]) Send(t T, data any) ([]byte, error)

Send makes a blocking call.

func (*SocketClient[_, _, _, _]) String

func (c *SocketClient[_, _, _, _]) String() string

type Transport

type Transport interface {
	SetMessageHandler(func([]byte, error))
}

type Uid

type Uid struct {
	xid.ID
}

func NewUid

func NewUid() Uid

func UidFromString

func UidFromString(id string) (Uid, error)

func (Uid) Short

func (u Uid) Short() string

type Writer

type Writer interface {
	Write([]byte)
}