numam-dpdk/lib/cmdline/cmdline.h
Dmitry Kozlyuk f43809d28c cmdline: make struct cmdline opaque
Remove the definition of `struct cmdline` from public header.
Deprecation notice:
https://mails.dpdk.org/archives/dev/2020-September/183310.html

Signed-off-by: Dmitry Kozlyuk <dmitry.kozliuk@gmail.com>
Acked-by: David Marchand <david.marchand@redhat.com>
Acked-by: Olivier Matz <olivier.matz@6wind.com>
Acked-by: Narcisa Vasile <navasile@linux.microsoft.com>
2021-10-22 22:44:18 +02:00

62 lines
1.4 KiB
C

/* SPDX-License-Identifier: BSD-3-Clause
* Copyright(c) 2010-2014 Intel Corporation.
* Copyright (c) 2009, Olivier MATZ <zer0@droids-corp.org>
* All rights reserved.
*/
#ifndef _CMDLINE_H_
#define _CMDLINE_H_
#include <rte_common.h>
#include <rte_compat.h>
#include <cmdline_rdline.h>
#include <cmdline_parse.h>
/**
* @file
*
* Command line API
*/
#ifdef __cplusplus
extern "C" {
#endif
struct cmdline;
struct cmdline *cmdline_new(cmdline_parse_ctx_t *ctx, const char *prompt, int s_in, int s_out);
void cmdline_set_prompt(struct cmdline *cl, const char *prompt);
void cmdline_free(struct cmdline *cl);
void cmdline_printf(const struct cmdline *cl, const char *fmt, ...)
__rte_format_printf(2, 3);
int cmdline_in(struct cmdline *cl, const char *buf, int size);
int cmdline_write_char(struct rdline *rdl, char c);
__rte_experimental
struct rdline *
cmdline_get_rdline(struct cmdline *cl);
/**
* This function is nonblocking equivalent of ``cmdline_interact()``. It polls
* *cl* for one character and interpret it. If return value is *RDLINE_EXITED*
* it mean that ``cmdline_quit()`` was invoked.
*
* @param cl
* The command line object.
*
* @return
* On success return object status - one of *enum rdline_status*.
* On error return negative value.
*/
int cmdline_poll(struct cmdline *cl);
void cmdline_interact(struct cmdline *cl);
void cmdline_quit(struct cmdline *cl);
#ifdef __cplusplus
}
#endif
#endif /* _CMDLINE_SOCKET_H_ */