← Back to branch summary

~drizzle-trunk/drizzle/development

« back to all changes in this revision

Viewing changes to drizzled/plugin/protocol.h

  • Committer: Monty Taylor
  • Date: 2009-04-20 14:42:34 UTC
  • mto: (997.2.5 mordred)
  • mto: This revision was merged to the branch mainline in revision 1003.
  • Revision ID: mordred@inaugust.com-20090420144234-4k1x60fiag2l1y0n
Ported InnoDB to register_plugins.

Show diffs side-by-side

added added

removed removed

Lines of Context:
drizzled/plugin/protocol.h
17
17
 *  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
18
18
 */
19
19
 
20
 
#ifndef DRIZZLED_PLUGIN_CLIENT_H
21
 
#define DRIZZLED_PLUGIN_CLIENT_H
 
20
#ifndef DRIZZLED_PLUGIN_PROTOCOL_H
 
21
#define DRIZZLED_PLUGIN_PROTOCOL_H
22
22
 
23
23
#include <drizzled/sql_list.h>
24
24
#include <drizzled/item.h>
26
26
class Session;
27
27
class String;
28
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
 
29
class Protocol
42
30
{
43
31
protected:
44
32
  Session *session;
45
33
 
46
34
public:
47
 
  virtual ~Client() {}
48
 
 
49
 
  /**
50
 
   * Get attached session from the client object.
51
 
   * @retval Session object that is attached, NULL if none.
52
 
   */
 
35
  Protocol() {}
 
36
  virtual ~Protocol() {}
 
37
 
 
38
  virtual void setSession(Session *session_arg)
 
39
  {
 
40
    session= session_arg;
 
41
  }
 
42
 
53
43
  virtual Session *getSession(void)
54
44
  {
55
45
    return session;
56
46
  }
57
47
 
58
 
  /**
59
 
   * Attach session to the client object.
60
 
   * @param[in] session_arg Session object to attach, or NULL to clear.
61
 
   */
62
 
  virtual void setSession(Session *session_arg)
63
 
  {
64
 
    session= session_arg;
65
 
  }
66
 
 
67
 
  /**
68
 
   * Get file descriptor associated with client object.
69
 
   * @retval File descriptor that is attached, -1 if none.
70
 
   */
71
 
  virtual int getFileDescriptor(void)= 0;
72
 
 
73
 
  /**
74
 
   * Check to see if the client is currently connected.
75
 
   * @retval Boolean value representing connected state.
76
 
   */
77
 
  virtual bool isConnected(void)= 0;
78
 
 
79
 
  /**
80
 
   * Check to see if the client is actively reading.
81
 
   * @retval Boolean value representing reading state.
82
 
   */
 
48
  virtual bool isConnected()= 0;
 
49
  virtual void setReadTimeout(uint32_t timeout)= 0;
 
50
  virtual void setWriteTimeout(uint32_t timeout)= 0;
 
51
  virtual void setRetryCount(uint32_t count)= 0;
 
52
  virtual void setError(char error)= 0;
 
53
  virtual bool haveError(void)= 0;
 
54
  virtual bool wasAborted(void)= 0;
 
55
  virtual void enableCompression(void)= 0;
 
56
  virtual bool haveMoreData(void)= 0;
83
57
  virtual bool isReading(void)= 0;
84
 
 
85
 
  /**
86
 
   * Check to see if the client is actively writing.
87
 
   * @retval Boolean value representing writing state.
88
 
   */
89
58
  virtual bool isWriting(void)= 0;
90
 
 
91
 
  /**
92
 
   * Flush all data that has been buffered with store() methods.
93
 
   * @retval Boolean indicating success or failure.
94
 
   */
95
 
  virtual bool flush(void)= 0;
96
 
 
97
 
  /**
98
 
   * Close the client object.
99
 
   */
100
 
  virtual void close(void)= 0;
101
 
 
102
 
  /**
103
 
   * Perform handshake and authorize client if needed.
104
 
   */
105
 
  virtual bool authenticate(void)= 0;
106
 
 
107
 
  /**
108
 
   * Read command from client.
109
 
   */
110
 
  virtual bool readCommand(char **packet, uint32_t *packet_length)= 0;
111
 
 
112
 
  /* Send responses. */
113
 
  virtual void sendOK(void)= 0;
114
 
  virtual void sendEOF(void)= 0;
115
 
  virtual void sendError(uint32_t sql_errno, const char *err)= 0;
116
 
 
117
 
  /**
118
 
   * Send field list for result set.
119
 
   */
120
 
  virtual bool sendFields(List<Item> *list)= 0;
121
 
 
122
 
  /* Send result fields in various forms. */
 
59
  virtual bool setFileDescriptor(int fd)=0;
 
60
  virtual int fileDescriptor(void)=0;
 
61
  virtual void setRandom(uint64_t, uint64_t) {};
 
62
  virtual bool authenticate(void)=0;
 
63
  virtual bool readCommand(char **packet, uint32_t *packet_length)=0;
 
64
  virtual void sendOK()= 0;
 
65
  virtual void sendEOF()= 0;
 
66
  virtual void sendError(uint32_t sql_errno, const char *err)=0;
 
67
  virtual void close()= 0;
 
68
  virtual void forceClose()= 0;
 
69
  virtual void prepareForResend()= 0;
 
70
  virtual void free()= 0;
 
71
  virtual bool write()= 0;
 
72
 
 
73
  enum { SEND_NUM_ROWS= 1, SEND_DEFAULTS= 2, SEND_EOF= 4 };
 
74
  virtual bool sendFields(List<Item> *list, uint32_t flags)= 0;
 
75
 
123
76
  virtual bool store(Field *from)= 0;
124
77
  virtual bool store(void)= 0;
125
78
  virtual bool store(int32_t from)= 0;
127
80
  virtual bool store(int64_t from)= 0;
128
81
  virtual bool store(uint64_t from)= 0;
129
82
  virtual bool store(double from, uint32_t decimals, String *buffer)= 0;
130
 
  virtual bool store(const DRIZZLE_TIME *from);
131
 
  virtual bool store(const char *from);
132
 
  virtual bool store(const char *from, size_t length)= 0;
133
 
 
134
 
  /* Try to remove these. */
135
 
  virtual bool haveMoreData(void)= 0;
136
 
  virtual bool haveError(void)= 0;
137
 
  virtual bool wasAborted(void)= 0;
138
 
 
139
 
};
140
 
 
141
 
} /* end namespace drizzled::plugin */
142
 
} /* end namespace drizzled */
143
 
 
144
 
#endif /* DRIZZLED_PLUGIN_CLIENT_H */
 
83
  virtual bool store(const DRIZZLE_TIME *from)= 0;
 
84
  virtual bool store(const char *from, const CHARSET_INFO * const cs)
 
85
  {
 
86
    if (from == NULL)
 
87
      store();
 
88
    return store(from, strlen(from), cs);
 
89
  }
 
90
  virtual bool store(const char *from, size_t length,
 
91
                     const CHARSET_INFO * const cs)= 0;
 
92
};
 
93
 
 
94
class ProtocolFactory
 
95
{
 
96
  std::string name;
 
97
public:
 
98
  ProtocolFactory(std::string name_arg): name(name_arg) {}
 
99
  ProtocolFactory(const char *name_arg): name(name_arg) {}
 
100
  virtual ~ProtocolFactory() {}
 
101
  virtual Protocol *operator()(void)= 0;
 
102
  std::string getName() {return name;}
 
103
};
 
104
 
 
105
#endif /* DRIZZLED_PLUGIN_PROTOCOL_H */