broadcaster

type AppendOperator interface {
	AppendMessages(ctx context.Context, msgs ...message.MutableMessage) types.AppendResponses
}

type BroadcastAPI interface {
	// Broadcast broadcasts the message to all channels.
	Broadcast(ctx context.Context, msg message.BroadcastMutableMessage) (*types.BroadcastAppendResult, error)

	// Close releases the resource keys that broadcast api holds.
	Close()
}

type Broadcaster interface {
	// WithResourceKeys sets the resource keys of the broadcast operation.
	// It will acquire locks of the resource keys and return the broadcast api.
	// Once the broadcast api is returned, the Close() method of the broadcast api should be called to release the resource safely.
	// Return ErrNotPrimary if the cluster is not primary, so no DDL message can be broadcasted.
	WithResourceKeys(ctx context.Context, resourceKeys ...message.ResourceKey) (BroadcastAPI, error)

	// LegacyAck is the legacy ack interface for the 2.6.0 import message.
	LegacyAck(ctx context.Context, broadcastID uint64, vchannel string) error

	// Ack acknowledges the message at the specified vchannel.
	Ack(ctx context.Context, msg message.ImmutableMessage) error

	// Close closes the broadcaster.
	Close()
}