Connection

A struct representing a database connection.

The Connection is responsible for handshaking with the server to establish authentication. It then passes client preferences to the server, and subsequently is the channel for all command packets that are sent, and all response packets received.

Uncompressed packets consist of a 4 byte header - 3 bytes of length, and one byte as a packet number. Connection deals with the headers and ensures that packet numbers are sequential.

The initial packet is sent by the server - esentially a 'hello' packet inviting login. That packet has a sequence number of zero. That sequence number is the incremented by cliemt and server packets thruogh the handshake sequence.

After login all further sequences are initialized by the client sending a command packet with a zero sequence number, to which the server replies with zero or more packets with sequential sequence numbers.

class Connection : EventedObject {

enum OpenState;

OpenState _open;

TcpConnection _socket;

SvrCapFlags _sCaps;

SvrCapFlags _cCaps;

uint _sThread;

ushort _serverStatus;

ubyte _sCharSet;

ubyte _protocol;

string _serverVersion;

string _host;

string _user;

ushort _port;

ubyte pktNumber [@property getter];

void bumpPacket();

void resetPacket();

ubyte[] getPacket();

void send(ubyte[] packet);

void send(ubyte[] header, ubyte[] data);

void sendCmd(CommandType cmd, T[] data);

OKErrorPacket getCmdResponse(bool asString);

ubyte[] buildAuthPacket(ubyte[] token);

void consumeServerInfo(ubyte[] packet);

ubyte[] parseGreeting();

void init_connection();

ubyte[] makeToken(ubyte[] authBuf);

SvrCapFlags getCommonCapabilities(SvrCapFlags server, SvrCapFlags client);

void setClientFlags(SvrCapFlags capFlags);

static string[] parseConnectionString(string cs);

void authenticate(ubyte[] greeting);

void connect(SvrCapFlags clientCapabilities);

this(string host, string user, string pwd, string db, ushort port, SvrCapFlags capFlags);

this(string cs, SvrCapFlags capFlags);

bool closed [@property getter];

void acquire();

void release();

bool isOwner();

void close();

void selectDB(string dbName);

OKErrorPacket pingServer();

OKErrorPacket refreshServer(RefreshFlags flags);

string serverStats();

void enableMultiStatements(bool on);

ubyte protocol [@property getter];

string serverVersion [@property getter];

uint serverCapabilities [@property getter];

ushort serverStatus [@property getter];

ubyte charSet [@property getter];

string currentDB [@property getter];

}

Constructors

this this(string host, string user, string pwd, string db, ushort port, SvrCapFlags capFlags): Construct opened connection.
this this(string cs, SvrCapFlags capFlags): Construct opened connection.

Destructor

~this ~this(): Undocumented in source.

Members

Enums

OpenState enum OpenState: Undocumented in source.

Functions

acquire void acquire(): Undocumented in source. Be warned that the author may not have intended to support it.
authenticate void authenticate(ubyte[] greeting): Undocumented in source.
buildAuthPacket ubyte[] buildAuthPacket(ubyte[] token): Undocumented in source.
bumpPacket void bumpPacket(): Undocumented in source. Be warned that the author may not have intended to support it.
close void close(): Explicitly close the connection.
connect void connect(SvrCapFlags clientCapabilities): Undocumented in source.
consumeServerInfo void consumeServerInfo(ubyte[] packet): Undocumented in source. Be warned that the author may not have intended to support it.
enableMultiStatements void enableMultiStatements(bool on): Enable multiple statement commands
getCmdResponse OKErrorPacket getCmdResponse(bool asString): Undocumented in source. Be warned that the author may not have intended to support it.
getCommonCapabilities SvrCapFlags getCommonCapabilities(SvrCapFlags server, SvrCapFlags client): Undocumented in source. Be warned that the author may not have intended to support it.
getPacket ubyte[] getPacket(): Undocumented in source. Be warned that the author may not have intended to support it.
init_connection void init_connection(): Undocumented in source. Be warned that the author may not have intended to support it.
isOwner bool isOwner(): Undocumented in source. Be warned that the author may not have intended to support it.
makeToken ubyte[] makeToken(ubyte[] authBuf): Undocumented in source. Be warned that the author may not have intended to support it.
parseGreeting ubyte[] parseGreeting(): Undocumented in source. Be warned that the author may not have intended to support it.
pingServer OKErrorPacket pingServer(): Check the server status
refreshServer OKErrorPacket refreshServer(RefreshFlags flags): Refresh some feature(s) of the server.
release void release(): Undocumented in source. Be warned that the author may not have intended to support it.
resetPacket void resetPacket(): Undocumented in source. Be warned that the author may not have intended to support it.
selectDB void selectDB(string dbName): Select a current database.
send void send(ubyte[] packet): Undocumented in source.
send void send(ubyte[] header, ubyte[] data): Undocumented in source.
sendCmd void sendCmd(CommandType cmd, T[] data): Undocumented in source.
serverStats string serverStats(): Get a textual report on the server status.
setClientFlags void setClientFlags(SvrCapFlags capFlags): Undocumented in source. Be warned that the author may not have intended to support it.

Properties

charSet ubyte charSet [@property getter]: Current character set
closed bool closed [@property getter]: Undocumented in source. Be warned that the author may not have intended to support it.
currentDB string currentDB [@property getter]: Current database
pktNumber ubyte pktNumber [@property getter]: Undocumented in source. Be warned that the author may not have intended to support it.
protocol ubyte protocol [@property getter]: Return the in-force protocol number
serverCapabilities uint serverCapabilities [@property getter]: Server capability flags
serverStatus ushort serverStatus [@property getter]: Server status
serverVersion string serverVersion [@property getter]: Server version

Static functions

parseConnectionString string[] parseConnectionString(string cs)
_cCaps SvrCapFlags _cCaps;: Undocumented in source. Be warned that the author may not have intended to support it.

Variables

_cpn ubyte _cpn;: Packet Number in packet header. Serial number to ensure correct ordering. First packet should have 0
_db string _db;: Undocumented in source.
_host string _host;: Undocumented in source.
_open OpenState _open;: Undocumented in source.
_port ushort _port;
_protocol ubyte _protocol;
_pwd string _pwd;: Undocumented in source.
_sCaps SvrCapFlags _sCaps;: Undocumented in source.
_sCharSet ubyte _sCharSet;: Undocumented in source.
_sThread uint _sThread;: Undocumented in source.
_serverStatus ushort _serverStatus;: Undocumented in source.
_serverVersion string _serverVersion;: Undocumented in source.
_socket TcpConnection _socket;
_user string _user;: Undocumented in source.

Meta

Source

See Implementation