From a2d07ef983c90121d6819c980572ec8b21eafabb Mon Sep 17 00:00:00 2001 From: Evelyn Date: Fri, 22 Jul 2016 15:13:59 +0100 Subject: [PATCH] Update mg_check_ip_acl.md --- docs/c-api/net.h/mg_check_ip_acl.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/c-api/net.h/mg_check_ip_acl.md b/docs/c-api/net.h/mg_check_ip_acl.md index 957a684f..645ae0e1 100644 --- a/docs/c-api/net.h/mg_check_ip_acl.md +++ b/docs/c-api/net.h/mg_check_ip_acl.md @@ -6,7 +6,7 @@ signature: | int mg_check_ip_acl(const char *acl, uint32_t remote_ip); --- -Verify given IP address against the ACL. +Verifies given IP address against the ACL. `remote_ip` - an IPv4 address to check, in host byte order `acl` - a comma separated list of IP subnets: `x.x.x.x/x` or `x.x.x.x`. @@ -15,13 +15,13 @@ prepended by either a - or a + sign. A plus sign means allow, where a minus sign means deny. If a subnet mask is omitted, such as `-1.2.3.4`, this means to deny only that single IP address. Subnet masks may vary from 0 to 32, inclusive. The default setting -is to allow all accesses. On each request the full list is traversed, +is to allow all access. On each request the full list is traversed, and the last match wins. Example: `-0.0.0.0/0,+192.168/16` - deny all acccesses, only allow 192.168/16 subnet -To learn more about subnet masks, see the -link:https://en.wikipedia.org/wiki/Subnetwork[Wikipedia page on Subnetwork] +To learn more about subnet masks, see this +link:https://en.wikipedia.org/wiki/Subnetwork[Wikipedia page on Subnetwork]. -Return -1 if ACL is malformed, 0 if address is disallowed, 1 if allowed. +Returns -1 if ACL is malformed, 0 if address is disallowed, 1 if allowed.