github.com/pingcap/tiflow@v0.0.0-20240520035814-5bf52d54e205/pkg/workerpool/async_pool.go (about)

     1  // Copyright 2020 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 workerpool
    15  
    16  import "context"
    17  
    18  // AsyncPool provides a simple Goroutine pool, where the order in which jobs are run is non-deterministic.
    19  type AsyncPool interface {
    20  	// Go mimics the semantics of the "go" keyword, with the only difference being the `ctx` parameter,
    21  	// which is used to cancel **the submission of task**.
    22  	// **All** tasks successfully submitted will be run eventually, as long as Run are called infinitely many times.
    23  	// Go might block when the AsyncPool is not running.
    24  	Go(ctx context.Context, f func()) error
    25  
    26  	// Run runs the AsyncPool.
    27  	Run(ctx context.Context) error
    28  }