1 /***************************************************************************
2 * Copyright (C) 2005 by Dominic Rath *
3 * Dominic.Rath@gmx.de *
5 * Copyright (C) 2007,2008 Øyvind Harboe *
6 * oyvind.harboe@zylin.com *
8 * Copyright (C) 2008 by Spencer Oliver *
9 * spen@spen-soft.co.uk *
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. *
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. *
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 ***************************************************************************/
30 #include <helper/log.h>
32 #ifdef HAVE_NETINET_IN_H
33 #include <netinet/in.h>
36 enum connection_type
{
44 int fd_out
; /* When using pipes we're writing to a different fd */
45 struct sockaddr_in sin
;
46 struct command_context
*cmd_ctx
;
47 struct service
*service
;
50 struct connection
*next
;
53 typedef int (*new_connection_handler_t
)(struct connection
*connection
);
54 typedef int (*input_handler_t
)(struct connection
*connection
);
55 typedef int (*connection_closed_handler_t
)(struct connection
*connection
);
59 enum connection_type type
;
61 unsigned short portnumber
;
63 struct sockaddr_in sin
;
65 struct connection
*connections
;
66 new_connection_handler_t new_connection
;
67 input_handler_t input
;
68 connection_closed_handler_t connection_closed
;
73 int add_service(char *name
, const char *port
,
74 int max_connections
, new_connection_handler_t new_connection_handler
,
75 input_handler_t in_handler
, connection_closed_handler_t close_handler
,
78 int server_preinit(void);
79 int server_init(struct command_context
*cmd_ctx
);
80 int server_quit(void);
82 int server_loop(struct command_context
*command_context
);
84 int server_register_commands(struct command_context
*context
);
86 int connection_write(struct connection
*connection
, const void *data
, int len
);
87 int connection_read(struct connection
*connection
, void *data
, int len
);
90 * Used by server_loop(), defined in server_stubs.c
92 void openocd_sleep_prelude(void);
94 * Used by server_loop(), defined in server_stubs.c
96 void openocd_sleep_postlude(void);
99 * Defines an extended command handler function declaration to enable
100 * access to (and manipulation of) the server port number.
101 * Call server_port like a normal COMMAND_HANDLER with an extra @a out parameter
102 * to receive the specified port number.
104 COMMAND_HELPER(server_pipe_command
, char **out
);
106 COMMAND_HELPER(server_port_command
, unsigned short *out
);
108 #define ERROR_SERVER_REMOTE_CLOSED (-400)
109 #define ERROR_CONNECTION_REJECTED (-401)
111 #endif /* SERVER_H */