JavaSteam/in.dragonbra.javasteam.steam.discovery/SmartCMServerList

SmartCMServerList

class SmartCMServerList(configuration: SteamConfiguration)

Smart list of CM servers.

Constructors

Link copied to clipboard
constructor(configuration: SteamConfiguration)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
var badConnectionMemoryTimeSpan: Duration

Determines how long a server's bad connection state is remembered for.

Link copied to clipboard
var serverListBeforeRefreshTimeSpan: Duration

Determines how long the server list cache is used as-is before attempting to refresh from the Steam Directory.

Functions

Link copied to clipboard
fun forceRefreshServerList(): Boolean

Force refresh the server list. If directory fetch is allowed, it will refresh from the API first, and then fallback to the server list provider.

Link copied to clipboard
fun getAllEndPoints(): List<ServerRecord>

Gets the ServerRecords of all servers in the server list.

Link copied to clipboard
fun getNextServerCandidate(supportedProtocolTypes: ProtocolTypes): ServerRecord?
fun getNextServerCandidate(supportedProtocolTypes: EnumSet<ProtocolTypes>): ServerRecord?

Get the next server in the list.

Link copied to clipboard
@JvmOverloads
fun replaceList(endpointList: List<ServerRecord>, writeProvider: Boolean = true, serversTime: Instant? = null)

Replace the list with a new list of servers provided to us by the Steam servers.

Link copied to clipboard
fun resetBadServers()

Explicitly resets the known state of all servers.

Link copied to clipboard
fun resetOldScores()

Resets the scores of all servers which has a last bad connection more than SmartCMServerList.badConnectionMemoryTimeSpan ago.

Link copied to clipboard
fun tryMark(endPoint: InetSocketAddress?, protocolTypes: ProtocolTypes?, quality: ServerQuality): Boolean
fun tryMark(endPoint: InetSocketAddress?, protocolTypes: EnumSet<ProtocolTypes>?, quality: ServerQuality): Boolean