git.droids-corp.org
/
dpdk.git
/ blobdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
|
commitdiff
|
tree
raw
|
inline
| side by side
fm10k: fix Tx queue cleaning after start error
[dpdk.git]
/
lib
/
librte_kvargs
/
rte_kvargs.h
diff --git
a/lib/librte_kvargs/rte_kvargs.h
b/lib/librte_kvargs/rte_kvargs.h
index
25e086f
..
ae9ae79
100644
(file)
--- a/
lib/librte_kvargs/rte_kvargs.h
+++ b/
lib/librte_kvargs/rte_kvargs.h
@@
-40,7
+40,11
@@
* RTE Argument parsing
*
* This module can be used to parse arguments whose format is
* RTE Argument parsing
*
* This module can be used to parse arguments whose format is
- * key1=value1;key2=value2;key3=value3;...
+ * key1=value1,key2=value2,key3=value3,...
+ *
+ * The same key can appear several times with the same or a different
+ * value. Indeed, the arguments are stored as a list of key/values
+ * associations and not as a dictionary.
*
* This file provides some helpers that are especially used by virtual
* ethernet devices at initialization for arguments parsing.
*
* This file provides some helpers that are especially used by virtual
* ethernet devices at initialization for arguments parsing.
@@
-54,13
+58,13
@@
extern "C" {
#define RTE_KVARGS_MAX 32
/** separator character used between each pair */
#define RTE_KVARGS_MAX 32
/** separator character used between each pair */
-#define RTE_KVARGS_PAIRS_DELIM
';'
+#define RTE_KVARGS_PAIRS_DELIM
","
/** separator character used between key and value */
/** separator character used between key and value */
-#define RTE_KVARGS_KV_DELIM
'='
+#define RTE_KVARGS_KV_DELIM
"="
/** Type of callback function used by rte_kvargs_process() */
/** Type of callback function used by rte_kvargs_process() */
-typedef int (*arg_handler_t)(char *value, void *opaque);
+typedef int (*arg_handler_t)(c
onst char *key, const c
har *value, void *opaque);
/** A key/value association */
struct rte_kvargs_pair {
/** A key/value association */
struct rte_kvargs_pair {
@@
-79,7
+83,7
@@
struct rte_kvargs {
* Allocate a rte_kvargs and store key/value associations from a string
*
* The function allocates and fills a rte_kvargs structure from a given
* Allocate a rte_kvargs and store key/value associations from a string
*
* The function allocates and fills a rte_kvargs structure from a given
- * string whose format is key1=value1
;key2=value2;
...
+ * string whose format is key1=value1
,key2=value2,
...
*
* The structure can be freed with rte_kvargs_free().
*
*
* The structure can be freed with rte_kvargs_free().
*
@@
-111,12
+115,14
@@
void rte_kvargs_free(struct rte_kvargs *kvlist);
*
* For each key/value association that matches the given key, calls the
* handler function with the for a given arg_name passing the value on the
*
* For each key/value association that matches the given key, calls the
* handler function with the for a given arg_name passing the value on the
- * dictionary for that key and a given extra argument.
+ * dictionary for that key and a given extra argument. If *kvlist* is NULL
+ * function does nothing.
*
* @param kvlist
* The rte_kvargs structure
* @param key_match
*
* @param kvlist
* The rte_kvargs structure
* @param key_match
- * The key on which the handler should be called
+ * The key on which the handler should be called, or NULL to process handler
+ * on all associations
* @param handler
* The function to call for each matching key
* @param opaque_arg
* @param handler
* The function to call for each matching key
* @param opaque_arg
@@
-135,7
+141,7
@@
int rte_kvargs_process(const struct rte_kvargs *kvlist,
* @param kvlist
* The rte_kvargs structure
* @param key_match
* @param kvlist
* The rte_kvargs structure
* @param key_match
- * The key that should match
+ * The key that should match
, or NULL to count all associations
* @return
* The number of entries
* @return
* The number of entries