github.com/mysteriumnetwork/node@v0.0.0-20240516044423-365054f76801/tequilapi/endpoints/stop.go (about)

     1  /*
     2   * Copyright (C) 2017 The "MysteriumNetwork/node" Authors.
     3   *
     4   * This program is free software: you can redistribute it and/or modify
     5   * it under the terms of the GNU 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   * This program 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 General Public License for more details.
    13   *
    14   * You should have received a copy of the GNU General Public License
    15   * along with this program.  If not, see <http://www.gnu.org/licenses/>.
    16   */
    17  
    18  package endpoints
    19  
    20  import (
    21  	"net/http"
    22  
    23  	"github.com/gin-gonic/gin"
    24  
    25  	"github.com/rs/zerolog/log"
    26  )
    27  
    28  // ApplicationStopper stops application and performs required cleanup tasks
    29  type ApplicationStopper func()
    30  
    31  // AddRouteForStop adds stop route to given router
    32  func AddRouteForStop(stop ApplicationStopper) func(*gin.Engine) error {
    33  	return func(e *gin.Engine) error {
    34  		e.POST("/stop", newStopHandler(stop))
    35  		return nil
    36  	}
    37  }
    38  
    39  // swagger:operation POST /stop Client applicationStop
    40  //
    41  //	---
    42  //	summary: Stops client
    43  //	description: Initiates client termination
    44  //	responses:
    45  //	  202:
    46  //	    description: Request accepted, stopping
    47  func newStopHandler(stop ApplicationStopper) func(*gin.Context) {
    48  	return func(c *gin.Context) {
    49  		log.Info().Msg("Application stop requested")
    50  
    51  		go callStopWhenNotified(c.Request.Context().Done(), stop)
    52  		c.Status(http.StatusAccepted)
    53  	}
    54  }
    55  func callStopWhenNotified(notify <-chan struct{}, stopApplication ApplicationStopper) {
    56  	<-notify
    57  	stopApplication()
    58  }