Interface JsonRpcShutdownService

All Known Implementing Classes:
JsonRpcShutdownService.NoopShutdownService, MicronautJsonRpcShutdownService, MicronautJsonRpcShutdownService
public interface JsonRpcShutdownService
Implementations of this interface initiate shutting down the (server) application that is hosting a JsonRpcService. It is expected that the server-shutdown process will in turn call the AutoCloseable.close() method at a later time.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static class 
    JsonRpcShutdownService.NoopShutdownService
    Trivial implementation for simple servers, unit tests, etc.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    stopServer()
    This method will initiate a server shutdown.

  • Method Details

    • stopServer

      String stopServer()
      This method will initiate a server shutdown. Implementations MUST not shut down until after the caller of this method is able to return a response to a client.
      Returns:
      A shutdown message (e.g. "echod stopping") to return to the client.