server/server: Add ability to remove services

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

diff --git a/src/server/server.h b/src/server/server.h
index bfb862007952a1033838819dc947a45ebf09e829..96e0b48efea751ad8a5d998f920a86f447583c5c 100644 (file)
--- a/src/server/server.h
+++ b/src/server/server.h
@@ -2,7 +2,7 @@
  *   Copyright (C) 2005 by Dominic Rath                                    *
  *   Dominic.Rath@gmx.de                                                   *
  *                                                                         *
- *   Copyright (C) 2007,2008 Øyvind Harboe                                 *
+ *   Copyright (C) 2007,2008 Øyvind Harboe                                 *
  *   oyvind.harboe@zylin.com                                               *
  *                                                                         *
  *   Copyright (C) 2008 by Spencer Oliver                                  *
@@ -19,65 +19,100 @@
  *   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, write to the                         *
- *   Free Software Foundation, Inc.,                                       *
- *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
+ *   along with this program.  If not, see <http://www.gnu.org/licenses/>. *
  ***************************************************************************/
-#ifndef SERVER_H
-#define SERVER_H
 
-#include "log.h"
+#ifndef OPENOCD_SERVER_SERVER_H
+#define OPENOCD_SERVER_SERVER_H
+
+#ifdef HAVE_CONFIG_H
+#include "config.h"
+#endif
+
+#include <helper/log.h>
 
 #ifdef HAVE_NETINET_IN_H
 #include <netinet/in.h>
 #endif
 
-enum connection_type
-{
+enum connection_type {
        CONNECTION_TCP,
-       CONNECTION_PIPE
+       CONNECTION_PIPE,
+       CONNECTION_STDINOUT
 };
 
-typedef struct connection_s
-{
+#define CONNECTION_LIMIT_UNLIMITED             (-1)
+
+struct connection {
        int fd;
+       int fd_out;     /* When using pipes we're writing to a different fd */
        struct sockaddr_in sin;
-       command_context_t *cmd_ctx;
-       struct service_s *service;
+       struct command_context *cmd_ctx;
+       struct service *service;
        int input_pending;
        void *priv;
-       struct connection_s *next;
-} connection_t;
+       struct connection *next;
+};
 
-typedef int (*new_connection_handler_t)(connection_t *connection);
-typedef int (*input_handler_t)(connection_t *connection);
-typedef int (*connection_closed_handler_t)(connection_t *connection);
+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);
 
-typedef struct service_s
-{
+struct service {
        char *name;
        enum connection_type type;
-       unsigned short port;
+       char *port;
+       unsigned short portnumber;
        int fd;
        struct sockaddr_in sin;
        int max_connections;
-       connection_t *connections;
+       struct connection *connections;
        new_connection_handler_t new_connection;
        input_handler_t input;
        connection_closed_handler_t connection_closed;
        void *priv;
-       struct service_s *next;
-} service_t;
+       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 remove_service(const char *name, const char *port);
+
+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);
+
+int server_loop(struct command_context *command_context);
+
+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);
 
-extern int add_service(char *name, enum connection_type type, unsigned short port, int max_connections, new_connection_handler_t new_connection_handler, input_handler_t input_handler, connection_closed_handler_t connection_closed_handler, void *priv);
-extern int server_init(void);
-extern int server_quit(void);
-extern int server_loop(command_context_t *command_context);
-extern int server_register_commands(command_context_t *context);
+/**
+ * Defines an extended command handler function declaration to enable
+ * access to (and manipulation of) the server port number.
+ * Call server_port like a normal COMMAND_HANDLER with an extra @a out parameter
+ * to receive the specified port number.
+ */
+COMMAND_HELPER(server_pipe_command, char **out);
 
-extern int server_use_pipes;
+COMMAND_HELPER(server_port_command, unsigned short *out);
 
-#define ERROR_SERVER_REMOTE_CLOSED     (-400)
-#define ERROR_CONNECTION_REJECTED      (-401)
+#define ERROR_SERVER_REMOTE_CLOSED             (-400)
+#define ERROR_CONNECTION_REJECTED              (-401)
 
-#endif /* SERVER_H */
+#endif /* OPENOCD_SERVER_SERVER_H */