samophis.lavalink.client.entities

Interface Statistics

public interface Statistics

Represents the statistics for a given AudioNode, updated every minute.

Since:

0.1

Author:

SamOphis

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Statistics.Frames Represents the possibly-null frame statistics provided every minute by the Lavalink-Server.

Method Summary

Modifier and Type	Method and Description
int	getAllocatedMemory() Fetches the amount of allocated memory, in bytes.
int	getCpuCores() Fetches the amount of CPU Cores.
Statistics.Frames	getFrames() Fetches the possibly-null Frames information.
int	getFreeMemory() Fetches the amount of free memory, in bytes.
double	getLavalinkLoad() Fetches the amount of Lavalink load.
AudioNode	getNode() Fetches the AudioNode connected to this Statistics object.
int	getPlayers() Fetches the total amount of all connected players.
int	getPlayingPlayers() Fetches the amount of playing players.
int	getReservableMemory() Fetches the amount of reservable memory, in bytes.
double	getSystemLoad() Fetches the amount of system load.
long	getUptime() Fetches the uptime of the AudioNode, in milliseconds.
int	getUsedMemory() Fetches the amount of used memory, in bytes.

Method Detail

getNode

@Nonnull
AudioNode getNode()

Fetches the AudioNode connected to this Statistics object.

Returns:

The AudioNode associated with this Statistics object.

getPlayers

@Nonnegative
int getPlayers()

Fetches the total amount of all connected players.

Returns:

The total amount of all connected players.

getPlayingPlayers

@Nonnegative
int getPlayingPlayers()

Fetches the amount of playing players.

Returns:

The amount of playing players.

getUptime

@Nonnegative
long getUptime()

Fetches the uptime of the AudioNode, in milliseconds.

Returns:

The uptime, in milliseconds, of the AudioNode.

getFreeMemory

@Nonnegative
int getFreeMemory()

Fetches the amount of free memory, in bytes.

Returns:

The amount of free memory, in bytes.

getUsedMemory

@Nonnegative
int getUsedMemory()

Fetches the amount of used memory, in bytes.

Returns:

The amount of used memory, in bytes.

getAllocatedMemory

@Nonnegative
int getAllocatedMemory()

Fetches the amount of allocated memory, in bytes.

Returns:

The amount of allocated memory, in bytes.

getReservableMemory

@Nonnegative
int getReservableMemory()

Fetches the amount of reservable memory, in bytes.

Returns:

The amount of reservable memory, in bytes.

getCpuCores

@Nonnegative
int getCpuCores()

Fetches the amount of CPU Cores.

Returns:

The amount of CPU Cores.

getSystemLoad

@Nonnegative
double getSystemLoad()

Fetches the amount of system load.

Returns:

The amount of system load imposed on the AudioNode.

getLavalinkLoad

@Nonnegative
double getLavalinkLoad()

Fetches the amount of Lavalink load.

Returns:

The amount of Lavalink load imposed on the AudioNode.

getFrames

@Nonnull
Statistics.Frames getFrames()

Fetches the possibly-null Frames information.

Returns:

possibly-null Frames information.