shared

README

ogbcommon

Documentation

Index

• func ReadYAMLConfig(filePath string, config interface{}) error
• func SetLogLevel(level string) error
• type Endpoint
• type EndpointConfig
• type Service
• type ServiceConfig

Functions

func ReadYAMLConfig

func ReadYAMLConfig(filePath string, config interface{}) error

ReadYAMLConfig reads a YAML configuration file and unmarshals it into the provided interface config parameter should be a pointer to a struct that matches the YAML structure

func SetLogLevel

func SetLogLevel(level string) error

SetLogLevel sets the global logging level

Types

type Endpoint

type Endpoint interface {
	Init(EndpointConfig) error
	GetUri() string
	GetHttpMethod() string
	IsSkipAuth() bool
	HandleRequest(*proto.Packet) (*proto.Response, error)
}

type EndpointConfig

type EndpointConfig struct {
	Uri        string `yaml:"uri"`
	HttpMethod string `yaml:"http_method"`
	SkipAuth   string `yaml:"skip_auth"`
}

type Service

type Service interface {
	Init(ServiceConfig) error
	RegisterEndpoint(*Endpoint) error
	Start() error
}

type ServiceConfig

type ServiceConfig struct {
	Hostname string `yaml:"hostname"` // Listening RPC hostname
	Port     uint16 `yaml:"port"`     // Listening RPC port
}