redis

Documentation

Index

• Constants
• type Arguments
• type CommandHandler
• type DBContext
  • func (ctx *DBContext) ID() int
• type Executor
• type Executors
• type ExpireOption
• type GenericCommandHandler
• type HSetOption
• type HashCommandHandler
• type MSetOption
• type Message
  • func NewArrayMessage() *Message
  • func NewBulkMessage(msg string) *Message
  • func NewErrorMessage(err error) *Message
  • func NewIntegerMessage(val int) *Message
  • func NewNilMessage() *Message
  • func NewOKMessage() *Message
  • func NewStringArrayMessage(strs []string) *Message
  • func NewStringMessage(msg string) *Message
• type RenameOption
• type Server
  • func NewServer() *Server
  • func (server *Server) Echo(ctx *DBContext, arg string) (*Message, error)
  • func (server *Server) Ping(ctx *DBContext, arg string) (*Message, error)
  • func (server *Server) Quit(ctx *DBContext) (*Message, error)
  • func (server *Server) RegisterExexutor(cmd string, executor Executor)
  • func (server *Server) Restart() error
  • func (server *Server) Select(ctx *DBContext, index int) (*Message, error)
  • func (server *Server) SetCommandHandler(handler CommandHandler)
  • func (server *Server) Start() error
  • func (server *Server) Stop() error
• type SetOption
• type StringCommandHandler
• type SystemCommandHandler

Constants

const (
	LocalHost   = "localhost"
	DefaultPort = 6379
	OK          = "OK"
)

const (
	Version = "v0.9.0"
)

Types

type Arguments

type Arguments = *proto.Array

type CommandHandler

type CommandHandler interface {
	GenericCommandHandler
	StringCommandHandler
	HashCommandHandler
}

CommandHandler represents a command hander interface for user commands.

type DBContext

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

DBContext represents a database connection context.

func (*DBContext) ID

func (ctx *DBContext) ID() int

ID returns the current selected database ID.

type Executor

type Executor func(*DBContext, string, Arguments) (*Message, error)

type Executors

type Executors map[string]Executor

type ExpireOption

type ExpireOption struct {
	Time time.Time
	NX   bool
	XX   bool
	GT   bool
	LT   bool
}

type GenericCommandHandler

type GenericCommandHandler interface {
	// 1.0.0
	Del(ctx *DBContext, keys []string) (*Message, error)
	Exists(ctx *DBContext, keys []string) (*Message, error)
	Expire(ctx *DBContext, key string, opt ExpireOption) (*Message, error)
	Keys(ctx *DBContext, pattern string) (*Message, error)
	Rename(ctx *DBContext, key string, newkey string, opt RenameOption) (*Message, error)
	Type(ctx *DBContext, key string) (*Message, error)
	TTL(ctx *DBContext, key string) (*Message, error)
}

GenericCommandHandler represents a hander interface for genelic commands.

type HSetOption

type HSetOption struct {
	NX bool
}

type HashCommandHandler

type HashCommandHandler interface {
	HDel(ctx *DBContext, key string, fields []string) (*Message, error)
	HSet(ctx *DBContext, key string, field string, val string, opt HSetOption) (*Message, error)
	HGet(ctx *DBContext, key string, field string) (*Message, error)
	HGetAll(ctx *DBContext, key string) (*Message, error)
	HMSet(ctx *DBContext, key string, dict map[string]string) (*Message, error)
	HMGet(ctx *DBContext, key string, fields []string) (*Message, error)
}

HashCommandHandler represents a core command hander interface for hash commands.

type MSetOption

type MSetOption struct {
	NX bool
}

type Message

type Message = proto.Message

Message represents a message of Redis serialization protocol.

func NewArrayMessage

func NewArrayMessage() *Message

NewArrayMessage creates an empty array message.

func NewBulkMessage

func NewBulkMessage(msg string) *Message

NewBulkMessage creates a bulk string message.

func NewErrorMessage

func NewErrorMessage(err error) *Message

NewErrorMessage creates an error message.

func NewIntegerMessage

func NewIntegerMessage(val int) *Message

NewIntegerMessage creates an integer message.

func NewNilMessage

func NewNilMessage() *Message

NewNilMessage creates a nil bulk string message.

func NewOKMessage

func NewOKMessage() *Message

NewOKMessage creates a OK string message.

func NewStringArrayMessage

func NewStringArrayMessage(strs []string) *Message

NewStringArrayMessage creates an array message with the specified strings.

func NewStringMessage

func NewStringMessage(msg string) *Message

NewStringMessage creates a string message.

type RenameOption

type RenameOption struct {
	NX bool
}

type Server

type Server struct {
	Addr string
	Port int
	// contains filtered or unexported fields
}

Server is an instance for Redis protocols.

func NewServer

func NewServer() *Server

NewServer returns a new server instance.

func (*Server) Echo

func (server *Server) Echo(ctx *DBContext, arg string) (*Message, error)

func (*Server) Ping

func (server *Server) Ping(ctx *DBContext, arg string) (*Message, error)

func (*Server) Quit

func (server *Server) Quit(ctx *DBContext) (*Message, error)

func (*Server) RegisterExexutor

func (server *Server) RegisterExexutor(cmd string, executor Executor)

RegisterExexutor sets a command executor.

func (*Server) Restart

func (server *Server) Restart() error

Restart restarts the server.

func (*Server) Select

func (server *Server) Select(ctx *DBContext, index int) (*Message, error)

func (*Server) SetCommandHandler

func (server *Server) SetCommandHandler(handler CommandHandler)

SetCommandHandler sets a user handler to handle user commands.

func (*Server) Start

func (server *Server) Start() error

Start starts the server.

func (*Server) Stop

func (server *Server) Stop() error

Stop stops the server.

type SetOption

type SetOption struct {
	EX      time.Duration
	PX      time.Duration
	EXAT    time.Time
	PXAT    time.Time
	NX      bool
	XX      bool
	KEEPTTL bool
	GET     bool
}

type StringCommandHandler

type StringCommandHandler interface {
	Set(ctx *DBContext, key string, val string, opt SetOption) (*Message, error)
	Get(ctx *DBContext, key string) (*Message, error)
	MSet(ctx *DBContext, dict map[string]string, opt MSetOption) (*Message, error)
	MGet(ctx *DBContext, keys []string) (*Message, error)
}

StringHandler represents a core command hander interface for string commands.

type SystemCommandHandler

type SystemCommandHandler interface {
	Ping(ctx *DBContext, arg string) (*Message, error)
	Echo(ctx *DBContext, arg string) (*Message, error)
	Select(ctx *DBContext, index int) (*Message, error)
	Quit(ctx *DBContext) (*Message, error)
}

SystemCommandHandler represents a hander interface for system commands.