QSparqlConnectionOptions Class Reference

The QSparqlConnectionOptions class encapsulates options given to QSparqlConnection. Some options are used only by some drivers. More...

Inherited by SparqlConnectionOptions.

Public Member Functions
	QSparqlConnectionOptions (const QSparqlConnectionOptions &other)
bool	operator== (const QSparqlConnectionOptions &other) const
QSparqlConnectionOptions &	operator= (const QSparqlConnectionOptions &other)
void	setOption (const QString &name, const QVariant &value)
QVariant	option (const QString &name) const
void	setDatabaseName (const QString &name)
void	setUserName (const QString &name)
void	setPassword (const QString &password)
void	setHostName (const QString &host)
void	setPath (const QString &path)
void	setPort (int p)
void	setDataReadyInterval (int p)
void	setMaxThreadCount (int p)
void	setThreadExpiryTime (int p)
void	setProxy (const QNetworkProxy &proxy)
void	setNetworkAccessManager (QNetworkAccessManager *manager)
QString	databaseName () const
QString	userName () const
QString	password () const
QString	hostName () const
QString	path () const
int	port () const
int	dataReadyInterval () const
int	maxThreadCount () const
int	threadExpiryTime () const
QNetworkProxy	proxy () const
QNetworkAccessManager *	networkAccessManager () const

Detailed Description

The QSparqlConnectionOptions class encapsulates options given to QSparqlConnection. Some options are used only by some drivers.

The function setOption() can be used for setting an option and option() for getting a value of an option. An option can be unset by passing a QVariant() to setOption().

For frequently used options, there are separate convenience functions, e.g., setHost() and host().

See also

QSparqlConnection

Constructor & Destructor Documentation

QSparqlConnectionOptions()

QSparqlConnectionOptions::QSparqlConnectionOptions

(

const QSparqlConnectionOptions &

other

)

Creates a QSparqlConnectionOptions object based on other, copying all key-value pairs from it.

Member Function Documentation

databaseName()

QString QSparqlConnectionOptions::databaseName

(

)

const

Convenience function for getting the database name.

See also

option()

dataReadyInterval()

int QSparqlConnectionOptions::dataReadyInterval

(

)

const

Convenience function for getting the interval between when dataReady(int) signals are emitted. The default value is 1, which means that a dataReady() signal is emitted as soon as a driver has some results.

See also

option()

hostName()

QString QSparqlConnectionOptions::hostName

(

)

const

Convenience function for getting the host name.

See also

option()

maxThreadCount()

int QSparqlConnectionOptions::maxThreadCount

(

)

const

Convenience function for getting the max thread count to be used by the thread pool.

See also

option()

networkAccessManager()

QNetworkAccessManager * QSparqlConnectionOptions::networkAccessManager

(

)

const

Convenience function for getting the QNetworkAccessManager. Used by connections which use the network.

This option cannot be set using the option() function.

operator=()

QSparqlConnectionOptions & QSparqlConnectionOptions::operator=

(

const QSparqlConnectionOptions &

other

)

Assigns the QSparqlConnectionOptions object. Copies all key-value pairs from other.

operator==()

bool QSparqlConnectionOptions::operator==

(

const QSparqlConnectionOptions &

other

)

const

Returns true if the QSparqlConnection objects are equal. The objects are equal if they describe the same set of key-value pairs.

option()

QVariant QSparqlConnectionOptions::option

(

const QString &

name

)

const

Returns the value of a given option, name, or QVariant(), if there is no value.

See also

setOption()

password()

QString QSparqlConnectionOptions::password

(

)

const

Convenience function for getting the password. Used by connections requiring authentication.

See also

option()

path()

QString QSparqlConnectionOptions::path

(

)

const

Convenience function for getting the path.

See also

option()

port()

int QSparqlConnectionOptions::port

(

)

const

Convenience function for getting the port.

See also

option()

proxy()

QNetworkProxy QSparqlConnectionOptions::proxy

(

)

const

Convenience function for setting the QNetworkProxy. Used by connections which use the network.

This option cannot be set using the setOption() function.

setDatabaseName()

void QSparqlConnectionOptions::setDatabaseName

(

const QString &

name

)

Convenience function for setting the database name.

See also

setOption()

setDataReadyInterval()

void QSparqlConnectionOptions::setDataReadyInterval

(

int

interval

)

Convenience function for setting the interval between when dataReady(int) signals are emitted.

See also

setOption()

setHostName()

void QSparqlConnectionOptions::setHostName

(

const QString &

host

)

Convenience function for setting the host name of the RDF store.

See also

setOption()

setMaxThreadCount()

void QSparqlConnectionOptions::setMaxThreadCount

(

int

p

)

Convenience function for setting the maximum number of threads for the thread pool to use.

See also

setOption()

setNetworkAccessManager()

void QSparqlConnectionOptions::setNetworkAccessManager

(

QNetworkAccessManager *

nam

)

Convenience function for setting the QNetworkAccessManager. Valid for drivers connecting to databases over the network.

This option cannot be set using the setOption() function.

setOption()

void QSparqlConnectionOptions::setOption	(	const QString &	name,
		const QVariant &	value
	)

Sets the option name to a given value. Use a null QVariant, i.e. QVariant(), to unset an option.

setPassword()

void QSparqlConnectionOptions::setPassword

(

const QString &

password

)

Convenience function for setting the password. Used by connections requiring authentication.

See also

setOption()

setPath()

void QSparqlConnectionOptions::setPath

(

const QString &

path

)

Convenience function for setting the path of the RDF store.

See also

setOption()

setPort()

void QSparqlConnectionOptions::setPort

(

int

p

)

Convenience function for setting the port of the RDF store.

See also

setOption()

setProxy()

void QSparqlConnectionOptions::setProxy

(

const QNetworkProxy &

proxy

)

Convenience function for setting the QNetworkProxy. Valid for drivers connecting to databases over the network.

This option cannot be set using the setOption() function.

setThreadExpiryTime()

void QSparqlConnectionOptions::setThreadExpiryTime

(

int

p

)

Convenience function for setting the expiry time (in milliseconds) of threads created by the threadpool.

See also

setOption()

setUserName()

void QSparqlConnectionOptions::setUserName

(

const QString &

name

)

Convenience function for setting the user name. Used by connections requiring authentication.

See also

setOption()

threadExpiryTime()

int QSparqlConnectionOptions::threadExpiryTime

(

)

const

Convenience function for getting the thread expiry time.

See also

option()

userName()

QString QSparqlConnectionOptions::userName

(

)

const

Convenience function for getting the user name. Used by connections requiring authentication.

See also

option()

---

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

• /home/abuild/rpmbuild/BUILD/libqt5sparql-0.2.22.1/src/sparql/kernel/qsparqlconnectionoptions.h
• /home/abuild/rpmbuild/BUILD/libqt5sparql-0.2.22.1/src/sparql/kernel/qsparqlconnectionoptions.cpp