github.com/pingcap/tiflow@v0.0.0-20240520035814-5bf52d54e205/engine/servermaster/scheduler/filter.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 scheduler
    15  
    16  import (
    17  	"context"
    18  
    19  	"github.com/pingcap/tiflow/engine/model"
    20  	schedModel "github.com/pingcap/tiflow/engine/servermaster/scheduler/model"
    21  )
    22  
    23  type filter interface {
    24  	// GetEligibleExecutors determines which executors are eligible
    25  	// from a list of candidates.
    26  	//
    27  	// An implementation should guarantee that an informative error
    28  	// is returned if no suitable executor is found.
    29  	GetEligibleExecutors(
    30  		ctx context.Context,
    31  		request *schedModel.SchedulerRequest,
    32  		// candidates is the range of executors to choose from,
    33  		// may be the output of another filter.
    34  		candidates []model.ExecutorID,
    35  	) ([]model.ExecutorID, error)
    36  }