7e6556b3ca
returning the created service seems useful:
as the only method to get the freshly created service is by getting the
last item in the services linked list, and this seems to be like an
intrusion to service internal mechanism.
possibly, we could get the service from a connection but this is possible
only from [new_connection|input|connection_closed]_handler_t, but this is
not always practical:
example: armv7m: add a TCP channel to stream captured trace
http://openocd.zylin.com/#/c/5345/
here we poll for trace and broadcast to all connections
outside of these xxx_handler_t functions
also, storing one of the connections in new_connection_handler_t and get
the service from it is possible, but this will make the code less readable.
Change-Id: I5fef1baecec1e054953c6faf5b99d864ecc97f02
Signed-off-by: Tarek BOCHKATI <tarek.bouchkati@gmail.com>
Reviewed-on: http://openocd.zylin.com/5717
Reviewed-by: Antonio Borneo <borneo.antonio@gmail.com>
Tested-by: jenkins
122 lines
4.3 KiB
C
122 lines
4.3 KiB
C
/***************************************************************************
|
|
* 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 *
|
|
* (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
|
|
#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 {
|
|
CONNECTION_TCP,
|
|
CONNECTION_PIPE,
|
|
CONNECTION_STDINOUT
|
|
};
|
|
|
|
#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;
|
|
struct command_context *cmd_ctx;
|
|
struct service *service;
|
|
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 {
|
|
char *name;
|
|
enum connection_type type;
|
|
char *port;
|
|
unsigned short portnumber;
|
|
int fd;
|
|
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;
|
|
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, struct service **new_service);
|
|
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 sig);
|
|
|
|
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.
|
|
*/
|
|
COMMAND_HELPER(server_pipe_command, char **out);
|
|
|
|
COMMAND_HELPER(server_port_command, unsigned short *out);
|
|
|
|
#define ERROR_SERVER_REMOTE_CLOSED (-400)
|
|
#define ERROR_CONNECTION_REJECTED (-401)
|
|
|
|
#endif /* OPENOCD_SERVER_SERVER_H */
|