github.com/timstclair/heapster@v0.20.0-alpha1/Godeps/_workspace/src/k8s.io/kubernetes/pkg/client/cache/doc.go (about)

     1  /*
     2  Copyright 2014 The Kubernetes Authors All rights reserved.
     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 cache is a client-side caching mechanism. It is useful for
    18  // reducing the number of server calls you'd otherwise need to make.
    19  // Reflector watches a server and updates a Store. Two stores are provided;
    20  // one that simply caches objects (for example, to allow a scheduler to
    21  // list currently available nodes), and one that additionally acts as
    22  // a FIFO queue (for example, to allow a scheduler to process incoming
    23  // pods).
    24  package cache