[HICN-298] Release new hICN app for Android

Change-Id: I43adc62fadf00690b687078d739788dffdc5e566
Signed-off-by: Jordan Augé <jordan.auge+fdio@cisco.com>

1 files changed, 187 insertions, 30 deletions

diff --git a/ctrl/facemgr/examples/facemgr.conf b/ctrl/facemgr/examples/facemgr.conf
index 54c212c2b..4658d13e3 100644
--- a/ctrl/facemgr/examples/facemgr.conf
+++ b/ctrl/facemgr/examples/facemgr.conf
@@ -1,37 +1,194 @@
+#
 # hICN facemgr configuration file
+#
 
-faces:
-{
-    # A list of interfaces to ignore
-    ignore = ("lo");
-
-    # A list of rules used to assign tags to interfaces
-    # Each rule follows the syntax { name = "NAME"; tags = ("TAG", ...); }
-    # with TAG = WIRED | WIFI | CELLULAR | TRUSTED
-    rules = (
-        {
-            name = "utun1";
-            tags = ("WIRED", "TRUSTED");
-        }
-    );
-
-    overlay = {
-        ipv4 = {
-            local_port = 9695;
-            remote_port = 9695;
-            remote_addr = "10.60.16.14";
-        };
-        ipv6 = {
-            local_port = 9695;
-            remote_port = 9695;
-            remote_addr = "2001:420:44f1:10:20c:29ff:fef3:8f8f";
-        };
-    };
-}
+################################################################################
+# Global settings
+################################################################################
+
+global = {
+
+# Default type for face creation
+#
+# Values: "auto" | "native-udp" | "native-tcp" | "overlay-udp" | "overlay-tcp"
+# Default "auto"
+#
+#face_type = "auto";
+face_type = "overlay-udp"
+
+# Disable service discovery for overlay creation
+#
+# This is only meaningful for overlay_* face types. If service discovery is
+# disabled, only manually entered overlay information will be used, if any.
+# Otherwise, no face will be created.
+#
+# Values : true | false
+# Default: false
+#
+#disable_discovery = true;
+
+# TODO Disable IPv4 face creation
+#
+# Values : true | false
+# Default: false
+#
+#disable_ipv4 = true;
+
+# TODO Disable IPv6 face creation
+#
+# Values : true | false
+# Default: false
+#
+#disable_ipv6 = true;
+
+# TODO overlay
+#
+#   By default, no address is specified, and local and remote ports are set to
+#   the standard value for hICN (9695).
+#
+
+};
+
+################################################################################
+# Per-interface rules
+################################################################################
+#
+# Rules allow to override the default behaviour of the face manager.
+#
+# The list of rules must be specified as follows (note that the last one has no
+# coma at the end) :
+#
+#   rules = (
+#       { ... },
+#       { ... },
+#       { ... }
+#   );
+#
+# A rule is composed of match and override attributes, and has the following
+# syntax:
+#
+#   {
+#       match = {
+#           interface_name = STRING;
+#           interface_type = STRING;
+#       };
+#       override = {
+#          face_type = STRING;
+#          disable_discovery = BOOL;
+#          ignore = BOOL;
+#          tags = (STRING, STRING, STRING);
+#          overlay = {
+#             ipv4 = {
+#                 local_port = PORT;
+#                 remote_addr = IP_ADDRESS;
+#                 remote_port = PORT;
+#             };
+#             ipv6 = {
+#                 local_port = PORT;
+#                 remote_addr = IP_ADDRESS;
+#                 remote_port = PORT;
+#             };
+#          };
+#       };
+#   }
+#
+# Match attributes:
+#
+#   Match attributes serve to identify rules and as such defining two rules with
+#   similar matches is not allowed. However, overlapping match definitions are
+#   possible, in which case only the first matching rule is considered.
+#
+#   A match is composed of the name of an interface and/or its type (either
+#   attribute is optional but at least one has to be specified).
+#
+#   * interface_name - a string representing an interface name
+#
+#   * interface_type - the type of interface to match
+#
+#       Values: "wired" | "wifi" | "cellular"
+#
+# Override attributes:
+#
+#   Those attributes are applied when all specified match attributes correspond,
+#   and override general settings or default values.
+#
+#   * face_type - type used for face creation
+#
+#       Values: "auto" | "native_udp" | "native_tcp" | "overlay_udp" | "overlay_tcp"
+#
+#   * disable_discovery - disable service discovery for overlay creation
+#
+#       Values : true | false
+#
+#   * ignore - a boolean indicating whether that interface should be ignored
+#
+#   * TODO tags - a (possibly empty) list of tags to be associated to the created face.
+#
+#       Values: "wired" | "wifi" | "cellular" | "trusted"
+#
+#   * overlay
+#
+#       An overlay specification is used to complement any information retrieved
+#       through service discovery (or replace it if service discovery is
+#       disabled).
+#
+#       It is possible to specify values for IPv4, IPv6 or both.
+#
+# Note that it is not currently possible to set different settings for IPv4 and
+# IPv6 but overlay specifications.
+#
+#
+# Here are a few example of rule definitions:
+#
+# rules = (
+#     # Ignore localhost interface
+#     {
+#         match = {
+#             interface_name = "lo";
+#         };
+#         override = {
+#             ignore = true;
+#         };
+#     },
+#     # Set tags for unknown tunnnel interface
+#     {
+#         match = {
+#             interface_name = "utun1";
+#         };
+#         override = {
+#             tags = ("WIRED", "TRUSTED");
+#         };
+#     },
+#     # Force cellular connections to use manually specified overlay faces
+#     {
+#         match = {
+#             interface_type = "cellular",
+#         };
+#         override = {
+#             overlay = {
+#                 ipv4 = {
+#                     local_port = 9695;
+#                     remote_addr = "10.60.16.14";
+#                     remote_port = 9695;
+#                 };
+#                 ipv6 = {
+#                     local_port = 9695;
+#                     remote_addr = "2001:420:44f1:10:20c:29ff:fef3:8f8f";
+#                     remote_port = 9695;
+#                 };
+#             };
+#         };
+#     }
+# );
+#
+#rules = (
+#);
+
+################################################################################
+# Logging
+################################################################################
 
 log:
 {
     log_level = "DEBUG";
 }
-
-