* Copyright (C) 2005 by Dominic Rath *
* Dominic.Rath@gmx.de *
* *
+ * Copyright (C) 2007,2008 Øyvind Harboe *
+ * oyvind.harboe@zylin.com *
+ * *
+ * 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 *
* Free Software Foundation, Inc., *
* 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
***************************************************************************/
+
#ifndef SERVER_H
#define SERVER_H
-#include "command.h"
-#include "binarybuffer.h"
-#include "replacements.h"
+#include <helper/log.h>
-#include <sys/types.h>
+#ifdef HAVE_NETINET_IN_H
+#include <netinet/in.h>
+#endif
-enum connection_type
-{
- CONNECTION_GDB,
- CONNECTION_TELNET,
+enum connection_type {
+ CONNECTION_TCP,
+ CONNECTION_PIPE,
+ CONNECTION_STDINOUT
};
-typedef struct connection_s
-{
+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
-{
- char *name;
+struct service {
+ const char *name;
enum connection_type type;
- unsigned short port;
+ const 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 server_preinit(void);
+int server_init(struct command_context *cmd_ctx);
+int server_quit(void);
+
+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);
+
+/**
+ * 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.
+ */
+#define SERVER_PIPE_COMMAND() \
+ COMMAND_HELPER(server_pipe_command, const char **out)
+SERVER_PIPE_COMMAND();
+
+#define SERVER_PORT_COMMAND() \
+ COMMAND_HELPER(server_port_command, unsigned short *out)
-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();
-extern int server_loop(command_context_t *command_context);
-extern int server_register_commands(command_context_t *context);
+SERVER_PORT_COMMAND();
-#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 /* SERVER_H */