git.gag.com Git - fw/openocd/blob - src/server/server.h

   1 /***************************************************************************
   2  *   Copyright (C) 2005 by Dominic Rath                                    *
   3  *   Dominic.Rath@gmx.de                                                   *
   4  *                                                                         *
   5  *   Copyright (C) 2007,2008 Øyvind Harboe                                 *
   6  *   oyvind.harboe@zylin.com                                               *
   7  *                                                                         *
   8  *   Copyright (C) 2008 by Spencer Oliver                                  *
   9  *   spen@spen-soft.co.uk                                                  *
  10  *                                                                         *
  11  *   This program is free software; you can redistribute it and/or modify  *
  12  *   it under the terms of the GNU General Public License as published by  *
  13  *   the Free Software Foundation; either version 2 of the License, or     *
  14  *   (at your option) any later version.                                   *
  15  *                                                                         *
  16  *   This program is distributed in the hope that it will be useful,       *
  17  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  18  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
  19  *   GNU General Public License for more details.                          *
  20  *                                                                         *
  21  *   You should have received a copy of the GNU General Public License     *
  22  *   along with this program; if not, write to the                         *
  23  *   Free Software Foundation, Inc.,                                       *
  24  *   51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.           *
  25  ***************************************************************************/
  26
  27 #ifndef SERVER_H
  28 #define SERVER_H
  29
  30 #include <helper/log.h>
  31
  32 #ifdef HAVE_NETINET_IN_H
  33 #include <netinet/in.h>
  34 #endif
  35
  36 enum connection_type {
  37         CONNECTION_TCP,
  38         CONNECTION_PIPE,
  39         CONNECTION_STDINOUT
  40 };
  41
  42 #define CONNECTION_LIMIT_UNLIMITED              (-1)
  43
  44 struct connection {
  45         int fd;
  46         int fd_out;     /* When using pipes we're writing to a different fd */
  47         struct sockaddr_in sin;
  48         struct command_context *cmd_ctx;
  49         struct service *service;
  50         int input_pending;
  51         void *priv;
  52         struct connection *next;
  53 };
  54
  55 typedef int (*new_connection_handler_t)(struct connection *connection);
  56 typedef int (*input_handler_t)(struct connection *connection);
  57 typedef int (*connection_closed_handler_t)(struct connection *connection);
  58
  59 struct service {
  60         char *name;
  61         enum connection_type type;
  62         char *port;
  63         unsigned short portnumber;
  64         int fd;
  65         struct sockaddr_in sin;
  66         int max_connections;
  67         struct connection *connections;
  68         new_connection_handler_t new_connection;
  69         input_handler_t input;
  70         connection_closed_handler_t connection_closed;
  71         void *priv;
  72         struct service *next;
  73 };
  74
  75 int add_service(char *name, const char *port,
  76                 int max_connections, new_connection_handler_t new_connection_handler,
  77                 input_handler_t in_handler, connection_closed_handler_t close_handler,
  78                 void *priv);
  79
  80 int server_preinit(void);
  81 int server_init(struct command_context *cmd_ctx);
  82 int server_quit(void);
  83 void exit_on_signal(int);
  84
  85 int server_loop(struct command_context *command_context);
  86
  87 int server_register_commands(struct command_context *context);
  88
  89 int connection_write(struct connection *connection, const void *data, int len);
  90 int connection_read(struct connection *connection, void *data, int len);
  91
  92 /**
  93  * Used by server_loop(), defined in server_stubs.c
  94  */
  95 void openocd_sleep_prelude(void);
  96 /**
  97  * Used by server_loop(), defined in server_stubs.c
  98  */
  99 void openocd_sleep_postlude(void);
 100
 101 /**
 102  * Defines an extended command handler function declaration to enable
 103  * access to (and manipulation of) the server port number.
 104  * Call server_port like a normal COMMAND_HANDLER with an extra @a out parameter
 105  * to receive the specified port number.
 106  */
 107 COMMAND_HELPER(server_pipe_command, char **out);
 108
 109 COMMAND_HELPER(server_port_command, unsigned short *out);
 110
 111 #define ERROR_SERVER_REMOTE_CLOSED              (-400)
 112 #define ERROR_CONNECTION_REJECTED               (-401)
 113
 114 #endif  /* SERVER_H */