vitess.io/vitess@v0.16.2/go/vt/logutil/flush.go (about)

     1  /*
     2  Copyright 2019 The Vitess 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 logutil
    18  
    19  import (
    20  	"vitess.io/vitess/go/event"
    21  )
    22  
    23  var (
    24  	onFlushHooks event.Hooks
    25  )
    26  
    27  // OnFlush registers a function to be called when Flush() is invoked.
    28  func OnFlush(fn func()) {
    29  	onFlushHooks.Add(fn)
    30  }
    31  
    32  // Flush calls the functions registered through OnFlush() and waits for them.
    33  //
    34  // Programs that use servenv.Run*() will invoke Flush() automatically at
    35  // shutdown. Other programs should defer logutil.Flush() at the beginning of
    36  // main().
    37  //
    38  // Concurrent calls to Flush are serialized.
    39  func Flush() {
    40  	onFlushHooks.Fire()
    41  }