// Copyright 2022 PingCAP, Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// See the License for the specific language governing permissions and
// limitations under the License.

package dmlsink

// EventSink is the interface for event sink.
type EventSink[E TableEvent] interface {
	// WriteEvents writes events to the sink.
	// This is an asynchronously and thread-safe method.
	WriteEvents(events ...*CallbackableEvent[E]) error
	// SchemeOption returns the sink scheme and whether the sink should output raw change event.
	SchemeOption() (scheme string, outputRawChangeEvent bool)
	// Close closes the sink. Can be called with `WriteEvents` concurrently.
	Close()
	// The EventSink meets internal errors and has been dead already.
	Dead() <-chan struct{}
}