dicedb

README

dicedb-go

Go client for DiceDB.

Installations

$ go get github.com/sevenDatabase/SevenDB-go@v1.0.9

Get Started

To start using DiceDB with Golang, you can follow the example tutorials present in the dice/examples directory.

Documentation

Index

• func ExecuteVoid(r *Retrier, retryOn []wire.ErrKind, op func() *wire.WireError, ...) *wire.WireError
• func ExecuteWithResult[T any](r *Retrier, retryOn []wire.ErrKind, op func() (*T, *wire.WireError), ...) (*T, *wire.WireError)
• func WithID(id string) option
• type Client
  • func NewClient(host string, port int, opts ...option) (*Client, error)
  • func (c *Client) Close()
  • func (c *Client) Fire(cmd *wire.Command) *wire.Result
  • func (c *Client) FireString(cmdStr string) *wire.Result
  • func (c *Client) WatchCh() (<-chan *wire.Result, error)
• type ClientWire
  • func NewClientWire(maxMsgSize int, host string, port int) (*ClientWire, *wire.WireError)
  • func (cw *ClientWire) Close()
  • func (cw *ClientWire) Receive() (*wire.Result, *wire.WireError)
  • func (cw *ClientWire) Send(cmd *wire.Command) *wire.WireError
• type Retrier
  • func NewRetrier(maxRetries int, retryWindow time.Duration) *Retrier
  • func (r *Retrier) Allow() bool
  • func (r *Retrier) Failure()
  • func (r *Retrier) Success()
• type ServerWire
  • func NewServerWire(maxMsgSize int, keepAlive int32, clientFD int) (*ServerWire, *wire.WireError)
  • func (sw *ServerWire) Close()
  • func (sw *ServerWire) Receive() (*wire.Command, *wire.WireError)
  • func (sw *ServerWire) Send(ctx context.Context, resp *wire.Result) *wire.WireError

Functions

func ExecuteVoid

func ExecuteVoid(r *Retrier, retryOn []wire.ErrKind, op func() *wire.WireError, beforeRetry func() *wire.WireError) *wire.WireError

func ExecuteWithResult

func ExecuteWithResult[T any](r *Retrier, retryOn []wire.ErrKind, op func() (*T, *wire.WireError), beforeRetry func() *wire.WireError) (*T, *wire.WireError)

func WithID

func WithID(id string) option

Types

type Client

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

func NewClient

func NewClient(host string, port int, opts ...option) (*Client, error)

func (*Client) Close

func (c *Client) Close()

func (*Client) Fire

func (c *Client) Fire(cmd *wire.Command) *wire.Result

func (*Client) FireString

func (c *Client) FireString(cmdStr string) *wire.Result

func (*Client) WatchCh

func (c *Client) WatchCh() (<-chan *wire.Result, error)

type ClientWire

type ClientWire struct {
	*internal.ProtobufTCPWire
}

func NewClientWire

func NewClientWire(maxMsgSize int, host string, port int) (*ClientWire, *wire.WireError)

func (*ClientWire) Close

func (cw *ClientWire) Close()

func (*ClientWire) Receive

func (cw *ClientWire) Receive() (*wire.Result, *wire.WireError)

func (*ClientWire) Send

func (cw *ClientWire) Send(cmd *wire.Command) *wire.WireError

type Retrier

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

func NewRetrier

func NewRetrier(maxRetries int, retryWindow time.Duration) *Retrier

func (*Retrier) Allow

func (r *Retrier) Allow() bool

func (*Retrier) Failure

func (r *Retrier) Failure()

func (*Retrier) Success

func (r *Retrier) Success()

type ServerWire

type ServerWire struct {
	*internal.ProtobufTCPWire
}

func NewServerWire

func NewServerWire(maxMsgSize int, keepAlive int32, clientFD int) (*ServerWire, *wire.WireError)

func (*ServerWire) Close

func (sw *ServerWire) Close()

func (*ServerWire) Receive

func (sw *ServerWire) Receive() (*wire.Command, *wire.WireError)

func (*ServerWire) Send

func (sw *ServerWire) Send(ctx context.Context, resp *wire.Result) *wire.WireError