milvus/internal/proxy/condition.go
congqixia af1402dcb8
Add comment and implementation assertion for proxy condition.go (#9576)
Signed-off-by: Congqi Xia <congqi.xia@zilliz.com>
2021-10-09 21:01:18 +08:00

64 lines
1.7 KiB
Go

// Copyright (C) 2019-2020 Zilliz. All rights reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance
// with the License. You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software distributed under the License
// is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
// or implied. See the License for the specific language governing permissions and limitations under the License.
package proxy
import (
"context"
"errors"
)
// Condition defines the interface of variable condition.
type Condition interface {
WaitToFinish() error
Notify(err error)
Ctx() context.Context
}
// make sure interface implementation
var _ Condition = (*TaskCondition)(nil)
// TaskCondition implements Condition interface for tasks
type TaskCondition struct {
done chan error
ctx context.Context
}
// WaitToFinish waits until the TaskCondition is notified or context done or canceled
func (tc *TaskCondition) WaitToFinish() error {
for {
select {
case <-tc.ctx.Done():
return errors.New("Proxy TaskCondition context Done")
case err := <-tc.done:
return err
}
}
}
// Notify sends a signal into the done channel
func (tc *TaskCondition) Notify(err error) {
tc.done <- err
}
// Ctx returns internal context
func (tc *TaskCondition) Ctx() context.Context {
return tc.ctx
}
// NewTaskCondition creates a TaskCondition with provided context
func NewTaskCondition(ctx context.Context) *TaskCondition {
return &TaskCondition{
done: make(chan error, 1),
ctx: ctx,
}
}