api: add prefix matcher typedef

[vpp.git] / src / vnet / ip / ip_types.api

diff --git a/src/vnet/ip/ip_types.api b/src/vnet/ip/ip_types.api
index 13c6a4a..af8f623 100644 (file)
--- a/src/vnet/ip/ip_types.api
+++ b/src/vnet/ip/ip_types.api
@@ -106,3 +106,14 @@ typedef ip4_prefix {
   vl_api_ip4_address_t address;
   u8 len;
 };
+
+/** \brief A context for matching prefixes against.  (Think ip prefix list.)
+    The meaning (exact match / want subnets) of an unset matcher is left to the implementer.
+    @param le - le mut be <= to prefix.len. Default: 255 (not set).
+    @param ge - ge must be greater than le and <= max_size of prefix. Default: 255 (not set).
+
+*/
+typedef prefix_matcher {
+  u8 le; /* [default=255] */
+  u8 ge; /* [default=255] */
+};