Home / Type/ IpFilterRule Type — netty Architecture

IpFilterRule Type — netty Architecture

Architecture documentation for the IpFilterRule type/interface in IpFilterRule.java from the netty codebase.

Entity Profile

Dependency Diagram

graph TD
  4c255501_fa2e_3af6_4631_b0dcdaf3a36d["IpFilterRule"]
  6be827f9_9d25_e354_767e_3c72ec6b8904["IpFilterRule.java"]
  4c255501_fa2e_3af6_4631_b0dcdaf3a36d -->|defined in| 6be827f9_9d25_e354_767e_3c72ec6b8904
  style 4c255501_fa2e_3af6_4631_b0dcdaf3a36d fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

handler/src/main/java/io/netty/handler/ipfilter/IpFilterRule.java lines 23–36

public interface IpFilterRule {
    /**
     * @return This method should return true if remoteAddress is valid according to your criteria. False otherwise.
     */
    boolean matches(InetSocketAddress remoteAddress);

    /**
     * @return This method should return {@link IpFilterRuleType#ACCEPT} if all
     * {@link IpFilterRule#matches(InetSocketAddress)} for which {@link #matches(InetSocketAddress)}
     * returns true should the accepted. If you want to exclude all of those IP addresses then
     * {@link IpFilterRuleType#REJECT} should be returned.
     */
    IpFilterRuleType ruleType();
}

Frequently Asked Questions

What is the IpFilterRule type?
IpFilterRule is a type/interface in the netty codebase, defined in handler/src/main/java/io/netty/handler/ipfilter/IpFilterRule.java.
Where is IpFilterRule defined?
IpFilterRule is defined in handler/src/main/java/io/netty/handler/ipfilter/IpFilterRule.java at line 23.

Analyze Your Own Codebase

Get architecture documentation, dependency graphs, and domain analysis for your codebase in minutes.

Try Supermodel Free