Nino Der Kinderen / Mbed 2 deprecated InetTest

Embedded C project:18/12/2014

Dependencies:   DS1307 TextLCD mbed

NetServices/services/mysql/MySQLClient.h@0:8d87bc453349, 2014-12-18 (annotated)

Committer:
ninoderkinderen
Date:
Thu Dec 18 09:35:49 2014 +0000
Revision:
0:8d87bc453349
Programma embedded C

Who changed what in which revision?

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