service

Documentation

Index

• type Config
  • func NewConfig() *Config
• type Server
  • func NewServer(cfg *Config, app *fiber.App, logger mlog.Logger) *Server
  • func (s *Server) Run(l *common.Launcher) error
  • func (s *Server) ServerAddress() string
• type ServerGRPC
  • func NewServerGRPC(cfg *Config, server *grpc.Server, logger mlog.Logger) *ServerGRPC
  • func (sgrpc *ServerGRPC) ProtoAddress() string
  • func (sgrpc *ServerGRPC) Run(l *common.Launcher) error
• type Service
  • func (app *Service) Run()

Types

type Config

type Config struct {
	EnvName           string `env:"ENV_NAME"`
	ServerAddress     string `env:"SERVER_ADDRESS"`
	ProtoAddress      string `env:"PROTO_ADDRESS"`
	PrimaryDBHost     string `env:"DB_HOST"`
	PrimaryDBUser     string `env:"DB_USER"`
	PrimaryDBPassword string `env:"DB_PASSWORD"`
	PrimaryDBName     string `env:"DB_NAME"`
	PrimaryDBPort     string `env:"DB_PORT"`
	ReplicaDBHost     string `env:"DB_REPLICA_HOST"`
	ReplicaDBUser     string `env:"DB_REPLICA_USER"`
	ReplicaDBPassword string `env:"DB_REPLICA_PASSWORD"`
	ReplicaDBName     string `env:"DB_REPLICA_NAME"`
	ReplicaDBPort     string `env:"DB_REPLICA_PORT"`
	MongoDBHost       string `env:"MONGO_HOST"`
	MongoDBName       string `env:"MONGO_NAME"`
	MongoDBUser       string `env:"MONGO_USER"`
	MongoDBPassword   string `env:"MONGO_PASSWORD"`
	MongoDBPort       string `env:"MONGO_PORT"`
}

Config is the top level configuration struct for the entire application.

func NewConfig

func NewConfig() *Config

NewConfig creates an instance of Config.

type Server

type Server struct {
	mlog.Logger
	// contains filtered or unexported fields
}

Server represents the http server for Ledger service.

func NewServer

func NewServer(cfg *Config, app *fiber.App, logger mlog.Logger) *Server

NewServer creates an instance of Server.

func (*Server) Run

func (s *Server) Run(l *common.Launcher) error

Run runs the server.

func (*Server) ServerAddress

func (s *Server) ServerAddress() string

ServerAddress returns is a convenience method to return the server address.

type ServerGRPC

type ServerGRPC struct {
	mlog.Logger
	// contains filtered or unexported fields
}

ServerGRPC represents the gRPC server for Ledger service.

func NewServerGRPC

func NewServerGRPC(cfg *Config, server *grpc.Server, logger mlog.Logger) *ServerGRPC

NewServerGRPC creates an instance of gRPC Server.

func (*ServerGRPC) ProtoAddress

func (sgrpc *ServerGRPC) ProtoAddress() string

ProtoAddress returns is a convenience method to return the proto server address.

func (*ServerGRPC) Run

func (sgrpc *ServerGRPC) Run(l *common.Launcher) error

Run gRPC server.

type Service

type Service struct {
	*Server
	*ServerGRPC
	mlog.Logger
}

Service is the application glue where we put all top level components to be used.

func (*Service) Run

func (app *Service) Run()

Run starts the application. This is the only necessary code to run an app in main.go