github.com/m3db/m3@v1.5.1-0.20231129193456-75a402aa583b/src/integration/resources/inprocess/common.go (about)

     1  // Copyright (c) 2021  Uber Technologies, Inc.
     2  //
     3  // Permission is hereby granted, free of charge, to any person obtaining a copy
     4  // of this software and associated documentation files (the "Software"), to deal
     5  // in the Software without restriction, including without limitation the rights
     6  // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
     7  // copies of the Software, and to permit persons to whom the Software is
     8  // furnished to do so, subject to the following conditions:
     9  //
    10  // The above copyright notice and this permission notice shall be included in
    11  // all copies or substantial portions of the Software.
    12  //
    13  // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    14  // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    15  // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
    16  // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    17  // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
    18  // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
    19  // THE SOFTWARE.
    20  
    21  package inprocess
    22  
    23  import (
    24  	aggcfg "github.com/m3db/m3/src/cmd/services/m3aggregator/config"
    25  	dbnodecfg "github.com/m3db/m3/src/cmd/services/m3dbnode/config"
    26  	coordcfg "github.com/m3db/m3/src/cmd/services/m3query/config"
    27  )
    28  
    29  // DBNodeStartFn is a custom function that can be used to start a DB node.
    30  // Function must return a channel for interrupting the server and
    31  // a channel for receiving notifications that the server has shut down.
    32  type DBNodeStartFn func(cfg *dbnodecfg.Configuration) (chan<- error, <-chan struct{})
    33  
    34  // CoordinatorStartFn is a custom function that can be used to start a coordinator.
    35  // Function must return a channel for interrupting the server and
    36  // a channel for receiving notifications that the server has shut down.
    37  type CoordinatorStartFn func(cfg *coordcfg.Configuration) (chan<- error, <-chan struct{})
    38  
    39  // AggregatorStartFn is a custom function that can be used to start an aggregator.
    40  // Function must return a channel for interrupting the server and
    41  // a channel for receiving notifications that the server has shut down.
    42  type AggregatorStartFn func(cfg *aggcfg.Configuration) (chan<- error, <-chan struct{})