service

Documentation

Index

• Variables
• type Config
  • func (c *Config) HTTPAddr() (string, error)
  • func (c *Config) RPCAddr() (string, error)
• type Service
  • func New(conf Config) (*Service, error)
  • func (s *Service) Close() error

Variables

var ErrNoCommunication = errors.New("no communication pathways for clients")

Types

type Config

type Config struct {
	DataDir        string   // where to store raft data.
	BindAddr       string   // serf addr.
	RPCPort        int      // port for raft and client connections
	StartJoinAddrs []string // addresses to join to
	Bootstrap      bool     // should bootstrap cluster?
	NodeName       string   // raft server id

	// Enable different communications protocols for clients
	EnableHTTP bool
	EnableGRPC bool

	ServerTLS *tls.Config
	PeerTLS   *tls.Config
}

Config handles all of the customizable values for Service.

func (*Config) HTTPAddr

func (c *Config) HTTPAddr() (string, error)

HTTPAddr returns the HTTP address to the server.

func (*Config) RPCAddr

func (c *Config) RPCAddr() (string, error)

RPCAddr returns the host:RPCPort string

type Service

type Service struct {
	Config Config
	// contains filtered or unexported fields
}

Service handles combining every component of the system.

func New

func New(conf Config) (*Service, error)

New returns a new service instance. This function also sets up the registry, store, mux and server fields.

func (*Service) Close

func (s *Service) Close() error

Close shuts dwon components and leaves the registry cluster.