MySQLSocket Class Reference
[MySQL C++ Wrappers]

#include <mysqlSocket.hpp>

Inheritance diagram for MySQLSocket:

[legend]

Public Member Functions
	MySQLSocket (const std::string &_userName, const std::string &_passWord, const std::string &_socketName, MySQLDaemonPtr _daemon=MySQLDaemonPtr()) throw (Error)
virtual	~MySQLSocket (void)
	Destructor.
const std::string &	getSocketName (void) const
virtual void	connect (const std::string &database, MYSQL *m) throw (Error)
MySQLDaemonPtr	getDaemon (void) const
Protected Attributes
std::string	socketName
MySQLDaemonPtr	daemon

---

Detailed Description

Store information for connecting to MySQL using a file-socket.

Date:

Sun Feb 19 2006

Author:

Jan Wedekind (wedesoft@users.sourceforge.net)

Definition at line 28 of file mysqlSocket.hpp.

---

Constructor & Destructor Documentation

MySQLSocket::MySQLSocket	(	const std::string &	_userName,
		const std::string &	_passWord,
		const std::string &	_socketName,
		MySQLDaemonPtr	_daemon = MySQLDaemonPtr()
	)			throw (Error)

Constructor. Store information about the file-socket and the MySQL server.

Parameters:

	_userName	Name of database user.
	_passWord	Password of database-user.
	_socketName	Name of the socket for connecting to the server (for example /var/lib/mysql/mysql.sock).

Definition at line 23 of file mysqlSocket.cpp.

00027                                                                 :
00028   MySQLServer( _userName, _passWord ), socketName(_socketName),
00029   daemon(_daemon)
00030 {
00031   connect( "", &connection );
}

MySQLSocket::~MySQLSocket

(

void

)

[virtual]

Destructor.

Definition at line 84 of file mysqlSocket.cpp.

References MySQLServer::connection.

{
  mysql_close( &connection );
}

---

Member Function Documentation

void MySQLSocket::connect	(	const std::string &	database,
		MYSQL *	m
	)			throw (Error) [virtual]

Implements MySQLServer.

Definition at line 33 of file mysqlSocket.cpp.

References timer::elapsed(), and ERRORMACRO.

{
  mysql_init( m );

  const int timeout = 10;// seconds
  mysql_options( m, MYSQL_OPT_CONNECT_TIMEOUT,
                 (const char *)&timeout );

  try {

    MYSQL *result = NULL;
    timer t;

    // Loop if the mysql-daemon was started by this program (server may not
    // be up yet in this case).
    do {
      // Specifying an alternative port will lead to a crash in the library :-(
      result = mysql_real_connect( m, NULL,
                                   userName.c_str(),
                                   passWord.empty() ? (const char *)NULL :
                                   passWord.c_str(),
                                   database.empty() ? (const char *)NULL :
                                   database.c_str(),
                                   0, socketName.c_str(), 0 );
      if ( result == NULL ) {
        if ( t.elapsed() > timeout ||
             mysql_errno( m ) != CR_CONNECTION_ERROR ||
             !daemon ) {
          ERRORMACRO( result != NULL, Error, , "Error connecting to socket '"
                      << socketName << "' as user '" << userName << "' "
                      << ( passWord.empty() ? "without" : "with" )
                      << " password: " << mysql_error( m ) );
        } else
          sleep( 1 );
      };
    } while ( result == NULL );

    // Set character-set of connection to UTF-8.
    // If the server is older than MySQL 4.1, the resulting error-message is
    // being ignored.
    mysql_query( m, "SET NAMES utf8;" );

  } catch ( Error &e ) {

    mysql_close( m );
    throw e;

  };
};

MySQLDaemonPtr MySQLSocket::getDaemon

(

void

)

const [inline]

Definition at line 49 of file mysqlSocket.hpp.

References daemon.

{ return daemon; }

const std::string& MySQLSocket::getSocketName

(

void

)

const [inline]

Definition at line 44 of file mysqlSocket.hpp.

References socketName.

{ return socketName; }

---

Field Documentation

MySQLDaemonPtr MySQLSocket::daemon [protected]

Definition at line 54 of file mysqlSocket.hpp.

Referenced by getDaemon().

std::string MySQLSocket::socketName [protected]

Definition at line 52 of file mysqlSocket.hpp.

Referenced by getSocketName().

---

The documentation for this class was generated from the following files:

• mysqlSocket.hpp
• mysqlSocket.cpp