Class Scum

Namespace

OpenGSQ.Protocols

Assembly

OpenGSQ.dll

Scum Protocol

public class Scum : ProtocolBase

Inheritance

object

ProtocolBase

Scum

Inherited Members

ProtocolBase.Host

ProtocolBase.Port

ProtocolBase.Timeout

ProtocolBase.GetIPAddress()

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

Scum(string, int, int)

Initializes a new instance of the Scum class.

public Scum(string host, int port, int timeout = 5000)

Parameters

host string

The host of the server.

port int

The port of the server.

timeout int

The timeout for server requests.

Properties

FullName

Gets the full name of the protocol.

public override string FullName { get; }

Property Value

string

Methods

GetStatus(List<Status>?)

Gets the status of the server.

public Task<Status> GetStatus(List<Status>? masterServers = null)

Parameters

masterServers List<Status>

The list of master servers to query.

Returns

Task<Status>

The status of the server.

Exceptions

TimeoutException

Thrown when the operation times out.

ServerNotFoundException

Thrown when the server is not found in the list of master servers.

QueryMasterServers()

Queries the master servers for a list of servers.

public static Task<List<Status>> QueryMasterServers()

Returns

Task<List<Status>>

A list of servers from the master servers.

Exceptions

TimeoutException

Thrown when the operation times out.

Exception

Thrown when failed to connect to any of the master servers.