server

Documentation

Index

• Constants
• type Option
  • func DisableSignatureVerification() Option
  • func DisableSwagger() Option
  • func WithPort(port string) Option
• type Server
  • func New(world servertypes.ProviderWorld, components []types.ComponentMetadata, ...) (*Server, error)
  • func (s *Server) BroadcastEvent(event any) error
  • func (s *Server) Serve() error
  • func (s *Server) Shutdown() error

Constants

const (
	DefaultPort = "4040"
)

Types

type Option

type Option func(s *Server)

func DisableSignatureVerification

func DisableSignatureVerification() Option

DisableSignatureVerification disables signature verification.

func DisableSwagger

func DisableSwagger() Option

DisableSwagger allows to disable the swagger setup of the server.

func WithPort

func WithPort(port string) Option

WithPort allows the server to run on a specified port.

type Server

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

func New

func New(
	world servertypes.ProviderWorld,
	components []types.ComponentMetadata,
	messages []types.Message,
	opts ...Option,
) (*Server, error)

New returns an HTTP server with handlers for all QueryTypes and MessageTypes.

func (*Server) BroadcastEvent

func (s *Server) BroadcastEvent(event any) error

func (*Server) Serve

func (s *Server) Serve() error

Serve serves the application, blocking the calling thread. Call this in a new go routine to prevent blocking.

func (*Server) Shutdown

func (s *Server) Shutdown() error

Shutdown gracefully shuts down the server and closes all active websocket connections.