RakNet  4.0
Public Member Functions | List of all members
RakNet::SQLite3ServerPlugin Class Reference

Exec SQLLite commands over the network. More...

#include <SQLite3ServerPlugin.h>

Inheritance diagram for RakNet::SQLite3ServerPlugin:
RakNet::PluginInterface2

Public Member Functions

virtual bool AddDBHandle (RakNet::RakString dbIdentifier, sqlite3 *dbHandle, bool dbAutoCreated=false)
 
void RemoveDBHandle (RakNet::RakString dbIdentifier, bool alsoCloseConnection=false)
 
virtual PluginReceiveResult OnReceive (Packet *packet)
 
virtual void OnAttach (void)
 Called when the interface is attached.
 
virtual void OnDetach (void)
 Called when the interface is detached.
 
virtual void Update (void)
 Update is called every time a packet is checked for .
 
- Public Member Functions inherited from RakNet::PluginInterface2
virtual void OnRakPeerStartup (void)
 Called when RakPeer is initialized.
 
virtual void OnRakPeerShutdown (void)
 Called when RakPeer is shutdown.
 
virtual void OnClosedConnection (const SystemAddress &systemAddress, RakNetGUID rakNetGUID, PI2_LostConnectionReason lostConnectionReason)
 
virtual void OnNewConnection (const SystemAddress &systemAddress, RakNetGUID rakNetGUID, bool isIncoming)
 
virtual void OnFailedConnectionAttempt (Packet *packet, PI2_FailedConnectionAttemptReason failedConnectionAttemptReason)
 
virtual bool UsesReliabilityLayer (void) const
 
virtual void OnDirectSocketSend (const char *data, const BitSize_t bitsUsed, SystemAddress remoteSystemAddress)
 
virtual void OnDirectSocketReceive (const char *data, const BitSize_t bitsUsed, SystemAddress remoteSystemAddress)
 
virtual void OnReliabilityLayerNotification (const char *errorMessage, const BitSize_t bitsUsed, SystemAddress remoteSystemAddress, bool isError)
 
virtual void OnInternalPacket (InternalPacket *internalPacket, unsigned frameNumber, SystemAddress remoteSystemAddress, RakNet::TimeMS time, int isSend)
 
virtual void OnAck (unsigned int messageNumber, SystemAddress remoteSystemAddress, RakNet::TimeMS time)
 
virtual void OnPushBackPacket (const char *data, const BitSize_t bitsUsed, SystemAddress remoteSystemAddress)
 

Detailed Description

Exec SQLLite commands over the network.

SQLite version 3 supports remote calls via networked file handles, but not over the regular internet
This plugin will serialize calls to and results from sqlite3_exec
That's all it does - any remote system can execute SQL queries.
Intended as a starting platform to derive from for more advanced functionality (security over who can query, etc).
Compatible as a plugin with both RakPeerInterface and PacketizedTCP

Member Function Documentation

virtual bool RakNet::SQLite3ServerPlugin::AddDBHandle ( RakNet::RakString  dbIdentifier,
sqlite3 *  dbHandle,
bool  dbAutoCreated = false 
)
virtual

Associate identifier with dbHandle, so when we get calls to operate on identifier, we use dbhandle If SQLite3_STATEMENT_EXECUTE_THREADED is defined, will start the execution thread the first time a dbHandle is added.

Returns
true on success, false on dbIdentifier empty, or already in use
virtual PluginReceiveResult RakNet::SQLite3ServerPlugin::OnReceive ( Packet packet)
virtual

OnReceive is called for every packet.

Parameters
[in]packetthe packet that is being returned to the user
Returns
True to allow the game and other plugins to get this message, false to absorb it

Reimplemented from RakNet::PluginInterface2.

void RakNet::SQLite3ServerPlugin::RemoveDBHandle ( RakNet::RakString  dbIdentifier,
bool  alsoCloseConnection = false 
)

Stop using a dbHandle, lookup either by identifier or by pointer. If SQLite3_STATEMENT_EXECUTE_THREADED is defined, do not call this while processing commands, since the commands run in a thread and might be using the dbHandle Call before closing the handle or else SQLite3Plugin won't know that it was closed, and will continue using it


The documentation for this class was generated from the following file: