github.com/pingcap/tiflow@v0.0.0-20240520035814-5bf52d54e205/cdc/sink/dmlsink/event_sink.go (about)

     1  // Copyright 2022 PingCAP, Inc.
     2  //
     3  // Licensed under the Apache License, Version 2.0 (the "License");
     4  // you may not use this file except in compliance with the License.
     5  // You may obtain a copy of the License at
     6  //
     7  //     http://www.apache.org/licenses/LICENSE-2.0
     8  //
     9  // Unless required by applicable law or agreed to in writing, software
    10  // distributed under the License is distributed on an "AS IS" BASIS,
    11  // See the License for the specific language governing permissions and
    12  // limitations under the License.
    13  
    14  package dmlsink
    15  
    16  // EventSink is the interface for event sink.
    17  type EventSink[E TableEvent] interface {
    18  	// WriteEvents writes events to the sink.
    19  	// This is an asynchronously and thread-safe method.
    20  	WriteEvents(events ...*CallbackableEvent[E]) error
    21  
    22  	// Scheme returns the sink scheme.
    23  	Scheme() string
    24  
    25  	// Close closes the sink. Can be called with `WriteEvents` concurrently.
    26  	Close()
    27  	// The EventSink meets internal errors and has been dead already.
    28  	Dead() <-chan struct{}
    29  }