X-Git-Url: http://git.droids-corp.org/?a=blobdiff_plain;f=lib%2Flibrte_cmdline%2Fcmdline.h;h=65d73b01b81e2959a9c4771492fd317c27a49867;hb=ca33faf9ef10;hp=9085ff6955669b0cc129a0b067a26285f05ff2d9;hpb=d69447f916463f4336add38416b4a25437346754;p=dpdk.git diff --git a/lib/librte_cmdline/cmdline.h b/lib/librte_cmdline/cmdline.h index 9085ff6955..65d73b01b8 100644 --- a/lib/librte_cmdline/cmdline.h +++ b/lib/librte_cmdline/cmdline.h @@ -63,6 +63,13 @@ #include #include +#include + +/** + * @file + * + * Command line API + */ #ifdef __cplusplus extern "C" { @@ -84,6 +91,21 @@ void cmdline_printf(const struct cmdline *cl, const char *fmt, ...) __attribute__((format(printf,2,3))); int cmdline_in(struct cmdline *cl, const char *buf, int size); int cmdline_write_char(struct rdline *rdl, char c); + +/** + * 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);