services

Documentation

Overview

Package services contains the gRPC server for inter-node communication.

Index

• Constants
• func GetByType[T any](srvs MeshServers, t T) (T, bool)
• type LibP2POptions
• type MeshServer
• type MeshServers
  • func (s MeshServers) GetByType(t any) (MeshServer, bool)
• type Options
  • func (o *Options) GetServer(typ any) (MeshServer, bool)
• type Server
  • func NewServer(ctx context.Context, o Options) (*Server, error)
  • func (s *Server) GRPCListenPort() int
  • func (s *Server) GetServiceInfo() map[string]grpc.ServiceInfo
  • func (s *Server) ListenAndServe() error
  • func (s *Server) RegisterService(desc *grpc.ServiceDesc, impl any)
  • func (s *Server) Shutdown(ctx context.Context)

Constants

const DefaultGRPCListenAddress = "[::]:8443"

DefaultGRPCListenAddress is the default listen address for the gRPC server.

const DefaultGRPCPort = 8443

DefaultGRPCPort is the default port for the gRPC server.

Functions

func GetByType

func GetByType[T any](srvs MeshServers, t T) (T, bool)

GetByType is a generic function that can be used to search for the given server and automatically convert it to the given type.

Types

type LibP2POptions

type LibP2POptions struct {
	// HostOptions are options for the libp2p host.
	HostOptions libp2p.HostOptions
	// Announce will announce the host on the DHT at the given rendezvous if true.
	Announce bool
	// Rendezvous is the rendezvous string to use for libp2p.
	Rendezvous string
}

LibP2POptions are options for serving the gRPC server over libp2p.

type MeshServer

type MeshServer interface {
	// ListenAndServe starts the server and blocks until the server exits.
	ListenAndServe() error
	// Shutdown attempts to stops the server gracefully.
	Shutdown(ctx context.Context) error
}

MeshServer is the generic interface for additional services that can be managed by this server.

type MeshServers

type MeshServers []MeshServer

MeshServers is a list of MeshServers.

func (MeshServers) GetByType

func (s MeshServers) GetByType(t any) (MeshServer, bool)

GetByType iterates the list of given servers and returns one of the given type.

type Options

type Options struct {
	// DisableGRPC disables the gRPC server and only runs the MeshServers.
	DisableGRPC bool
	// WebEnabled is true if the grpc-web server should be enabled.
	WebEnabled bool
	// ListenAddress is the address to start the gRPC server on.
	ListenAddress string
	// ServerOptions are options for the server. This should include
	// any registered authentication mechanisms.
	ServerOptions []grpc.ServerOption
	// LibP2POptions are options for serving the gRPC server over libp2p.
	LibP2POptions *LibP2POptions
	// Servers are additional servers to manage alongside the gRPC server.
	Servers MeshServers
}

Options contains the configuration for the gRPC server.

func (*Options) GetServer

func (o *Options) GetServer(typ any) (MeshServer, bool)

GetServer returns the server of the given type.

type Server

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

Server is the gRPC server.

func NewServer

func NewServer(ctx context.Context, o Options) (*Server, error)

NewServer returns a new Server. TODO: We need to dynamically expose certain services only to the internal mesh.

func (*Server) GRPCListenPort

func (s *Server) GRPCListenPort() int

GRPCListenPort returns the port the gRPC server is listening on.

func (*Server) GetServiceInfo

func (s *Server) GetServiceInfo() map[string]grpc.ServiceInfo

GetServiceInfo implements reflection.ServiceInfoProvider.

func (*Server) ListenAndServe

func (s *Server) ListenAndServe() error

ListenAndServe starts the gRPC server and optional metrics server then blocks until the gRPC server exits.

func (*Server) RegisterService

func (s *Server) RegisterService(desc *grpc.ServiceDesc, impl any)

RegisterService implements grpc.RegistrarService.

func (*Server) Shutdown

func (s *Server) Shutdown(ctx context.Context)

Shutdown stops the gRPC server and all mesh services gracefully. You cannot use the server again after calling Stop.