server

Documentation

Overview

Package server implements the main application logic for Octoplex server.

Index

• Variables
• func Listener(addr string) func() (net.Listener, error)
• func ResetCredentials(cfg config.Config, tokenStore TokenStore) (string, string, error)
• func WithListener(lis net.Listener) func() (net.Listener, error)
• type App
  • func New(params Params) (*App, error)
  • func (a *App) DispatchAsync(clientID event.ClientID, cmd event.Command)
  • func (a *App) DispatchSync(cmd event.Command) (event.Event, error)
  • func (a *App) Run(ctx context.Context) error
  • func (a *App) Stop(ctx context.Context) error
• type CredentialsMode
• type ListenerFunc
• type Params
• type Server
  • func (s *Server) AddDestination(ctx context.Context, req *connect.Request[pb.AddDestinationRequest]) (*connect.Response[pb.AddDestinationResponse], error)
  • func (s *Server) Authenticate(context.Context, *connect.Request[pb.AuthenticateRequest]) (*connect.Response[pb.AuthenticateResponse], error)
  • func (s *Server) Communicate(ctx context.Context, stream *connect.BidiStream[pb.Envelope, pb.Envelope]) error
  • func (s *Server) GetClientCount() int
  • func (s *Server) ListDestinations(ctx context.Context, req *connect.Request[pb.ListDestinationsRequest]) (*connect.Response[pb.ListDestinationsResponse], error)
  • func (s *Server) RemoveDestination(ctx context.Context, req *connect.Request[pb.RemoveDestinationRequest]) (*connect.Response[pb.RemoveDestinationResponse], error)
  • func (s *Server) StartDestination(ctx context.Context, req *connect.Request[pb.StartDestinationRequest]) (*connect.Response[pb.StartDestinationResponse], error)
  • func (s *Server) StopDestination(ctx context.Context, req *connect.Request[pb.StopDestinationRequest]) (*connect.Response[pb.StopDestinationResponse], error)
  • func (s *Server) UpdateDestination(ctx context.Context, req *connect.Request[pb.UpdateDestinationRequest]) (*connect.Response[pb.UpdateDestinationResponse], error)
  • func (s *Server) WaitForClient(ctx context.Context) error
• type TokenStore
• type WebSocketProxy
  • func (p *WebSocketProxy) GetConnectionCount() int
  • func (p *WebSocketProxy) Handler() http.HandlerFunc

Variables

var (
	// ErrOtherInstanceDetected is returned when another instance of the app is
	// detected on startup.
	ErrOtherInstanceDetected = errors.New("another instance is currently running")

	// ErrAuthenticationCannotBeDisabled is returned when it is not permitted for
	// authentication mode to be "none".
	ErrAuthenticationCannotBeDisabled = errors.New("authentication cannot be disabled")
)

Functions

func Listener

func Listener(addr string) func() (net.Listener, error)

WithListener creates a TCP listener on the given address.

func ResetCredentials

func ResetCredentials(cfg config.Config, tokenStore TokenStore) (string, string, error)

ResetCredentials resets the API token and the admin password. It returns the raw token strings that can be presented to the user.

func WithListener

func WithListener(lis net.Listener) func() (net.Listener, error)

WithListener returns the provided listener.

Types

type App

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

App is an instance of the app.

func New

func New(params Params) (*App, error)

New creates a new application instance.

func (*App) DispatchAsync

func (a *App) DispatchAsync(clientID event.ClientID, cmd event.Command)

DispatchAsync dispatches a command to be executed synchronously.

func (*App) DispatchSync

func (a *App) DispatchSync(cmd event.Command) (event.Event, error)

DispatchSync dispatches a command to be executed synchronously.

func (*App) Run

func (a *App) Run(ctx context.Context) error

Run starts the application, and blocks until it exits.

func (*App) Stop

func (a *App) Stop(ctx context.Context) error

Stop stops all containers and networks created by any instance of the app.

type CredentialsMode

type CredentialsMode int

CredentialsMode represents the mode of credentials used by the server.

This is related to config.AuthMode, but represents the actual state of the server rather than the user's stated preference.

const (
	CredentialsModeEnabled CredentialsMode = iota
	CredentialsModeDisabled
)

type ListenerFunc

type ListenerFunc func() (net.Listener, error)

ListenerFunc is a function that returns a net.Listener.

type Params

type Params struct {
	Config          config.Config
	Store           *store.FileStore
	TokenStore      *store.TokenStore
	DockerClient    container.DockerClient
	ListenerTLSFunc func() (net.Listener, error) // ListenerTLSFunc overrides the configured TLS listen address. May be nil.
	ChanSize        int
	WaitForClient   bool
	Logger          *slog.Logger
}

Params holds the parameters for running the application.

type Server

type Server struct {
	connectpb.UnimplementedAPIServiceHandler
	// contains filtered or unexported fields
}

Server is the gRPC server that handles incoming commands and outgoing events.

func (*Server) AddDestination

func (s *Server) AddDestination(ctx context.Context, req *connect.Request[pb.AddDestinationRequest]) (*connect.Response[pb.AddDestinationResponse], error)

func (*Server) Authenticate

func (s *Server) Authenticate(context.Context, *connect.Request[pb.AuthenticateRequest]) (*connect.Response[pb.AuthenticateResponse], error)

func (*Server) Communicate

func (s *Server) Communicate(ctx context.Context, stream *connect.BidiStream[pb.Envelope, pb.Envelope]) error

func (*Server) GetClientCount

func (s *Server) GetClientCount() int

GetClientCount returns the number of connected clients.

func (*Server) ListDestinations

func (s *Server) ListDestinations(ctx context.Context, req *connect.Request[pb.ListDestinationsRequest]) (*connect.Response[pb.ListDestinationsResponse], error)

func (*Server) RemoveDestination

func (s *Server) RemoveDestination(ctx context.Context, req *connect.Request[pb.RemoveDestinationRequest]) (*connect.Response[pb.RemoveDestinationResponse], error)

func (*Server) StartDestination

func (s *Server) StartDestination(ctx context.Context, req *connect.Request[pb.StartDestinationRequest]) (*connect.Response[pb.StartDestinationResponse], error)

func (*Server) StopDestination

func (s *Server) StopDestination(ctx context.Context, req *connect.Request[pb.StopDestinationRequest]) (*connect.Response[pb.StopDestinationResponse], error)

func (*Server) UpdateDestination

func (s *Server) UpdateDestination(ctx context.Context, req *connect.Request[pb.UpdateDestinationRequest]) (*connect.Response[pb.UpdateDestinationResponse], error)

func (*Server) WaitForClient

func (s *Server) WaitForClient(ctx context.Context) error

WaitForClient waits for _any_ client to connect and complete the handshake. It times out if no client has connected after 10 seconds.

type TokenStore

type TokenStore interface {
	Get(key string) (domain.Token, error)
	Put(key string, value domain.Token) error
	Delete(key string) error
}

TokenStore is a store for tokens.

type WebSocketProxy

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

WebSocketProxy bridges WebSocket connections to ConnectRPC bidirectional streams.

func (*WebSocketProxy) GetConnectionCount

func (p *WebSocketProxy) GetConnectionCount() int

GetConnectionCount returns the number of active WebSocket connections.

func (*WebSocketProxy) Handler

func (p *WebSocketProxy) Handler() http.HandlerFunc

Handler handles incoming WebSocket connections.