github.com/pingcap/tiflow@v0.0.0-20240520035814-5bf52d54e205/pkg/sink/kafka/v2/writer.go (about)

     1  // Copyright 2023 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 v2
    15  
    16  import (
    17  	"context"
    18  
    19  	"github.com/segmentio/kafka-go"
    20  )
    21  
    22  // Writer is the interface of the kafka-go writer, it contains a subset of all methods which is used
    23  // by the kafka sink.
    24  // This interface is mainly used to support mock kafka-go client in unit test.
    25  type Writer interface {
    26  	Stats() kafka.WriterStats
    27  	WriteMessages(ctx context.Context, msgs ...kafka.Message) error
    28  	Close() error
    29  }