drizzle
C++ MySQL-protocol-compatible database server
Loading...
Searching...
No Matches
drizzled::plugin::Client Class Referenceabstract

#include <client.h>

Inheritance diagram for drizzled::plugin::Client:
[legend]
Collaboration diagram for drizzled::plugin::Client:
[legend]

Public Member Functions

virtual Session * getSession ()
virtual void setSession (Session *session_arg)
virtual int getFileDescriptor ()=0
virtual bool isConnected ()=0
virtual bool flush ()=0
virtual void close ()=0
virtual bool authenticate ()=0
virtual bool isConsole () const
virtual bool isInteractive () const
virtual catalog::Instance::shared_ptr catalog ()
virtual bool readCommand (char **packet, uint32_t &packet_length)=0
virtual void sendOK ()=0
virtual void sendEOF ()=0
virtual void sendError (const drizzled::error_t sql_errno, const char *err)=0
virtual void sendFields (List< Item > &)=0
virtual void store (Field *from)=0
virtual void store ()=0
virtual void store (int32_t from)=0
virtual void store (uint32_t from)=0
virtual void store (int64_t from)=0
virtual void store (uint64_t from)=0
virtual void store (double from, uint32_t decimals, String *buffer)=0
virtual void store (const type::Time *from)
virtual void store (const char *from)
virtual void store (const char *from, size_t length)=0
virtual void store (str_ref from)
virtual bool haveError ()=0
virtual bool wasAborted ()=0

Protected Attributes

Session * session

Detailed Description

This class allows new client sources to be written. This could be through network protocols, in-process threads, or any other client source that can provide commands and handle result sets. The current implementation is file-descriptor based, so for non-fd client sources (like from another thread), derived classes will need to use a pipe() for event notifications.

Definition at line 38 of file client.h.

Constructor & Destructor Documentation

◆ ~Client()

virtual drizzled::plugin::Client::~Client ( )
inlinevirtual

Definition at line 44 of file client.h.

Member Function Documentation

◆ authenticate()

virtual bool drizzled::plugin::Client::authenticate ( )
pure virtual

Perform handshake and authorize client if needed.

Implemented in drizzle_plugin::ClientMySQLProtocol, drizzled::plugin::client::Concurrent, and drizzled::plugin::NullClient.

◆ catalog()

virtual catalog::Instance::shared_ptr drizzled::plugin::Client::catalog ( )
inlinevirtual

Definition at line 102 of file client.h.

◆ close()

virtual void drizzled::plugin::Client::close ( )
pure virtual

◆ flush()

virtual bool drizzled::plugin::Client::flush ( )
pure virtual

Flush all data that has been buffered with store() methods.

Return values
Booleanindicating success or failure.

Implemented in drizzle_plugin::ClientMySQLProtocol, drizzled::plugin::client::Concurrent, and drizzled::plugin::NullClient.

◆ getFileDescriptor()

virtual int drizzled::plugin::Client::getFileDescriptor ( )
pure virtual

Get file descriptor associated with client object.

Return values
Filedescriptor that is attached, -1 if none.

Implemented in drizzle_plugin::ClientMySQLProtocol, drizzled::plugin::client::Concurrent, and drizzled::plugin::NullClient.

◆ getSession()

virtual Session * drizzled::plugin::Client::getSession ( )
inlinevirtual

Get attached session from the client object.

Return values
Sessionobject that is attached, NULL if none.

Definition at line 50 of file client.h.

◆ isConnected()

virtual bool drizzled::plugin::Client::isConnected ( )
pure virtual

Check to see if the client is currently connected.

Return values
Booleanvalue representing connected state.

Implemented in drizzle_plugin::ClientMySQLProtocol, drizzled::plugin::client::Concurrent, and drizzled::plugin::NullClient.

◆ isConsole()

virtual bool drizzled::plugin::Client::isConsole ( ) const
inlinevirtual

Definition at line 92 of file client.h.

◆ isInteractive()

virtual bool drizzled::plugin::Client::isInteractive ( ) const
inlinevirtual

Definition at line 97 of file client.h.

◆ readCommand()

virtual bool drizzled::plugin::Client::readCommand ( char ** packet,
uint32_t & packet_length )
pure virtual

◆ sendEOF()

virtual void drizzled::plugin::Client::sendEOF ( )
pure virtual

◆ sendError()

virtual void drizzled::plugin::Client::sendError ( const drizzled::error_t sql_errno,
const char * err )
pure virtual

◆ sendFields()

virtual void drizzled::plugin::Client::sendFields ( List< Item > & )
pure virtual

◆ sendOK()

virtual void drizzled::plugin::Client::sendOK ( )
pure virtual

◆ setSession()

virtual void drizzled::plugin::Client::setSession ( Session * session_arg)
inlinevirtual

Attach session to the client object.

Parameters
[in]session_argSession object to attach, or NULL to clear.

Definition at line 59 of file client.h.

◆ store() [1/3]

void drizzled::plugin::Client::store ( const char * from)
virtual

Definition at line 78 of file client.cc.

◆ store() [2/3]

void drizzled::plugin::Client::store ( const type::Time * from)
virtual

Definition at line 29 of file client.cc.

◆ store() [3/3]

virtual void drizzled::plugin::Client::store ( str_ref from)
inlinevirtual

Definition at line 133 of file client.h.

Member Data Documentation

◆ session

Session* drizzled::plugin::Client::session
protected

Definition at line 41 of file client.h.


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