Donatien Garnier
NetServices Stack source
Dependents: HelloWorld ServoInterfaceBoardExample1 4180_Lab4
services/mysql/MySQLClient.h@11:da4498f591ee, 2010-08-05 (annotated)
- Committer:
- donatien
- Date:
- Thu Aug 05 15:01:33 2010 +0000
- Revision:
- 11:da4498f591ee
- Parent:
- 9:c79fa4034f5b
Who changed what in which revision?
| User | Revision | Line number | New contents of line |
|---|---|---|---|
| donatien | 0:632c9925f013 | 1 | |
| donatien | 0:632c9925f013 | 2 | /* |
| donatien | 0:632c9925f013 | 3 | Copyright (c) 2010 Donatien Garnier (donatiengar [at] gmail [dot] com) |
| donatien | 0:632c9925f013 | 4 | |
| donatien | 0:632c9925f013 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy |
| donatien | 0:632c9925f013 | 6 | of this software and associated documentation files (the "Software"), to deal |
| donatien | 0:632c9925f013 | 7 | in the Software without restriction, including without limitation the rights |
| donatien | 0:632c9925f013 | 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell |
| donatien | 0:632c9925f013 | 9 | copies of the Software, and to permit persons to whom the Software is |
| donatien | 0:632c9925f013 | 10 | furnished to do so, subject to the following conditions: |
| donatien | 0:632c9925f013 | 11 | |
| donatien | 0:632c9925f013 | 12 | The above copyright notice and this permission notice shall be included in |
| donatien | 0:632c9925f013 | 13 | all copies or substantial portions of the Software. |
| donatien | 0:632c9925f013 | 14 | |
| donatien | 0:632c9925f013 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
| donatien | 0:632c9925f013 | 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
| donatien | 0:632c9925f013 | 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE |
| donatien | 0:632c9925f013 | 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
| donatien | 0:632c9925f013 | 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, |
| donatien | 0:632c9925f013 | 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN |
| donatien | 0:632c9925f013 | 21 | THE SOFTWARE. |
| donatien | 0:632c9925f013 | 22 | */ |
| donatien | 0:632c9925f013 | 23 | |
| donatien | 6:b7dd7cde8ad2 | 24 | /** \file |
| donatien | 6:b7dd7cde8ad2 | 25 | MySQL Client header file |
| donatien | 6:b7dd7cde8ad2 | 26 | */ |
| donatien | 6:b7dd7cde8ad2 | 27 | |
| donatien | 0:632c9925f013 | 28 | #ifndef MYSQL_CLIENT_H |
| donatien | 0:632c9925f013 | 29 | #define MYSQL_CLIENT_H |
| donatien | 0:632c9925f013 | 30 | |
| donatien | 9:c79fa4034f5b | 31 | #include "core/net.h" |
| donatien | 9:c79fa4034f5b | 32 | #include "core/netservice.h" |
| donatien | 0:632c9925f013 | 33 | #include "api/TCPSocket.h" |
| donatien | 0:632c9925f013 | 34 | #include "api/DNSRequest.h" |
| donatien | 0:632c9925f013 | 35 | #include "mbed.h" |
| donatien | 0:632c9925f013 | 36 | |
| donatien | 0:632c9925f013 | 37 | #include <string> |
| donatien | 0:632c9925f013 | 38 | using std::string; |
| donatien | 0:632c9925f013 | 39 | |
| donatien | 0:632c9925f013 | 40 | #include <map> |
| donatien | 0:632c9925f013 | 41 | using std::map; |
| donatien | 0:632c9925f013 | 42 | |
| donatien | 0:632c9925f013 | 43 | typedef unsigned char byte; |
| donatien | 0:632c9925f013 | 44 | |
| donatien | 5:dd63a1e02b1b | 45 | ///MySQL client results |
| donatien | 0:632c9925f013 | 46 | enum MySQLResult |
| donatien | 0:632c9925f013 | 47 | { |
| donatien | 6:b7dd7cde8ad2 | 48 | MYSQL_OK, ///<Success |
| donatien | 6:b7dd7cde8ad2 | 49 | MYSQL_PROCESSING, ///<Processing |
| donatien | 6:b7dd7cde8ad2 | 50 | MYSQL_PRTCL, ///<Protocol error |
| donatien | 6:b7dd7cde8ad2 | 51 | MYSQL_SETUP, ///<Not properly configured |
| donatien | 6:b7dd7cde8ad2 | 52 | MYSQL_DNS, ///<Could not resolve name |
| donatien | 6:b7dd7cde8ad2 | 53 | MYSQL_AUTHFAILED, ///<Auth failure |
| donatien | 6:b7dd7cde8ad2 | 54 | MYSQL_READY, ///<Ready to send commands |
| donatien | 6:b7dd7cde8ad2 | 55 | MYSQL_SQL, ///<SQL Error |
| donatien | 6:b7dd7cde8ad2 | 56 | MYSQL_TIMEOUT, ///<Connection timeout |
| donatien | 6:b7dd7cde8ad2 | 57 | MYSQL_CONN ///<Connection error |
| donatien | 0:632c9925f013 | 58 | }; |
| donatien | 0:632c9925f013 | 59 | |
| donatien | 5:dd63a1e02b1b | 60 | ///A MySQL Client |
| donatien | 5:dd63a1e02b1b | 61 | /** |
| donatien | 5:dd63a1e02b1b | 62 | This MySQL client implements a limited subset of the MySQL internal client/server protocol (including authentication), for server versions 4.1 and newer. |
| donatien | 5:dd63a1e02b1b | 63 | */ |
| donatien | 0:632c9925f013 | 64 | class MySQLClient : protected NetService |
| donatien | 0:632c9925f013 | 65 | { |
| donatien | 0:632c9925f013 | 66 | public: |
| donatien | 5:dd63a1e02b1b | 67 | ///Instantiates the MySQL client |
| donatien | 0:632c9925f013 | 68 | MySQLClient(); |
| donatien | 0:632c9925f013 | 69 | virtual ~MySQLClient(); |
| donatien | 0:632c9925f013 | 70 | |
| donatien | 0:632c9925f013 | 71 | //High Level setup functions |
| donatien | 5:dd63a1e02b1b | 72 | |
| donatien | 5:dd63a1e02b1b | 73 | ///Opens a connection to a server |
| donatien | 5:dd63a1e02b1b | 74 | /** |
| donatien | 5:dd63a1e02b1b | 75 | Opens a connection to the server host using the provided username, password passowrd and selecting database |
| donatien | 5:dd63a1e02b1b | 76 | On completion of this call (and any further one), the callback set in parameter is fired with the result of that command in parameter |
| donatien | 5:dd63a1e02b1b | 77 | @param host : server |
| donatien | 5:dd63a1e02b1b | 78 | @param user : username |
| donatien | 5:dd63a1e02b1b | 79 | @param db : database to use |
| donatien | 5:dd63a1e02b1b | 80 | @param pMethod : callback to call on each request completion |
| donatien | 5:dd63a1e02b1b | 81 | */ |
| donatien | 0:632c9925f013 | 82 | MySQLResult open(Host& host, const string& user, const string& password, const string& db, void (*pMethod)(MySQLResult)); //Non blocking |
| donatien | 5:dd63a1e02b1b | 83 | |
| donatien | 5:dd63a1e02b1b | 84 | ///Opens a connection to a server |
| donatien | 5:dd63a1e02b1b | 85 | /** |
| donatien | 5:dd63a1e02b1b | 86 | Opens a connection to the server host using the provided username, password passowrd and selecting database |
| donatien | 5:dd63a1e02b1b | 87 | On completion of this call (and any further one), the callback set in parameter is fired with the result of that command in parameter |
| donatien | 5:dd63a1e02b1b | 88 | @param host : server |
| donatien | 5:dd63a1e02b1b | 89 | @param user : username |
| donatien | 5:dd63a1e02b1b | 90 | @param db : database to use |
| donatien | 5:dd63a1e02b1b | 91 | @param pItem : callback's class instance |
| donatien | 5:dd63a1e02b1b | 92 | @param pMethod : callback's method to call on each request completion |
| donatien | 5:dd63a1e02b1b | 93 | */ |
| donatien | 0:632c9925f013 | 94 | template<class T> |
| donatien | 0:632c9925f013 | 95 | MySQLResult open(Host& host, const string& user, const string& password, const string& db, T* pItem, void (T::*pMethod)(MySQLResult)) //Non blocking |
| donatien | 0:632c9925f013 | 96 | { |
| donatien | 0:632c9925f013 | 97 | setOnResult(pItem, pMethod); |
| donatien | 0:632c9925f013 | 98 | setup(host, user, password, db); |
| donatien | 0:632c9925f013 | 99 | return MYSQL_PROCESSING; |
| donatien | 0:632c9925f013 | 100 | } |
| donatien | 0:632c9925f013 | 101 | |
| donatien | 5:dd63a1e02b1b | 102 | |
| donatien | 5:dd63a1e02b1b | 103 | ///Executes an SQL command |
| donatien | 5:dd63a1e02b1b | 104 | /** |
| donatien | 5:dd63a1e02b1b | 105 | Executes an SQL request on the SQL server |
| donatien | 5:dd63a1e02b1b | 106 | This is a non-blocking function |
| donatien | 5:dd63a1e02b1b | 107 | On completion, the callback set in the open function is fired with the result of the command in parameter |
| donatien | 5:dd63a1e02b1b | 108 | @param sqlCommand SQL request to execute |
| donatien | 5:dd63a1e02b1b | 109 | */ |
| donatien | 0:632c9925f013 | 110 | MySQLResult sql(string& sqlCommand); |
| donatien | 0:632c9925f013 | 111 | |
| donatien | 5:dd63a1e02b1b | 112 | ///Closes the connection to the server |
| donatien | 0:632c9925f013 | 113 | MySQLResult exit(); |
| donatien | 0:632c9925f013 | 114 | |
| donatien | 0:632c9925f013 | 115 | void setOnResult( void (*pMethod)(MySQLResult) ); |
| donatien | 0:632c9925f013 | 116 | class CDummy; |
| donatien | 0:632c9925f013 | 117 | template<class T> |
| donatien | 0:632c9925f013 | 118 | void setOnResult( T* pItem, void (T::*pMethod)(MySQLResult) ) |
| donatien | 0:632c9925f013 | 119 | { |
| donatien | 0:632c9925f013 | 120 | m_pCb = NULL; |
| donatien | 0:632c9925f013 | 121 | m_pCbItem = (CDummy*) pItem; |
| donatien | 0:632c9925f013 | 122 | m_pCbMeth = (void (CDummy::*)(MySQLResult)) pMethod; |
| donatien | 0:632c9925f013 | 123 | } |
| donatien | 0:632c9925f013 | 124 | |
| donatien | 5:dd63a1e02b1b | 125 | ///Setups timeout |
| donatien | 5:dd63a1e02b1b | 126 | /** |
| donatien | 5:dd63a1e02b1b | 127 | @param ms : time of connection inactivity in ms after which the request should timeout |
| donatien | 5:dd63a1e02b1b | 128 | */ |
| donatien | 0:632c9925f013 | 129 | void setTimeout(int ms); |
| donatien | 0:632c9925f013 | 130 | |
| donatien | 0:632c9925f013 | 131 | virtual void poll(); //Called by NetServices |
| donatien | 0:632c9925f013 | 132 | |
| donatien | 0:632c9925f013 | 133 | protected: |
| donatien | 0:632c9925f013 | 134 | void resetTimeout(); |
| donatien | 0:632c9925f013 | 135 | |
| donatien | 0:632c9925f013 | 136 | void init(); |
| donatien | 0:632c9925f013 | 137 | void close(); |
| donatien | 0:632c9925f013 | 138 | |
| donatien | 0:632c9925f013 | 139 | void setup(Host& host, const string& user, const string& password, const string& db); //Setup connection, make DNS Req if necessary |
| donatien | 0:632c9925f013 | 140 | void connect(); //Start Connection |
| donatien | 0:632c9925f013 | 141 | |
| donatien | 0:632c9925f013 | 142 | void handleHandshake(); |
| donatien | 0:632c9925f013 | 143 | void sendAuth(); |
| donatien | 0:632c9925f013 | 144 | |
| donatien | 0:632c9925f013 | 145 | void handleAuthResult(); |
| donatien | 0:632c9925f013 | 146 | void sendAuth323(); |
| donatien | 0:632c9925f013 | 147 | |
| donatien | 0:632c9925f013 | 148 | void sendCommand(byte command, byte* arg, int len); |
| donatien | 0:632c9925f013 | 149 | void handleCommandResult(); |
| donatien | 0:632c9925f013 | 150 | |
| donatien | 0:632c9925f013 | 151 | void readData(); //Copy to buf |
| donatien | 0:632c9925f013 | 152 | void writeData(); //Copy from buf |
| donatien | 0:632c9925f013 | 153 | |
| donatien | 0:632c9925f013 | 154 | void onTCPSocketEvent(TCPSocketEvent e); |
| donatien | 0:632c9925f013 | 155 | void onDNSReply(DNSReply r); |
| donatien | 0:632c9925f013 | 156 | void onResult(MySQLResult r); //Called when exchange completed or on failure |
| donatien | 0:632c9925f013 | 157 | void onTimeout(); //Connection has timed out |
| donatien | 0:632c9925f013 | 158 | |
| donatien | 0:632c9925f013 | 159 | private: |
| donatien | 0:632c9925f013 | 160 | CDummy* m_pCbItem; |
| donatien | 0:632c9925f013 | 161 | void (CDummy::*m_pCbMeth)(MySQLResult); |
| donatien | 0:632c9925f013 | 162 | |
| donatien | 0:632c9925f013 | 163 | void (*m_pCb)(MySQLResult); |
| donatien | 0:632c9925f013 | 164 | |
| donatien | 0:632c9925f013 | 165 | TCPSocket* m_pTCPSocket; |
| donatien | 0:632c9925f013 | 166 | |
| donatien | 0:632c9925f013 | 167 | Timer m_watchdog; |
| donatien | 0:632c9925f013 | 168 | int m_timeout; |
| donatien | 0:632c9925f013 | 169 | |
| donatien | 0:632c9925f013 | 170 | DNSRequest* m_pDnsReq; |
| donatien | 0:632c9925f013 | 171 | |
| donatien | 0:632c9925f013 | 172 | bool m_closed; |
| donatien | 0:632c9925f013 | 173 | |
| donatien | 0:632c9925f013 | 174 | enum MySQLStep |
| donatien | 0:632c9925f013 | 175 | { |
| donatien | 0:632c9925f013 | 176 | // MYSQL_INIT, |
| donatien | 0:632c9925f013 | 177 | MYSQL_HANDSHAKE, |
| donatien | 0:632c9925f013 | 178 | MYSQL_AUTH, |
| donatien | 0:632c9925f013 | 179 | MYSQL_COMMANDS, |
| donatien | 0:632c9925f013 | 180 | MYSQL_CLOSED |
| donatien | 0:632c9925f013 | 181 | }; |
| donatien | 0:632c9925f013 | 182 | |
| donatien | 0:632c9925f013 | 183 | //Parameters |
| donatien | 0:632c9925f013 | 184 | Host m_host; |
| donatien | 0:632c9925f013 | 185 | |
| donatien | 0:632c9925f013 | 186 | string m_user; |
| donatien | 0:632c9925f013 | 187 | string m_password; |
| donatien | 0:632c9925f013 | 188 | string m_db; |
| donatien | 0:632c9925f013 | 189 | |
| donatien | 0:632c9925f013 | 190 | //Low-level buffers & state-machine |
| donatien | 0:632c9925f013 | 191 | MySQLStep m_state; |
| donatien | 0:632c9925f013 | 192 | |
| donatien | 0:632c9925f013 | 193 | byte* m_buf; |
| donatien | 0:632c9925f013 | 194 | byte* m_pPos; |
| donatien | 0:632c9925f013 | 195 | int m_len; |
| donatien | 0:632c9925f013 | 196 | int m_size; |
| donatien | 0:632c9925f013 | 197 | |
| donatien | 0:632c9925f013 | 198 | int m_packetId; |
| donatien | 0:632c9925f013 | 199 | |
| donatien | 0:632c9925f013 | 200 | }; |
| donatien | 0:632c9925f013 | 201 | |
| donatien | 0:632c9925f013 | 202 | #endif |