tso

Documentation

Index

• func NewRequestFastFail(err error) *tsoRequestFastFail
• type Cli
  • func NewClient(ctx context.Context, option *opt.Option, svcDiscovery sd.ServiceDiscovery, ...) *Cli
  • func (c *Cli) Close()
  • func (c *Cli) DispatchRequest(request *Request) (bool, error)
  • func (c *Cli) GetRequestPool() *sync.Pool
  • func (c *Cli) GetTSORequest(ctx context.Context) *Request
  • func (c *Cli) Setup()
• type Client
• type MSStreamBuilderFactory
• type PDStreamBuilderFactory
• type Request
  • func (req *Request) IsFrom(pool *sync.Pool) bool
  • func (req *Request) TryDone(err error)
  • func (req *Request) Wait() (physical int64, logical int64, err error)
• type TSFuture

Functions

func NewRequestFastFail

func NewRequestFastFail(err error) *tsoRequestFastFail

NewRequestFastFail creates a new fast fail TSO request.

Types

type Cli

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

Cli is the implementation of the TSO client.

func NewClient

func NewClient(
	ctx context.Context, option *opt.Option,
	svcDiscovery sd.ServiceDiscovery, factory tsoStreamBuilderFactory,
) *Cli

NewClient returns a new TSO client.

func (*Cli) Close

func (c *Cli) Close()

Close closes the TSO client

func (*Cli) DispatchRequest

func (c *Cli) DispatchRequest(request *Request) (bool, error)

DispatchRequest will send the TSO request to the corresponding TSO dispatcher.

func (*Cli) GetRequestPool

func (c *Cli) GetRequestPool() *sync.Pool

GetRequestPool gets the request pool of the TSO client.

func (*Cli) GetTSORequest

func (c *Cli) GetTSORequest(ctx context.Context) *Request

GetTSORequest gets a TSO request from the pool.

func (*Cli) Setup

func (c *Cli) Setup()

Setup initializes the TSO client.

type Client

type Client interface {
	// GetTS gets a timestamp from PD or TSO microservice.
	GetTS(ctx context.Context) (int64, int64, error)
	// GetTSAsync gets a timestamp from PD or TSO microservice, without block the caller.
	GetTSAsync(ctx context.Context) TSFuture
	// GetMinTS gets a timestamp from PD or the minimal timestamp across all keyspace groups from
	// the TSO microservice.
	GetMinTS(ctx context.Context) (int64, int64, error)

	// Deprecated: the Local TSO feature has been deprecated. Regardless of the
	// parameters passed, the behavior of this interface will be equivalent to
	// `GetTS`. If you want to use a separately deployed TSO service,
	// please refer to the deployment of the TSO microservice.
	GetLocalTS(ctx context.Context, _ string) (int64, int64, error)
	// Deprecated: the Local TSO feature has been deprecated. Regardless of the
	// parameters passed, the behavior of this interface will be equivalent to
	// `GetTSAsync`. If you want to use a separately deployed TSO service,
	// please refer to the deployment of the TSO microservice.
	GetLocalTSAsync(ctx context.Context, _ string) TSFuture
}

Client defines the interface of a TSO client.

type MSStreamBuilderFactory

type MSStreamBuilderFactory struct{}

MSStreamBuilderFactory is a factory for building TSO streams to the microservice cluster.

type PDStreamBuilderFactory

type PDStreamBuilderFactory struct{}

PDStreamBuilderFactory is a factory for building TSO streams to the PD cluster.

type Request

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

Request is a TSO request.

func (*Request) IsFrom

func (req *Request) IsFrom(pool *sync.Pool) bool

IsFrom checks if the request is from the specified pool.

func (*Request) TryDone

func (req *Request) TryDone(err error)

TryDone tries to send the result to the channel, it will not block.

func (*Request) Wait

func (req *Request) Wait() (physical int64, logical int64, err error)

Wait will block until the TSO result is ready.

type TSFuture

type TSFuture interface {
	// Wait gets the physical and logical time, it would block caller if data is not available yet.
	Wait() (int64, int64, error)
}

TSFuture is a future which promises to return a TSO.