Skip to content

Route Planner#

Route Planner ABC's.

Route planner abstract classes.

RoutePlannerStatus #

Bases: abc.ABC

Route Planner Status Object.

The status of the route-planner.

Lavalink Reference

cls property #

cls: RoutePlannerType

The name of the RoutePlanner implementation being used by this server.

details property #

details: RoutePlannerDetails

The status details of the RoutePlanner.

RoutePlannerDetails #

Bases: abc.ABC

Route Planner details.

All of the information about the failing addresses.

Lavalink Reference

ip_block property #

ip_block: IPBlock

The ip block being used.

failing_addresses property #

failing_addresses: typing.Sequence[FailingAddress]

The failing addresses.

rotate_index property #

rotate_index: str | None

The number of rotations.

ip_index property #

ip_index: str | None

The current offset in the block.

current_address property #

current_address: str | None

The current address being used.

current_address_index property #

current_address_index: str | None

The current offset in the ip block.

block_index property #

block_index: str | None

The current offset in the ip block.

IPBlock #

Bases: abc.ABC

Route Planner IP Block.

All of the information about the IP Block.

Lavalink Reference

type property #

type: IPBlockType

The type of the ip block.

size property #

size: str

The size of the ip block.

FailingAddress #

Bases: abc.ABC

Failing address.

Lavalink Reference

address property #

address: str

The failing address.

timestamp property #

timestamp: datetime.datetime

The datetime object of when the address failed.

time property #

time: str

The timestamp when the address failed as a pretty string.

RoutePlannerType #

Bases: str, enum.Enum

Route Planner Type.

The type of routeplanner that the server is currently using.

Lavalink Reference

ROTATING_ROUTE_PLANNER class-attribute instance-attribute #

ROTATING_ROUTE_PLANNER = 'RotatingIpRoutePlanner'

IP address used is switched on ban. Recommended for IPv4 blocks or IPv6 blocks smaller than a /64.

NANO_IP_ROUTE_PLANNER class-attribute instance-attribute #

NANO_IP_ROUTE_PLANNER = 'NanoIpRoutePlanner'

IP address used is switched on clock update. Use with at least 1 /64 IPv6 block.

ROTATING_NANO_IP_ROUTE_PLANNER class-attribute instance-attribute #

ROTATING_NANO_IP_ROUTE_PLANNER = (
    "RotatingNanoIpRoutePlanner"
)

IP address used is switched on clock update, rotates to a different /64 block on ban. Use with at least 2x /64 IPv6 blocks.

BALANCING_IP_ROUTE_PLANNER class-attribute instance-attribute #

BALANCING_IP_ROUTE_PLANNER = 'BalancingIpRoutePlanner'

IP address used is selected at random per request. Recommended for larger IP blocks.

IPBlockType #

Bases: str, enum.Enum

IP Block Type.

The IP Block type, 4, or 6.

Lavalink Reference

INET_4_ADDRESS class-attribute instance-attribute #

INET_4_ADDRESS = 'Inet4Address'

The ipv4 block type

INET_6_ADDRESS class-attribute instance-attribute #

INET_6_ADDRESS = 'Inet6Address'

The ipv6 block type