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