client

Documentation

Index

• type AssignmentService
• type BroadcastService
• type Client
  • func NewClient(etcdCli *clientv3.Client) Client

Types

type AssignmentService

type AssignmentService interface {
	// AssignmentDiscover is used to watches the assignment discovery.
	types.AssignmentDiscoverWatcher
}

AssignmentService is the interface of assignment service.

type BroadcastService

type BroadcastService interface {
	// Broadcast sends a broadcast message to the streaming service.
	Broadcast(ctx context.Context, msg message.BroadcastMutableMessage) (*types.BroadcastAppendResult, error)

	// Ack sends a broadcast ack to the streaming service.
	Ack(ctx context.Context, req types.BroadcastAckRequest) error

	// BlockUntilEvent blocks until the event happens.
	BlockUntilEvent(ctx context.Context, ev *message.BroadcastEvent) error

	// Close closes the broadcast service.
	Close()
}

BroadcastService is the interface of broadcast service.

type Client

type Client interface {
	// Broadcast access broadcast service.
	// Broadcast service will always be available.
	// When streaming service is enabled, the broadcast will use the streaming service.
	// When streaming service is disabled, the broadcast will use legacy msgstream.
	Broadcast() BroadcastService

	// Assignment access assignment service.
	// Assignment service will only be available when streaming service is enabled.
	Assignment() AssignmentService

	// Close close the client.
	Close()
}

Client is the interface of log service client.

func NewClient

func NewClient(etcdCli *clientv3.Client) Client

NewClient creates a new client.