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

     1  // © Broadcom. All Rights Reserved.
     2  // The term “Broadcom” refers to Broadcom Inc. and/or its subsidiaries.
     3  // SPDX-License-Identifier: Apache-2.0
     4  
     5  package progress
     6  
     7  /*
     8  The progress package contains functionality to deal with progress reporting.
     9  The functionality is built to serve progress reporting for infrastructure
    10  operations when talking the vSphere API, but is generic enough to be used
    11  elsewhere.
    12  
    13  At the core of this progress reporting API lies the Sinker interface. This
    14  interface is implemented by any object that can act as a sink for progress
    15  reports. Callers of the Sink() function receives a send-only channel for
    16  progress reports. They are responsible for closing the channel when done.
    17  This semantic makes it easy to keep track of multiple progress report channels;
    18  they are only created when Sink() is called and assumed closed when any
    19  function that receives a Sinker parameter returns.
    20  */