sigs.k8s.io/cluster-api@v1.7.1/controllers/remote/stoppable_cache.go (about)

     1  /*
     2  Copyright 2020 The Kubernetes Authors.
     3  
     4  Licensed under the Apache License, Version 2.0 (the "License");
     5  you may not use this file except in compliance with the License.
     6  You may obtain a copy of the License at
     7  
     8      http://www.apache.org/licenses/LICENSE-2.0
     9  
    10  Unless required by applicable law or agreed to in writing, software
    11  distributed under the License is distributed on an "AS IS" BASIS,
    12  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    13  See the License for the specific language governing permissions and
    14  limitations under the License.
    15  */
    16  
    17  package remote
    18  
    19  import (
    20  	"context"
    21  	"sync"
    22  
    23  	"sigs.k8s.io/controller-runtime/pkg/cache"
    24  )
    25  
    26  // stoppableCache embeds cache.Cache and combines it with a stop channel.
    27  type stoppableCache struct {
    28  	cache.Cache
    29  
    30  	lock       sync.Mutex
    31  	stopped    bool
    32  	cancelFunc context.CancelFunc
    33  }
    34  
    35  // Stop cancels the cache.Cache's context, unless it has already been stopped.
    36  func (cc *stoppableCache) Stop() {
    37  	cc.lock.Lock()
    38  	defer cc.lock.Unlock()
    39  
    40  	if cc.stopped {
    41  		return
    42  	}
    43  
    44  	cc.stopped = true
    45  	cc.cancelFunc()
    46  }