ssgrpc

Documentation

Overview

Package ssgrpc provides a ss.MultihomeBackend interface that uses grpc with profobufs for synchronizing broadcasts and roomcasts between multiple Sacrificial Socket instances.

Index

• Variables
• type GRPCMHB
  • func NewBackend(tlsKeyFile, tlsCertFile, grpcHostPort string, sharedKey []byte, ...) *GRPCMHB
  • func NewInsecureBackend(grpcHostPort string, peerList []string) *GRPCMHB
  • func (g *GRPCMHB) BroadcastFromBackend(b chan<- *ss.BroadcastMsg)
  • func (g *GRPCMHB) BroadcastToBackend(b *ss.BroadcastMsg)
  • func (g *GRPCMHB) Init()
  • func (g *GRPCMHB) RoomcastFromBackend(r chan<- *ss.RoomMsg)
  • func (g *GRPCMHB) RoomcastToBackend(r *ss.RoomMsg)
  • func (g *GRPCMHB) Shutdown()

Variables

var (
	ErrBadRPCCredentials = errors.New("the client provided invalid RPC credentials")

	ErrNilBroadcastChannel = errors.New("broadcast channel is not open yet")
	ErrNilRoomcastChannel  = errors.New("roomcast channel is not open yet")

	ErrBadDataType = errors.New("bad data type used")
	ErrBadContext  = errors.New("bad context used in transport")
)

Types

type GRPCMHB

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

GRPCMHB... yep that's what I'm calling it. All you need to know is that GRPCMHB satisfies the ss.MultihomeBackend interface

func NewBackend

func NewBackend(tlsKeyFile, tlsCertFile, grpcHostPort string, sharedKey []byte, peerList []string) *GRPCMHB

NewBackend returns a GRPCMHB that will use TLS and HMAC-SHA256 signed JWTs to connect and authenticate to the peers in peerList

func NewInsecureBackend

func NewInsecureBackend(grpcHostPort string, peerList []string) *GRPCMHB

NewInsecureBackend returns a GRPCMHB that will use no encryption or authentication to connect to the peers in peerList

It is highly discouraged to use this for production systems, as all data will be sent in clear text and no authentication will be done on peer connections

func (*GRPCMHB) BroadcastFromBackend

func (g *GRPCMHB) BroadcastFromBackend(b chan<- *ss.BroadcastMsg)

BroadcastFromBackend listens on the local grpc service for calls from remote peers and propagates broadcasts to locally connected websockets

func (*GRPCMHB) BroadcastToBackend

func (g *GRPCMHB) BroadcastToBackend(b *ss.BroadcastMsg)

BroadcastToBackend propagates the broadcast to all active peer connections

func (*GRPCMHB) Init

func (g *GRPCMHB) Init()

Init sets up the grpc server and creates connections to all grpc peers

func (*GRPCMHB) RoomcastFromBackend

func (g *GRPCMHB) RoomcastFromBackend(r chan<- *ss.RoomMsg)

RoomcastFromBackend listens on the local grpc service for calls from remote peers and propagates roomcasts to locally connected websockets

func (*GRPCMHB) RoomcastToBackend

func (g *GRPCMHB) RoomcastToBackend(r *ss.RoomMsg)

RoomcastToBackend propagates the roomcast to all active peer connections

func (*GRPCMHB) Shutdown

func (g *GRPCMHB) Shutdown()

Shutdown stops the grpc service and closes any peer connections