Documentation
¶
Overview ¶
Copyright (C) 2015-2018 Lightning Labs and The Lightning Network Developers Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Package intercept defines objects and related functions to monitor requests to shutdown the application
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Interceptor ¶
Interceptor is the object controlling application shutdown requests
func InitInterceptor ¶
func InitInterceptor() (*Interceptor, error)
InitInterceptor initializes the shutdown and interrupt interceptor
func (*Interceptor) RequestShutdown ¶
func (interceptor *Interceptor) RequestShutdown()
RequestShutdown initiates a graceful shutdown from the application.
func (*Interceptor) ShutdownChannel ¶
func (c *Interceptor) ShutdownChannel() <-chan struct{}
ShutdownChannel returns the channel that will be closed once the main interrupt handler has exited.