protocol/net.rsprot.protocol.filter/MessageFilter

MessageFilter

interface MessageFilter

A message filter interface, allowing the user to configure how many incoming messages to accept of a specific type per game cycle, before dropping them.

Inheritors

Types

Link copied to clipboard
object Companion

Functions

Link copied to clipboard
abstract fun accept(id: Int, size: Int): Int

Check if the message with the given id and size should be accepted. This function is responsible for incrementing any counters that are implementation-specific along-side returning the result.

Link copied to clipboard
abstract fun reset()

Resets the message filter, making it ready to be used in the next cycle.