Brandon Fictorie / Mbed 2 deprecated BF_Websocket

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.

Dependencies:   mbed

NetServices/services/mysql/MySQLClient.h@0:8cdad1c73e8e, 2012-03-25 (annotated)

Committer:
bfictorie
Date:
Sun Mar 25 17:26:30 2012 +0000
Revision:
0:8cdad1c73e8e

        

        
Who changed what in which revision?

        

            
                
UserRevisionLine numberNew contents of line

            
            


bfictorie

0:8cdad1c73e8e


     1







bfictorie

0:8cdad1c73e8e


     2

/*





bfictorie

0:8cdad1c73e8e


     3

Copyright (c) 2010 Donatien Garnier (donatiengar [at] gmail [dot] com)





bfictorie

0:8cdad1c73e8e


     4

 





bfictorie

0:8cdad1c73e8e


     5

Permission is hereby granted, free of charge, to any person obtaining a copy





bfictorie

0:8cdad1c73e8e


     6

of this software and associated documentation files (the "Software"), to deal





bfictorie

0:8cdad1c73e8e


     7

in the Software without restriction, including without limitation the rights





bfictorie

0:8cdad1c73e8e


     8

to use, copy, modify, merge, publish, distribute, sublicense, and/or sell





bfictorie

0:8cdad1c73e8e


     9

copies of the Software, and to permit persons to whom the Software is





bfictorie

0:8cdad1c73e8e


    10

furnished to do so, subject to the following conditions:





bfictorie

0:8cdad1c73e8e


    11

 





bfictorie

0:8cdad1c73e8e


    12

The above copyright notice and this permission notice shall be included in





bfictorie

0:8cdad1c73e8e


    13

all copies or substantial portions of the Software.





bfictorie

0:8cdad1c73e8e


    14

 





bfictorie

0:8cdad1c73e8e


    15

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR





bfictorie

0:8cdad1c73e8e


    16

IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,





bfictorie

0:8cdad1c73e8e


    17

FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE





bfictorie

0:8cdad1c73e8e


    18

AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER





bfictorie

0:8cdad1c73e8e


    19

LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,





bfictorie

0:8cdad1c73e8e


    20

OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN





bfictorie

0:8cdad1c73e8e


    21

THE SOFTWARE.





bfictorie

0:8cdad1c73e8e


    22

*/





bfictorie

0:8cdad1c73e8e


    23







bfictorie

0:8cdad1c73e8e


    24

/** \file





bfictorie

0:8cdad1c73e8e


    25

MySQL Client header file





bfictorie

0:8cdad1c73e8e


    26

*/





bfictorie

0:8cdad1c73e8e


    27







bfictorie

0:8cdad1c73e8e


    28

#ifndef MYSQL_CLIENT_H





bfictorie

0:8cdad1c73e8e


    29

#define MYSQL_CLIENT_H





bfictorie

0:8cdad1c73e8e


    30







bfictorie

0:8cdad1c73e8e


    31

#include "core/net.h"





bfictorie

0:8cdad1c73e8e


    32

#include "core/netservice.h"





bfictorie

0:8cdad1c73e8e


    33

#include "api/TCPSocket.h"





bfictorie

0:8cdad1c73e8e


    34

#include "api/DNSRequest.h"





bfictorie

0:8cdad1c73e8e


    35

#include "mbed.h"





bfictorie

0:8cdad1c73e8e


    36







bfictorie

0:8cdad1c73e8e


    37

#include <string>





bfictorie

0:8cdad1c73e8e


    38

using std::string;





bfictorie

0:8cdad1c73e8e


    39







bfictorie

0:8cdad1c73e8e


    40

#include <map>





bfictorie

0:8cdad1c73e8e


    41

using std::map;





bfictorie

0:8cdad1c73e8e


    42







bfictorie

0:8cdad1c73e8e


    43

typedef unsigned char byte;





bfictorie

0:8cdad1c73e8e


    44







bfictorie

0:8cdad1c73e8e


    45

///MySQL client results





bfictorie

0:8cdad1c73e8e


    46

enum MySQLResult





bfictorie

0:8cdad1c73e8e


    47

{





bfictorie

0:8cdad1c73e8e


    48

  MYSQL_OK, ///<Success





bfictorie

0:8cdad1c73e8e


    49

  MYSQL_PROCESSING, ///<Processing





bfictorie

0:8cdad1c73e8e


    50

  MYSQL_PRTCL, ///<Protocol error





bfictorie

0:8cdad1c73e8e


    51

  MYSQL_SETUP, ///<Not properly configured





bfictorie

0:8cdad1c73e8e


    52

  MYSQL_DNS, ///<Could not resolve name





bfictorie

0:8cdad1c73e8e


    53

  MYSQL_AUTHFAILED, ///<Auth failure





bfictorie

0:8cdad1c73e8e


    54

  MYSQL_READY, ///<Ready to send commands





bfictorie

0:8cdad1c73e8e


    55

  MYSQL_SQL, ///<SQL Error





bfictorie

0:8cdad1c73e8e


    56

  MYSQL_TIMEOUT, ///<Connection timeout





bfictorie

0:8cdad1c73e8e


    57

  MYSQL_CONN ///<Connection error





bfictorie

0:8cdad1c73e8e


    58

};





bfictorie

0:8cdad1c73e8e


    59







bfictorie

0:8cdad1c73e8e


    60

///A MySQL Client





bfictorie

0:8cdad1c73e8e


    61

/**





bfictorie

0:8cdad1c73e8e


    62

This MySQL client implements a limited subset of the MySQL internal client/server protocol (including authentication), for server versions 4.1 and newer.





bfictorie

0:8cdad1c73e8e


    63

*/





bfictorie

0:8cdad1c73e8e


    64

class MySQLClient : protected NetService





bfictorie

0:8cdad1c73e8e


    65

{





bfictorie

0:8cdad1c73e8e


    66

public:





bfictorie

0:8cdad1c73e8e


    67

  ///Instantiates the MySQL client





bfictorie

0:8cdad1c73e8e


    68

  MySQLClient();





bfictorie

0:8cdad1c73e8e


    69

  virtual ~MySQLClient();





bfictorie

0:8cdad1c73e8e


    70

  





bfictorie

0:8cdad1c73e8e


    71

  //High Level setup functions





bfictorie

0:8cdad1c73e8e


    72

  





bfictorie

0:8cdad1c73e8e


    73

  ///Opens a connection to a server





bfictorie

0:8cdad1c73e8e


    74

  /**





bfictorie

0:8cdad1c73e8e


    75

  Opens a connection to the server host using the provided username, password passowrd and selecting database





bfictorie

0:8cdad1c73e8e


    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





bfictorie

0:8cdad1c73e8e


    77

  @param host : server





bfictorie

0:8cdad1c73e8e


    78

  @param user : username





bfictorie

0:8cdad1c73e8e


    79

  @param db : database to use





bfictorie

0:8cdad1c73e8e


    80

  @param pMethod : callback to call on each request completion





bfictorie

0:8cdad1c73e8e


    81

  */





bfictorie

0:8cdad1c73e8e


    82

  MySQLResult open(Host& host, const string& user, const string& password, const string& db, void (*pMethod)(MySQLResult)); //Non blocking





bfictorie

0:8cdad1c73e8e


    83

  





bfictorie

0:8cdad1c73e8e


    84

  ///Opens a connection to a server





bfictorie

0:8cdad1c73e8e


    85

  /**





bfictorie

0:8cdad1c73e8e


    86

  Opens a connection to the server host using the provided username, password passowrd and selecting database





bfictorie

0:8cdad1c73e8e


    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





bfictorie

0:8cdad1c73e8e


    88

  @param host : server





bfictorie

0:8cdad1c73e8e


    89

  @param user : username





bfictorie

0:8cdad1c73e8e


    90

  @param db : database to use





bfictorie

0:8cdad1c73e8e


    91

  @param pItem : callback's class instance





bfictorie

0:8cdad1c73e8e


    92

  @param pMethod : callback's method to call on each request completion





bfictorie

0:8cdad1c73e8e


    93

  */





bfictorie

0:8cdad1c73e8e


    94

  template<class T> 





bfictorie

0:8cdad1c73e8e


    95

  MySQLResult open(Host& host, const string& user, const string& password, const string& db, T* pItem, void (T::*pMethod)(MySQLResult)) //Non blocking





bfictorie

0:8cdad1c73e8e


    96

  {





bfictorie

0:8cdad1c73e8e


    97

    setOnResult(pItem, pMethod);





bfictorie

0:8cdad1c73e8e


    98

    setup(host, user, password, db);





bfictorie

0:8cdad1c73e8e


    99

    return MYSQL_PROCESSING;





bfictorie

0:8cdad1c73e8e


   100

  }





bfictorie

0:8cdad1c73e8e


   101

  





bfictorie

0:8cdad1c73e8e


   102

  





bfictorie

0:8cdad1c73e8e


   103

  ///Executes an SQL command





bfictorie

0:8cdad1c73e8e


   104

  /**





bfictorie

0:8cdad1c73e8e


   105

  Executes an SQL request on the SQL server





bfictorie

0:8cdad1c73e8e


   106

  This is a non-blocking function





bfictorie

0:8cdad1c73e8e


   107

  On completion, the callback set in the open function is fired with the result of the command in parameter





bfictorie

0:8cdad1c73e8e


   108

  @param sqlCommand SQL request to execute





bfictorie

0:8cdad1c73e8e


   109

  */





bfictorie

0:8cdad1c73e8e


   110

  MySQLResult sql(string& sqlCommand);





bfictorie

0:8cdad1c73e8e


   111

  





bfictorie

0:8cdad1c73e8e


   112

  ///Closes the connection to the server





bfictorie

0:8cdad1c73e8e


   113

  MySQLResult exit();





bfictorie

0:8cdad1c73e8e


   114

      





bfictorie

0:8cdad1c73e8e


   115

  void setOnResult( void (*pMethod)(MySQLResult) );





bfictorie

0:8cdad1c73e8e


   116

  class CDummy;





bfictorie

0:8cdad1c73e8e


   117

  template<class T> 





bfictorie

0:8cdad1c73e8e


   118

  void setOnResult( T* pItem, void (T::*pMethod)(MySQLResult) )





bfictorie

0:8cdad1c73e8e


   119

  {





bfictorie

0:8cdad1c73e8e


   120

    m_pCb = NULL;





bfictorie

0:8cdad1c73e8e


   121

    m_pCbItem = (CDummy*) pItem;





bfictorie

0:8cdad1c73e8e


   122

    m_pCbMeth = (void (CDummy::*)(MySQLResult)) pMethod;





bfictorie

0:8cdad1c73e8e


   123

  }





bfictorie

0:8cdad1c73e8e


   124

  





bfictorie

0:8cdad1c73e8e


   125

  ///Setups timeout





bfictorie

0:8cdad1c73e8e


   126

  /**





bfictorie

0:8cdad1c73e8e


   127

  @param ms : time of connection inactivity in ms after which the request should timeout





bfictorie

0:8cdad1c73e8e


   128

  */





bfictorie

0:8cdad1c73e8e


   129

  void setTimeout(int ms);





bfictorie

0:8cdad1c73e8e


   130

  





bfictorie

0:8cdad1c73e8e


   131

  virtual void poll(); //Called by NetServices





bfictorie

0:8cdad1c73e8e


   132

  





bfictorie

0:8cdad1c73e8e


   133

protected:





bfictorie

0:8cdad1c73e8e


   134

  void resetTimeout();





bfictorie

0:8cdad1c73e8e


   135

  





bfictorie

0:8cdad1c73e8e


   136

  void init();





bfictorie

0:8cdad1c73e8e


   137

  void close();





bfictorie

0:8cdad1c73e8e


   138

  





bfictorie

0:8cdad1c73e8e


   139

  void setup(Host& host, const string& user, const string& password, const string& db); //Setup connection, make DNS Req if necessary





bfictorie

0:8cdad1c73e8e


   140

  void connect(); //Start Connection





bfictorie

0:8cdad1c73e8e


   141







bfictorie

0:8cdad1c73e8e


   142

  void handleHandshake();





bfictorie

0:8cdad1c73e8e


   143

  void sendAuth();





bfictorie

0:8cdad1c73e8e


   144

  





bfictorie

0:8cdad1c73e8e


   145

  void handleAuthResult();





bfictorie

0:8cdad1c73e8e


   146

  void sendAuth323();





bfictorie

0:8cdad1c73e8e


   147

  





bfictorie

0:8cdad1c73e8e


   148

  void sendCommand(byte command, byte* arg, int len);





bfictorie

0:8cdad1c73e8e


   149

  void handleCommandResult();





bfictorie

0:8cdad1c73e8e


   150

  





bfictorie

0:8cdad1c73e8e


   151

  void readData(); //Copy to buf





bfictorie

0:8cdad1c73e8e


   152

  void writeData(); //Copy from buf





bfictorie

0:8cdad1c73e8e


   153







bfictorie

0:8cdad1c73e8e


   154

  void onTCPSocketEvent(TCPSocketEvent e);





bfictorie

0:8cdad1c73e8e


   155

  void onDNSReply(DNSReply r);





bfictorie

0:8cdad1c73e8e


   156

  void onResult(MySQLResult r); //Called when exchange completed or on failure





bfictorie

0:8cdad1c73e8e


   157

  void onTimeout(); //Connection has timed out





bfictorie

0:8cdad1c73e8e


   158

  





bfictorie

0:8cdad1c73e8e


   159

private:





bfictorie

0:8cdad1c73e8e


   160

  CDummy* m_pCbItem;





bfictorie

0:8cdad1c73e8e


   161

  void (CDummy::*m_pCbMeth)(MySQLResult);





bfictorie

0:8cdad1c73e8e


   162

  





bfictorie

0:8cdad1c73e8e


   163

  void (*m_pCb)(MySQLResult);





bfictorie

0:8cdad1c73e8e


   164

  





bfictorie

0:8cdad1c73e8e


   165

  TCPSocket* m_pTCPSocket;





bfictorie

0:8cdad1c73e8e


   166







bfictorie

0:8cdad1c73e8e


   167

  Timer m_watchdog;





bfictorie

0:8cdad1c73e8e


   168

  int m_timeout;





bfictorie

0:8cdad1c73e8e


   169

  





bfictorie

0:8cdad1c73e8e


   170

  DNSRequest* m_pDnsReq;





bfictorie

0:8cdad1c73e8e


   171

  





bfictorie

0:8cdad1c73e8e


   172

  bool m_closed;





bfictorie

0:8cdad1c73e8e


   173

  





bfictorie

0:8cdad1c73e8e


   174

  enum MySQLStep





bfictorie

0:8cdad1c73e8e


   175

  {





bfictorie

0:8cdad1c73e8e


   176

   // MYSQL_INIT,





bfictorie

0:8cdad1c73e8e


   177

    MYSQL_HANDSHAKE,





bfictorie

0:8cdad1c73e8e


   178

    MYSQL_AUTH,





bfictorie

0:8cdad1c73e8e


   179

    MYSQL_COMMANDS,





bfictorie

0:8cdad1c73e8e


   180

    MYSQL_CLOSED





bfictorie

0:8cdad1c73e8e


   181

  };





bfictorie

0:8cdad1c73e8e


   182

  





bfictorie

0:8cdad1c73e8e


   183

  //Parameters





bfictorie

0:8cdad1c73e8e


   184

  Host m_host;





bfictorie

0:8cdad1c73e8e


   185

  





bfictorie

0:8cdad1c73e8e


   186

  string m_user;





bfictorie

0:8cdad1c73e8e


   187

  string m_password;





bfictorie

0:8cdad1c73e8e


   188

  string m_db;





bfictorie

0:8cdad1c73e8e


   189







bfictorie

0:8cdad1c73e8e


   190

  //Low-level buffers & state-machine





bfictorie

0:8cdad1c73e8e


   191

  MySQLStep m_state;





bfictorie

0:8cdad1c73e8e


   192

  





bfictorie

0:8cdad1c73e8e


   193

  byte* m_buf;





bfictorie

0:8cdad1c73e8e


   194

  byte* m_pPos;





bfictorie

0:8cdad1c73e8e


   195

  int m_len;





bfictorie

0:8cdad1c73e8e


   196

  int m_size;





bfictorie

0:8cdad1c73e8e


   197

  





bfictorie

0:8cdad1c73e8e


   198

  int m_packetId;





bfictorie

0:8cdad1c73e8e


   199

 





bfictorie

0:8cdad1c73e8e


   200

};





bfictorie

0:8cdad1c73e8e


   201







bfictorie

0:8cdad1c73e8e


   202

#endif