server

Documentation

Index

• Constants
• type Config
  • func NewConfig() *Config
  • func (c Config) RPCAddr() string
• type Server
  • func New(conf *Config) (*Server, error)
  • func (s *Server) RPCAddr() string
  • func (s *Server) Shutdown(graceful bool) error
  • func (s *Server) ShutdownCh() <-chan struct{}
  • func (s *Server) Start() error

Constants

const (
	DefaultRPCPort = 10118

	DefaultWebPort = 10119

	DefaultMongoConnectionURI        = "mongodb://localhost:27017"
	DefaultMongoConnectionTimeoutSec = 5
	DefaultMongoPingTimeoutSec       = 5
	DefaultMongoDatabase             = "metis"

	DefaultYorkieRPCAddr      = "localhost:11101"
	DefaultYorkieWebhookToken = "metis-server"
	DefaultYorkieCollection   = "projects"
)

The following are the defaults for the Server config.

Types

type Config

type Config struct {
	RPC    *rpc.Config     `json:"RPC"`
	Web    *web.Config     `json:"Web"`
	Mongo  *mongodb.Config `json:"Mongo"`
	Yorkie *yorkie.Config  `json:"Yorkie"`
}

Config is the configuration for creating a Server instance.

func NewConfig

func NewConfig() *Config

NewConfig returns a Config struct that contains reasonable defaults for most of the configurations.

func (Config) RPCAddr

func (c Config) RPCAddr() string

RPCAddr returns the RPC address.

type Server

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

Server receives requests from the client, stores data in the database,

func New

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

New creates a new instance of Server.

func (*Server) RPCAddr

func (s *Server) RPCAddr() string

RPCAddr returns the RPC address.

func (*Server) Shutdown

func (s *Server) Shutdown(graceful bool) error

Shutdown shuts down this server.

func (*Server) ShutdownCh

func (s *Server) ShutdownCh() <-chan struct{}

ShutdownCh returns the shutdown channel.

func (*Server) Start

func (s *Server) Start() error

Start starts the server by opening the rpc port.