github.com/pingcap/tiflow@v0.0.0-20240520035814-5bf52d54e205/cdc/scheduler/internal/agent.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 "context" 18 19 "github.com/pingcap/tiflow/cdc/scheduler/schedulepb" 20 ) 21 22 // Agent is an interface for an object inside Processor that is responsible 23 // for receiving commands from the Owner. 24 // Ideally the processor should drive the Agent by Tick. 25 // 26 // Note that Agent is not thread-safe 27 type Agent interface { 28 // Tick is called periodically by the processor to drive the Agent's internal logic. 29 Tick(context.Context) (*schedulepb.Barrier, error) 30 31 // Close closes the messenger and does the necessary cleanup. 32 Close() error 33 }