Drizzled Public API Documentation

drizzled::plugin::NullClient Class Reference

#include <null_client.h>

Inheritance diagram for drizzled::plugin::NullClient:
drizzled::plugin::Client

Public Member Functions

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

Protected Attributes

Sessionsession

Private Types

typedef std::vector< char > Bytes
typedef std::queue< Bytes > Queue

Private Attributes

Queue to_execute
bool is_dead
Bytes packet_buffer

Detailed Description

This class is an empty client implementation for internal used.

Definition at line 34 of file null_client.h.

Member Function Documentation

virtual bool drizzled::plugin::NullClient::authenticate ( void  )
inlinevirtual

Perform handshake and authorize client if needed.

Implements drizzled::plugin::Client.

Definition at line 53 of file null_client.h.

virtual void drizzled::plugin::NullClient::close ( void  )
inlinevirtual

Close the client object.

Implements drizzled::plugin::Client.

Definition at line 52 of file null_client.h.

virtual bool drizzled::plugin::NullClient::flush ( void  )
inlinevirtual

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

Return values
Booleanindicating success or failure.

Implements drizzled::plugin::Client.

Definition at line 51 of file null_client.h.

virtual int drizzled::plugin::NullClient::getFileDescriptor ( void  )
inlinevirtual

Get file descriptor associated with client object.

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

Implements drizzled::plugin::Client.

Definition at line 49 of file null_client.h.

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

Get attached session from the client object.

Return values
Sessionobject that is attached, NULL if none.

Definition at line 50 of file client.h.

virtual bool drizzled::plugin::NullClient::isConnected ( void  )
inlinevirtual

Check to see if the client is currently connected.

Return values
Booleanvalue representing connected state.

Implements drizzled::plugin::Client.

Definition at line 50 of file null_client.h.

virtual bool drizzled::plugin::NullClient::readCommand ( char **  packet,
uint32_t &  packet_length 
)
inlinevirtual

Read command from client.

Implements drizzled::plugin::Client.

Definition at line 55 of file null_client.h.

virtual void drizzled::plugin::NullClient::sendFields ( List< Item > &  )
inlinevirtual

Send field list for result set.

Implements drizzled::plugin::Client.

Definition at line 83 of file null_client.h.

virtual void drizzled::plugin::Client::setSession ( Session session_arg)
inlinevirtualinherited

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.


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