server: add function to get openocd shutdown status

[fw/openocd] / src / server / server.h

diff --git a/src/server/server.h b/src/server/server.h
index 96e0b48efea751ad8a5d998f920a86f447583c5c..c9d4698af8094e80f5cb2ac8f728ccb1527bfe1b 100644 (file)
--- a/src/server/server.h
+++ b/src/server/server.h
@@ -1,3 +1,5 @@
+/* SPDX-License-Identifier: GPL-2.0-or-later */
+
 /***************************************************************************
  *   Copyright (C) 2005 by Dominic Rath                                    *
  *   Dominic.Rath@gmx.de                                                   *
@@ -7,19 +9,6 @@
  *                                                                         *
  *   Copyright (C) 2008 by Spencer Oliver                                  *
  *   spen@spen-soft.co.uk                                                  *
- *                                                                         *
- *   This program is free software; you can redistribute it and/or modify  *
- *   it under the terms of the GNU General Public License as published by  *
- *   the Free Software Foundation; either version 2 of the License, or     *
- *   (at your option) any later version.                                   *
- *                                                                         *
- *   This program is distributed in the hope that it will be useful,       *
- *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
- *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
- *   GNU General Public License for more details.                          *
- *                                                                         *
- *   You should have received a copy of the GNU General Public License     *
- *   along with this program.  If not, see <http://www.gnu.org/licenses/>. *
  ***************************************************************************/
 
 #ifndef OPENOCD_SERVER_SERVER_H
@@ -30,6 +19,7 @@
 #endif
 
 #include <helper/log.h>
+#include <helper/replacements.h>
 
 #ifdef HAVE_NETINET_IN_H
 #include <netinet/in.h>
@@ -49,14 +39,30 @@ struct connection {
        struct sockaddr_in sin;
        struct command_context *cmd_ctx;
        struct service *service;
-       int input_pending;
+       bool input_pending;
        void *priv;
        struct connection *next;
 };
 
-typedef int (*new_connection_handler_t)(struct connection *connection);
-typedef int (*input_handler_t)(struct connection *connection);
-typedef int (*connection_closed_handler_t)(struct connection *connection);
+struct service_driver {
+       /** the name of the server */
+       const char *name;
+       /** optional minimal setup to accept a connection during keep-alive */
+       int (*new_connection_during_keep_alive_handler)(struct connection *connection);
+       /**
+        * complete code to accept a new connection.
+        * If 'new_connection_during_keep_alive_handler' above is present, this can be
+        * either called alone during the server_loop, or after the function above.
+        * Check the implementation in gdb_server.
+        * */
+       int (*new_connection_handler)(struct connection *connection);
+       /** callback to handle incoming data */
+       int (*input_handler)(struct connection *connection);
+       /** callback to tear down the connection */
+       int (*connection_closed_handler)(struct connection *connection);
+       /** called periodically to send keep-alive messages on the connection */
+       void (*keep_client_alive_handler)(struct connection *connection);
+};
 
 struct service {
        char *name;
@@ -67,24 +73,29 @@ struct service {
        struct sockaddr_in sin;
        int max_connections;
        struct connection *connections;
-       new_connection_handler_t new_connection;
-       input_handler_t input;
-       connection_closed_handler_t connection_closed;
+       int (*new_connection_during_keep_alive)(struct connection *connection);
+       int (*new_connection)(struct connection *connection);
+       int (*input)(struct connection *connection);
+       int (*connection_closed)(struct connection *connection);
+       void (*keep_client_alive)(struct connection *connection);
        void *priv;
        struct service *next;
 };
 
-int add_service(char *name, const char *port,
-               int max_connections, new_connection_handler_t new_connection_handler,
-               input_handler_t in_handler, connection_closed_handler_t close_handler,
-               void *priv);
+int add_service(const struct service_driver *driver, const char *port,
+               int max_connections, void *priv);
 int remove_service(const char *name, const char *port);
 
+int server_host_os_entry(void);
+int server_host_os_close(void);
+
 int server_preinit(void);
 int server_init(struct command_context *cmd_ctx);
 int server_quit(void);
 void server_free(void);
-void exit_on_signal(int);
+void exit_on_signal(int sig);
+
+void server_keep_clients_alive(void);
 
 int server_loop(struct command_context *command_context);
 
@@ -93,14 +104,7 @@ int server_register_commands(struct command_context *context);
 int connection_write(struct connection *connection, const void *data, int len);
 int connection_read(struct connection *connection, void *data, int len);
 
-/**
- * Used by server_loop(), defined in server_stubs.c
- */
-void openocd_sleep_prelude(void);
-/**
- * Used by server_loop(), defined in server_stubs.c
- */
-void openocd_sleep_postlude(void);
+bool openocd_is_shutdown_pending(void);
 
 /**
  * Defines an extended command handler function declaration to enable