ConnectionInfo

Represents the connection details for a server to connect to

shared

struct ConnectionInfo {

string nickname;

string username;

string realname;

string quitMessage;

ChecksMode getMode();

void setMode(ChecksMode mode);

ulong getBulkReadSize();

void setBulkReadSize(ulong bytes);

Address getAddr();

ulong getFakeLag();

void setFakeLag(ulong fakeLag);

void updateDB(string key, string value);

T getDB(string key);

static ConnectionInfo newConnection(string hostname, ushort port, string nickname, string username, string realname);

}

Members

Functions

getAddr Address getAddr(): Get the address of the endpoint server
getBulkReadSize ulong getBulkReadSize(): Retrieve the read-dequeue size
getDB T getDB(string key): Retrieve a value from the key-value pair database
getFakeLag ulong getFakeLag(): Get the chosen fake lag
getMode ChecksMode getMode(): Undocumented in source. Be warned that the author may not have intended to support it.
setBulkReadSize void setBulkReadSize(ulong bytes): Sets the read-dequeue size
setFakeLag void setFakeLag(ulong fakeLag): Sets the fake lag in seconds
setMode void setMode(ChecksMode mode): Undocumented in source. Be warned that the author may not have intended to support it.
updateDB void updateDB(string key, string value): Update a value in the key-value pair database

Static functions

newConnection ConnectionInfo newConnection(string hostname, ushort port, string nickname, string username, string realname): Creates a ConnectionInfo struct representing a client configuration which can be provided to the Client class to create a new connection based on its parameters

Variables

nickname string nickname;: Nickname to use
quitMessage string quitMessage;: Quit message
realname string realname;: Real name
username string username;: Username

Meta

Source

See Implementation

birchwood config conninfo enums

ChecksMode

functions

setDefaults

structs

ConnectionInfo