server

Documentation

Overview

Package server is a package for starting servers for M3 components.

Index

• func RunComponents(opts Options)
• type Options

Functions

func RunComponents

func RunComponents(opts Options)

RunComponents runs the appropriate M3 components based on the configuration. Kicks off either a single DB node or both a DB node and coordinator.

Types

type Options

type Options struct {
	// Configuration is the top level configuration that includes both a DB
	// node and a coordinator.
	Configuration config.Configuration

	// InterruptCh is a programmatic interrupt channel to supply to
	// interrupt and shutdown the server.
	InterruptCh <-chan error

	// ShutdownCh is an optional channel to supply if interested in receiving
	// a notification that the server has shutdown.
	ShutdownCh chan<- struct{}
}

Options contains options for starting M3 components.