# options.h File Reference

Declares the Option class hierarchy, used to implement connection options in Connection and DBDriver classes. More...

`#include "common.h"`
`#include <deque>`
`#include <string>`

Go to the source code of this file.

## Namespaces

namespace | mysqlpp

## Classes

class | mysqlpp::Option
| Define abstract interface for all *Option subclasses. More...
class | mysqlpp::DataOption< T >
| Define abstract interface for all *Options that take a lone scalar as an argument. More...
class | mysqlpp::CompressOption
| Enable data compression on the connection. More...
class | mysqlpp::ConnectTimeoutOption
| Change Connection::connect() default timeout. More...
class | mysqlpp::FoundRowsOption
| Make Query::affected_rows() return number of matched rows. More...
class | mysqlpp::GuessConnectionOption
| Allow C API to guess what kind of connection to use. More...
class | mysqlpp::IgnoreSpaceOption
| Allow spaces after function names in queries. More...
class | mysqlpp::InitCommandOption
| Give SQL executed on connect. More...
class | mysqlpp::InteractiveOption
| Assert that this is an interactive program. More...
class | mysqlpp::LocalFilesOption
| Enable LOAD DATA LOCAL statement. More...
class | mysqlpp::LocalInfileOption
| Enable LOAD LOCAL INFILE statement. More...
class | mysqlpp::MultiResultsOption
| Enable multiple result sets in a reply. More...
class | mysqlpp::MultiStatementsOption
| Enable multiple queries in a request to the server. More...
class | mysqlpp::NamedPipeOption
| Suggest use of named pipes. More...
class | mysqlpp::NoSchemaOption
| Disable db.tbl.col syntax in queries. More...
class | mysqlpp::ReadDefaultFileOption
| Override use of my.cnf. More...
class | mysqlpp::ReadDefaultGroupOption
| Override use of my.cnf. More...
class | mysqlpp::ReadTimeoutOption
| Set timeout for IPC data reads. More...
class | mysqlpp::ReconnectOption
| Enable automatic reconnection to server. More...
class | mysqlpp::ReportDataTruncationOption
| Set reporting of data truncation errors. More...
class | mysqlpp::SecureAuthOption
| Enforce use of secure authentication, refusing connection if not available. More...
class | mysqlpp::SetCharsetDirOption
| Give path to charset definition files. More...
class | mysqlpp::SetCharsetNameOption
| Give name of default charset. More...
class | mysqlpp::SetClientIpOption
| Fake client IP address when connecting to embedded server. More...
class | mysqlpp::SharedMemoryBaseNameOption
| Set name of shmem segment for IPC. More...
class | mysqlpp::SslOption
| Specialized option for handling SSL parameters. More...
class | mysqlpp::UseEmbeddedConnectionOption
| Connect to embedded server in preference to remote server. More...
class | mysqlpp::UseRemoteConnectionOption
| Connect to remote server in preference to embedded server. More...
class | mysqlpp::WriteTimeoutOption
| Set timeout for IPC data reads. More...

## Typedefs

typedef DataOption< unsigned > | IntegerOption
| Option w/ int argument.
typedef DataOption< bool > | BooleanOption
| Option w/ bool argument.
typedef DataOption< std::string > | StringOption
| Option w/ string argument.
typedef std::deque< Option * > | OptionList
| The data type of the list of connection options.
typedef OptionList::const_iterator | OptionListIt
| Primary iterator type into List.

## Detailed Description

Declares the Option class hierarchy, used to implement connection options in Connection and DBDriver classes.

This is tied closely enough to DBDriver that there's a pure-OO argument that it should be declared as protected or private members within DBDriver. We do it outside DBDriver because there's so much of it. It'd overwhelm everything else that's going on in that class totally out of proprortion to the importance of options.