github.com/vmware/govmomi@v0.43.0/vim25/progress/doc.go (about)

     1  /*
     2  Copyright (c) 2014 VMware, Inc. 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 progress
    18  
    19  /*
    20  The progress package contains functionality to deal with progress reporting.
    21  The functionality is built to serve progress reporting for infrastructure
    22  operations when talking the vSphere API, but is generic enough to be used
    23  elsewhere.
    24  
    25  At the core of this progress reporting API lies the Sinker interface. This
    26  interface is implemented by any object that can act as a sink for progress
    27  reports. Callers of the Sink() function receives a send-only channel for
    28  progress reports. They are responsible for closing the channel when done.
    29  This semantic makes it easy to keep track of multiple progress report channels;
    30  they are only created when Sink() is called and assumed closed when any
    31  function that receives a Sinker parameter returns.
    32  */