BlockList

The BlockList object can be used with some network APIs to specify rules for disabling inbound or outbound access to specific IP addresses, IP ranges, or IP subnets.

Since

v15.0.0, v14.18.0

Constructors

BlockList

constructor()

Types

Companion

external object Companion

Properties

rules

external var rules: ReadonlyArray<String>

The list of rules added to the blocklist.

Functions

addAddress

external fun addAddress(address: SocketAddress)

external fun addAddress(address: String, type: IPVersion = definedExternally)

Adds a rule to block the given IP address.

addRange

external fun addRange(start: SocketAddress, end: SocketAddress)

external fun addRange(start: String, end: String, type: IPVersion = definedExternally)

Adds a rule to block a range of IP addresses from start (inclusive) toend (inclusive).

addSubnet

external fun addSubnet(net: SocketAddress, prefix: Number)

Adds a rule to block a range of IP addresses specified as a subnet mask.

external fun addSubnet(net: String, prefix: Number, type: IPVersion = definedExternally)

check

external fun check(address: SocketAddress): Boolean

Returns true if the given IP address matches any of the rules added to theBlockList.

external fun check(address: String, type: IPVersion = definedExternally): Boolean

fromJSON

external fun fromJSON(data: ReadonlyArray<String>)

external fun fromJSON(data: String)

toJSON

external fun toJSON(): ReadonlyArray<String>