redisd

package module

v0.2.0 Latest Latest Go to latest Published: Feb 20, 2020 License: MIT Imports: 9 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

gitlab.com/MGEs/Redisd

README ¶

MGEs.Redisd

MGEs框架下，基于go-redis的简单生命周期封装。

依赖

MGEs.Base：^0.3.0
go-redis：^v6.15.5
@Attention：主程序必须调用workflow.Lifecycle_Start，否则服务不会运行！

安装

go get gitlab.com/MGEs/Redisd

例子

package main

import (
	"github.com/go-redis/redis"

	"gitlab.com/MGEs/Base/workflow"
	redisd "gitlab.com/MGEs/Redisd"
)

var redisClient *redis.Client

func init() {
	if cfg, err := redisd.NewConfig(redisd.ConfigEntry{
		Comment:   "SSO",
		Mode:      redisd.ConfigMode_Flag | redisd.ConfigMode_File,
		FlagNames: []string{"-redisd"},
		FileEntry: []string{"api", "redisd"},
	}); err != nil {
		workflow.Throw(err, workflow.TlPanic)
	} else if iErr := cfg.Setup(func(client *redis.Client) []error {
		redisClient = client
		return nil
	}); iErr != nil {
		workflow.Throw(iErr, workflow.TlPanic)
	}
}

func main() {
	if err := workflow.Lifecycle_Start(); err != nil {
        panic(err)
    }
}

Licensing

The MIT License (MIT)

Documentation ¶

Index ¶

Constants
Variables
func DefaultFlagDoc() *flags.Document
type Config
- func NewConfig(entry ConfigEntry) (*Config, error)
- func (c *Config) Setup(setup func(*redis.Client) []error) error
type ConfigEntry
type ConfigMode

Constants ¶

View Source

const (
	EVT_S__Redisd_HelpMsg = "MGEs.Redisd"
	Flag_HelpEntry        = "MGEs.Redisd"
)

View Source

const (
	EVT_S__Redisd_Subscriber = "MGEs.Redisd.BootUp"
	EVT_OD_Redisd_Shutdown   = workflow.EventPriority_Latest - 10
)

View Source

const (
	ConfigMode_Internal = 1 << (8 - 1 - iota)
	ConfigMode_Flag
	ConfigMode_File
)

Variables ¶

View Source

var (
	EM_Redisd_FailedToRegisterParameters = workflow.NewMask(
		"Redisd:FailedToRegisterParameters",
		"注册参数失败",
	)
	EM_Redisd_FailedToRegisterEvent = workflow.NewMask(
		"Redisd:FailedToRegisterEvent",
		"Redisd:注册事件失败",
	)
	EM_Redisd_FailedToCreateInstance = workflow.NewMask(
		"Redisd:FailedToCreateInstance",
		"Redisd:实例化数据库配置失败",
	)
	EM_Redisd_FailedToConfigInstance = workflow.NewMask(
		"Redisd:FailedToConfigInstance",
		"Redisd:配置数据库实例失败",
	)
	EM_Redisd_InstanceCreated = workflow.NewMask(
		"Redisd:InstanceCreated",
		"[Redisd] 已创建链接 {{name}}",
	)
	EM_Redisd_InstanceClosed = workflow.NewMask(
		"Redisd:InstanceClosed",
		"[Redisd] 已关闭链接 {{name}}",
	)
)

Functions ¶

func DefaultFlagDoc ¶ added in v0.2.0

func DefaultFlagDoc() *flags.Document

Types ¶

type Config ¶

type Config struct {
	Tls bool
	mnet.ListenerConfig
	mnet.TlsConfig
	Database int
	Password string
	Comment  string
	// contains filtered or unexported fields
}

func NewConfig ¶

func NewConfig(entry ConfigEntry) (*Config, error)

func (*Config) Setup ¶

func (c *Config) Setup(setup func(*redis.Client) []error) error

type ConfigEntry ¶

type ConfigEntry struct {
	Mode         ConfigMode
	FlagNames    []string
	FlagGroup    *flags.Group
	FlagDocument *flags.Document
	FileEntry    []string
	Comment      string
}

type ConfigMode ¶

type ConfigMode uint8

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL