Important changes to repositories hosted on mbed.com
Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.
To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.
It is also possible to export all your personal repositories from the account settings page.
Dependents: HelloWorld ServoInterfaceBoardExample1 4180_Lab4
services/mysql/MySQLClient.h@0:632c9925f013, 2010-06-11 (annotated)
- Committer:
- donatien
- Date:
- Fri Jun 11 16:05:15 2010 +0000
- Revision:
- 0:632c9925f013
- Child:
- 5:dd63a1e02b1b
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 | 0:632c9925f013 | 24 | #ifndef MYSQL_CLIENT_H | 
| donatien | 0:632c9925f013 | 25 | #define MYSQL_CLIENT_H | 
| donatien | 0:632c9925f013 | 26 | |
| donatien | 0:632c9925f013 | 27 | #include "if/net/net.h" | 
| donatien | 0:632c9925f013 | 28 | #include "api/TCPSocket.h" | 
| donatien | 0:632c9925f013 | 29 | #include "api/DNSRequest.h" | 
| donatien | 0:632c9925f013 | 30 | #include "mbed.h" | 
| donatien | 0:632c9925f013 | 31 | |
| donatien | 0:632c9925f013 | 32 | #include <string> | 
| donatien | 0:632c9925f013 | 33 | using std::string; | 
| donatien | 0:632c9925f013 | 34 | |
| donatien | 0:632c9925f013 | 35 | #include <map> | 
| donatien | 0:632c9925f013 | 36 | using std::map; | 
| donatien | 0:632c9925f013 | 37 | |
| donatien | 0:632c9925f013 | 38 | typedef unsigned char byte; | 
| donatien | 0:632c9925f013 | 39 | |
| donatien | 0:632c9925f013 | 40 | enum MySQLResult | 
| donatien | 0:632c9925f013 | 41 | { | 
| donatien | 0:632c9925f013 | 42 | MYSQL_OK, | 
| donatien | 0:632c9925f013 | 43 | MYSQL_PROCESSING, | 
| donatien | 0:632c9925f013 | 44 | MYSQL_PRTCL, | 
| donatien | 0:632c9925f013 | 45 | MYSQL_SETUP, //Not properly configured | 
| donatien | 0:632c9925f013 | 46 | MYSQL_DNS, //Could not resolve name | 
| donatien | 0:632c9925f013 | 47 | MYSQL_AUTHFAILED, //Auth failure | 
| donatien | 0:632c9925f013 | 48 | MYSQL_READY, //Ready to send commands | 
| donatien | 0:632c9925f013 | 49 | MYSQL_SQL, //SQL Error | 
| donatien | 0:632c9925f013 | 50 | MYSQL_TIMEOUT, //Connection timeout | 
| donatien | 0:632c9925f013 | 51 | MYSQL_CONN //Connection error | 
| donatien | 0:632c9925f013 | 52 | }; | 
| donatien | 0:632c9925f013 | 53 | |
| donatien | 0:632c9925f013 | 54 | class MySQLClient : protected NetService | 
| donatien | 0:632c9925f013 | 55 | { | 
| donatien | 0:632c9925f013 | 56 | public: | 
| donatien | 0:632c9925f013 | 57 | MySQLClient(); | 
| donatien | 0:632c9925f013 | 58 | virtual ~MySQLClient(); | 
| donatien | 0:632c9925f013 | 59 | |
| donatien | 0:632c9925f013 | 60 | //High Level setup functions | 
| donatien | 0:632c9925f013 | 61 | MySQLResult open(Host& host, const string& user, const string& password, const string& db, void (*pMethod)(MySQLResult)); //Non blocking | 
| donatien | 0:632c9925f013 | 62 | template<class T> | 
| donatien | 0:632c9925f013 | 63 | MySQLResult open(Host& host, const string& user, const string& password, const string& db, T* pItem, void (T::*pMethod)(MySQLResult)) //Non blocking | 
| donatien | 0:632c9925f013 | 64 | { | 
| donatien | 0:632c9925f013 | 65 | setOnResult(pItem, pMethod); | 
| donatien | 0:632c9925f013 | 66 | setup(host, user, password, db); | 
| donatien | 0:632c9925f013 | 67 | return MYSQL_PROCESSING; | 
| donatien | 0:632c9925f013 | 68 | } | 
| donatien | 0:632c9925f013 | 69 | |
| donatien | 0:632c9925f013 | 70 | MySQLResult sql(string& sqlCommand); | 
| donatien | 0:632c9925f013 | 71 | |
| donatien | 0:632c9925f013 | 72 | MySQLResult exit(); | 
| donatien | 0:632c9925f013 | 73 | |
| donatien | 0:632c9925f013 | 74 | void setOnResult( void (*pMethod)(MySQLResult) ); | 
| donatien | 0:632c9925f013 | 75 | class CDummy; | 
| donatien | 0:632c9925f013 | 76 | template<class T> | 
| donatien | 0:632c9925f013 | 77 | void setOnResult( T* pItem, void (T::*pMethod)(MySQLResult) ) | 
| donatien | 0:632c9925f013 | 78 | { | 
| donatien | 0:632c9925f013 | 79 | m_pCb = NULL; | 
| donatien | 0:632c9925f013 | 80 | m_pCbItem = (CDummy*) pItem; | 
| donatien | 0:632c9925f013 | 81 | m_pCbMeth = (void (CDummy::*)(MySQLResult)) pMethod; | 
| donatien | 0:632c9925f013 | 82 | } | 
| donatien | 0:632c9925f013 | 83 | |
| donatien | 0:632c9925f013 | 84 | void setTimeout(int ms); | 
| donatien | 0:632c9925f013 | 85 | |
| donatien | 0:632c9925f013 | 86 | virtual void poll(); //Called by NetServices | 
| donatien | 0:632c9925f013 | 87 | |
| donatien | 0:632c9925f013 | 88 | protected: | 
| donatien | 0:632c9925f013 | 89 | void resetTimeout(); | 
| donatien | 0:632c9925f013 | 90 | |
| donatien | 0:632c9925f013 | 91 | void init(); | 
| donatien | 0:632c9925f013 | 92 | void close(); | 
| donatien | 0:632c9925f013 | 93 | |
| donatien | 0:632c9925f013 | 94 | void setup(Host& host, const string& user, const string& password, const string& db); //Setup connection, make DNS Req if necessary | 
| donatien | 0:632c9925f013 | 95 | void connect(); //Start Connection | 
| donatien | 0:632c9925f013 | 96 | |
| donatien | 0:632c9925f013 | 97 | void handleHandshake(); | 
| donatien | 0:632c9925f013 | 98 | void sendAuth(); | 
| donatien | 0:632c9925f013 | 99 | |
| donatien | 0:632c9925f013 | 100 | void handleAuthResult(); | 
| donatien | 0:632c9925f013 | 101 | void sendAuth323(); | 
| donatien | 0:632c9925f013 | 102 | |
| donatien | 0:632c9925f013 | 103 | void sendCommand(byte command, byte* arg, int len); | 
| donatien | 0:632c9925f013 | 104 | void handleCommandResult(); | 
| donatien | 0:632c9925f013 | 105 | |
| donatien | 0:632c9925f013 | 106 | void readData(); //Copy to buf | 
| donatien | 0:632c9925f013 | 107 | void writeData(); //Copy from buf | 
| donatien | 0:632c9925f013 | 108 | |
| donatien | 0:632c9925f013 | 109 | void onTCPSocketEvent(TCPSocketEvent e); | 
| donatien | 0:632c9925f013 | 110 | void onDNSReply(DNSReply r); | 
| donatien | 0:632c9925f013 | 111 | void onResult(MySQLResult r); //Called when exchange completed or on failure | 
| donatien | 0:632c9925f013 | 112 | void onTimeout(); //Connection has timed out | 
| donatien | 0:632c9925f013 | 113 | |
| donatien | 0:632c9925f013 | 114 | private: | 
| donatien | 0:632c9925f013 | 115 | CDummy* m_pCbItem; | 
| donatien | 0:632c9925f013 | 116 | void (CDummy::*m_pCbMeth)(MySQLResult); | 
| donatien | 0:632c9925f013 | 117 | |
| donatien | 0:632c9925f013 | 118 | void (*m_pCb)(MySQLResult); | 
| donatien | 0:632c9925f013 | 119 | |
| donatien | 0:632c9925f013 | 120 | TCPSocket* m_pTCPSocket; | 
| donatien | 0:632c9925f013 | 121 | |
| donatien | 0:632c9925f013 | 122 | Timer m_watchdog; | 
| donatien | 0:632c9925f013 | 123 | int m_timeout; | 
| donatien | 0:632c9925f013 | 124 | |
| donatien | 0:632c9925f013 | 125 | DNSRequest* m_pDnsReq; | 
| donatien | 0:632c9925f013 | 126 | |
| donatien | 0:632c9925f013 | 127 | bool m_closed; | 
| donatien | 0:632c9925f013 | 128 | |
| donatien | 0:632c9925f013 | 129 | enum MySQLStep | 
| donatien | 0:632c9925f013 | 130 | { | 
| donatien | 0:632c9925f013 | 131 | // MYSQL_INIT, | 
| donatien | 0:632c9925f013 | 132 | MYSQL_HANDSHAKE, | 
| donatien | 0:632c9925f013 | 133 | MYSQL_AUTH, | 
| donatien | 0:632c9925f013 | 134 | MYSQL_COMMANDS, | 
| donatien | 0:632c9925f013 | 135 | MYSQL_CLOSED | 
| donatien | 0:632c9925f013 | 136 | }; | 
| donatien | 0:632c9925f013 | 137 | |
| donatien | 0:632c9925f013 | 138 | //Parameters | 
| donatien | 0:632c9925f013 | 139 | Host m_host; | 
| donatien | 0:632c9925f013 | 140 | |
| donatien | 0:632c9925f013 | 141 | string m_user; | 
| donatien | 0:632c9925f013 | 142 | string m_password; | 
| donatien | 0:632c9925f013 | 143 | string m_db; | 
| donatien | 0:632c9925f013 | 144 | |
| donatien | 0:632c9925f013 | 145 | //Low-level buffers & state-machine | 
| donatien | 0:632c9925f013 | 146 | MySQLStep m_state; | 
| donatien | 0:632c9925f013 | 147 | |
| donatien | 0:632c9925f013 | 148 | byte* m_buf; | 
| donatien | 0:632c9925f013 | 149 | byte* m_pPos; | 
| donatien | 0:632c9925f013 | 150 | int m_len; | 
| donatien | 0:632c9925f013 | 151 | int m_size; | 
| donatien | 0:632c9925f013 | 152 | |
| donatien | 0:632c9925f013 | 153 | int m_packetId; | 
| donatien | 0:632c9925f013 | 154 | |
| donatien | 0:632c9925f013 | 155 | }; | 
| donatien | 0:632c9925f013 | 156 | |
| donatien | 0:632c9925f013 | 157 | #endif |