← Back to branch summary

~drizzle-trunk/drizzle/development

« back to all changes in this revision

Viewing changes to drizzled/plugin/client.h

Merge of Jay

Show diffs side-by-side

added added

removed removed

Lines of Context:
drizzled/plugin/client.h
 
1
/* -*- mode: c++; c-basic-offset: 2; indent-tabs-mode: nil; -*-
 
2
 *  vim:expandtab:shiftwidth=2:tabstop=2:smarttab:
 
3
 *
 
4
 *  Copyright (C) 2008 Sun Microsystems
 
5
 *
 
6
 *  This program is free software; you can redistribute it and/or modify
 
7
 *  it under the terms of the GNU General Public License as published by
 
8
 *  the Free Software Foundation; version 2 of the License.
 
9
 *
 
10
 *  This program is distributed in the hope that it will be useful,
 
11
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 
12
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
13
 *  GNU General Public License for more details.
 
14
 *
 
15
 *  You should have received a copy of the GNU General Public License
 
16
 *  along with this program; if not, write to the Free Software
 
17
 *  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 
18
 */
 
19
 
 
20
#ifndef DRIZZLED_PLUGIN_CLIENT_H
 
21
#define DRIZZLED_PLUGIN_CLIENT_H
 
22
 
 
23
#include <drizzled/sql_list.h>
 
24
#include <drizzled/item.h>
 
25
 
 
26
class Session;
 
27
class String;
 
28
 
 
29
namespace drizzled
 
30
{
 
31
namespace plugin
 
32
{
 
33
 
 
34
/**
 
35
 * This class allows new client sources to be written. This could be through
 
36
 * network protocols, in-process threads, or any other client source that can
 
37
 * provide commands and handle result sets. The current implementation is
 
38
 * file-descriptor based, so for non-fd client sources (like from another
 
39
 * thread), derived classes will need to use a pipe() for event notifications.
 
40
 */
 
41
class Client
 
42
{
 
43
protected:
 
44
  Session *session;
 
45
 
 
46
public:
 
47
  Client() {}
 
48
  virtual ~Client() {}
 
49
 
 
50
  /**
 
51
   * Get attached session from the client object.
 
52
   * @retval Session object that is attached, NULL if none.
 
53
   */
 
54
  virtual Session *getSession(void)
 
55
  {
 
56
    return session;
 
57
  }
 
58
 
 
59
  /**
 
60
   * Attach session to the client object.
 
61
   * @param[in] session_arg Session object to attach, or NULL to clear.
 
62
   */
 
63
  virtual void setSession(Session *session_arg)
 
64
  {
 
65
    session= session_arg;
 
66
  }
 
67
 
 
68
  /**
 
69
   * Get file descriptor associated with client object.
 
70
   * @retval File descriptor that is attached, -1 if none.
 
71
   */
 
72
  virtual int getFileDescriptor(void)= 0;
 
73
 
 
74
  /**
 
75
   * Check to see if the client is currently connected.
 
76
   * @retval Boolean value representing connected state.
 
77
   */
 
78
  virtual bool isConnected(void)= 0;
 
79
 
 
80
  /**
 
81
   * Check to see if the client is actively reading.
 
82
   * @retval Boolean value representing reading state.
 
83
   */
 
84
  virtual bool isReading(void)= 0;
 
85
 
 
86
  /**
 
87
   * Check to see if the client is actively writing.
 
88
   * @retval Boolean value representing writing state.
 
89
   */
 
90
  virtual bool isWriting(void)= 0;
 
91
 
 
92
  /**
 
93
   * Flush all data that has been buffered with store() methods.
 
94
   * @retval Boolean indicating success or failure.
 
95
   */
 
96
  virtual bool flush(void)= 0;
 
97
 
 
98
  /**
 
99
   * Close the client object.
 
100
   */
 
101
  virtual void close(void)= 0;
 
102
 
 
103
  /**
 
104
   * Perform handshake and authorize client if needed.
 
105
   */
 
106
  virtual bool authenticate(void)= 0;
 
107
 
 
108
  /**
 
109
   * Read command from client.
 
110
   */
 
111
  virtual bool readCommand(char **packet, uint32_t *packet_length)= 0;
 
112
 
 
113
  /* Send responses. */
 
114
  virtual void sendOK(void)= 0;
 
115
  virtual void sendEOF(void)= 0;
 
116
  virtual void sendError(uint32_t sql_errno, const char *err)= 0;
 
117
 
 
118
  /**
 
119
   * Send field list for result set.
 
120
   */
 
121
  virtual bool sendFields(List<Item> *list)= 0;
 
122
 
 
123
  /* Send result fields in various forms. */
 
124
  virtual bool store(Field *from)= 0;
 
125
  virtual bool store(void)= 0;
 
126
  virtual bool store(int32_t from)= 0;
 
127
  virtual bool store(uint32_t from)= 0;
 
128
  virtual bool store(int64_t from)= 0;
 
129
  virtual bool store(uint64_t from)= 0;
 
130
  virtual bool store(double from, uint32_t decimals, String *buffer)= 0;
 
131
  virtual bool store(const DRIZZLE_TIME *from)= 0;
 
132
  virtual bool store(const char *from)
 
133
  {
 
134
    if (from == NULL) 
 
135
      return store();
 
136
    return store(from, strlen(from));
 
137
  }
 
138
  virtual bool store(const char *from, size_t length)= 0;
 
139
 
 
140
  /* Try to remove these. */
 
141
  virtual bool haveMoreData(void)= 0;
 
142
  virtual bool haveError(void)= 0;
 
143
  virtual bool wasAborted(void)= 0;
 
144
};
 
145
 
 
146
} /* end namespace drizzled::plugin */
 
147
} /* end namespace drizzled */
 
148
 
 
149
#endif /* DRIZZLED_PLUGIN_CLIENT_H */