Skip to content

Commit 170b35e

Browse files
committed
add xml doc comments
1 parent efa52a9 commit 170b35e

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

src/Smdn.Net.MuninNode/Smdn.Net.MuninNode/IAccessRule.cs

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,19 @@
44

55
namespace Smdn.Net.MuninNode;
66

7+
/// <summary>
8+
/// Provides an interface for defining rules to determine whether a client connecting to
9+
/// <c>Munin-Node</c> is acceptable for access, based on the endpoint of the client.
10+
/// </summary>
11+
/// <seealso href="https://guide.munin-monitoring.org/en/latest/reference/munin-node.conf.html#cmdoption-arg-allow">munin-node.conf - DIRECTIVES - Inherited - allow</seealso>
12+
/// <seealso href="https://guide.munin-monitoring.org/en/latest/reference/munin-node.conf.html#cmdoption-arg-cidr-allow">munin-node.conf - DIRECTIVES - Inherited - cidr_allow</seealso>
13+
/// <seealso href="https://guide.munin-monitoring.org/en/latest/reference/munin-node.conf.html#cmdoption-arg-cidr-deny">munin-node.conf - DIRECTIVES - Inherited - cidr_deny</seealso>
714
public interface IAccessRule {
15+
/// <summary>
16+
/// Returns a value indicating whether the <see cref="IPEndPoint"/> is acceptable in the
17+
/// access rules defined by this instance.
18+
/// </summary>
19+
/// <param name="remoteEndPoint"><see cref="IPEndPoint"/> of the remote host requesting access.</param>
20+
/// <returns><see langword="true"/> if acceptable, <see langword="false"/> otherwise.</returns>
821
bool IsAcceptable(IPEndPoint remoteEndPoint);
922
}

0 commit comments

Comments
 (0)