github.com/theQRL/go-zond@v0.1.1/node/lifecycle.go (about)

     1  // Copyright 2020 The go-ethereum Authors
     2  // This file is part of the go-ethereum library.
     3  //
     4  // The go-ethereum library is free software: you can redistribute it and/or modify
     5  // it under the terms of the GNU Lesser General Public License as published by
     6  // the Free Software Foundation, either version 3 of the License, or
     7  // (at your option) any later version.
     8  //
     9  // The go-ethereum library is distributed in the hope that it will be useful,
    10  // but WITHOUT ANY WARRANTY; without even the implied warranty of
    11  // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
    12  // GNU Lesser General Public License for more details.
    13  //
    14  // You should have received a copy of the GNU Lesser General Public License
    15  // along with the go-ethereum library. If not, see <http://www.gnu.org/licenses/>.
    16  
    17  package node
    18  
    19  // Lifecycle encompasses the behavior of services that can be started and stopped
    20  // on the node. Lifecycle management is delegated to the node, but it is the
    21  // responsibility of the service-specific package to configure and register the
    22  // service on the node using the `RegisterLifecycle` method.
    23  type Lifecycle interface {
    24  	// Start is called after all services have been constructed and the networking
    25  	// layer was also initialized to spawn any goroutines required by the service.
    26  	Start() error
    27  
    28  	// Stop terminates all goroutines belonging to the service, blocking until they
    29  	// are all terminated.
    30  	Stop() error
    31  }