github.com/pingcap/tiflow@v0.0.0-20240520035814-5bf52d54e205/cdc/scheduler/internal/info_provider.go (about)

     1  // Copyright 2021 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 internal
    15  
    16  import (
    17  	"github.com/pingcap/tiflow/cdc/model"
    18  )
    19  
    20  // InfoProvider is the interface to get information about the internal states of the scheduler.
    21  // We need this interface so that we can provide the information through HTTP API.
    22  type InfoProvider interface {
    23  	// IsInitialized returns a boolean indicates whether the scheduler is
    24  	// initialized.
    25  	IsInitialized() bool
    26  
    27  	// GetTaskStatuses returns the task statuses.
    28  	GetTaskStatuses() (map[model.CaptureID]*model.TaskStatus, error)
    29  }