mirror of
https://github.com/haproxy/haproxy.git
synced 2026-02-03 20:39:41 -05:00
abbf607105
In order to use arbitrary data in the CLI (multiple lines or group of words that must be considered as a whole, for example), it is now possible to add a payload to the commands. To do so, the first line needs to end with a special pattern: <<\n. Everything that follows will be left untouched by the CLI parser and will be passed to the commands parsers. Per-command support will need to be added to take advantage of this feature. Signed-off-by: Aurélien Nephtali <aurelien.nephtali@corp.ovh.com>
62 lines
2.2 KiB
C
62 lines
2.2 KiB
C
/*
|
|
* include/types/cli.h
|
|
* This file provides structures and types for CLI.
|
|
*
|
|
* This library is free software; you can redistribute it and/or
|
|
* modify it under the terms of the GNU Lesser General Public
|
|
* License as published by the Free Software Foundation, version 2.1
|
|
* exclusively.
|
|
*
|
|
* This library 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
|
|
* Lesser General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU Lesser General Public
|
|
* License along with this library; if not, write to the Free Software
|
|
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
|
|
*/
|
|
|
|
#ifndef _TYPES_CLI_H
|
|
#define _TYPES_CLI_H
|
|
|
|
#include <common/mini-clist.h>
|
|
#include <types/applet.h>
|
|
|
|
struct cli_kw {
|
|
const char *str_kw[5]; /* keywords ended by NULL, limited to 5
|
|
separated keywords combination */
|
|
const char *usage; /* usage message */
|
|
int (*parse)(char **args, char *payload, struct appctx *appctx, void *private);
|
|
int (*io_handler)(struct appctx *appctx);
|
|
void (*io_release)(struct appctx *appctx);
|
|
void *private;
|
|
};
|
|
|
|
struct cli_kw_list {
|
|
struct list list;
|
|
struct cli_kw kw[VAR_ARRAY];
|
|
};
|
|
|
|
/* CLI states */
|
|
enum {
|
|
CLI_ST_INIT = 0, /* initial state, must leave to zero ! */
|
|
CLI_ST_END, /* final state, let's close */
|
|
CLI_ST_GETREQ, /* wait for a request */
|
|
CLI_ST_OUTPUT, /* all states after this one are responses */
|
|
CLI_ST_PROMPT, /* display the prompt (first output, same code) */
|
|
CLI_ST_PRINT, /* display message in cli->msg */
|
|
CLI_ST_PRINT_FREE, /* display message in cli->msg. After the display, free the pointer */
|
|
CLI_ST_CALLBACK, /* custom callback pointer */
|
|
};
|
|
|
|
/* CLI severity output formats */
|
|
enum {
|
|
CLI_SEVERITY_UNDEFINED = 0, /* undefined severity format */
|
|
CLI_SEVERITY_NONE, /* no severity information prepended */
|
|
CLI_SEVERITY_NUMBER, /* prepend informational cli messages with a severity as number */
|
|
CLI_SEVERITY_STRING, /* prepend informational cli messages with a severity as string */
|
|
};
|
|
|
|
|
|
#endif /* _TYPES_CLI_H */
|