TCP/IP client protocol class for database proxy. More...

#include <bpsdbproxylink.h>

Inheritance diagram for BpsDbProxyLink:

Public Member Functions
	BpsDbProxyLink (QObject *aParent=0)

void	close ()
	Close the proxy communication socket.

bool	open (const QString &aHost, int aPort, QString *aErrorMessage=0)
	Open the proxy communication socket. More...

StatusType	transact (CommandType aCommand, const QVariantList &aSendData, QVariantList &aRecData, int aMinData=0, int aMaxData=0)
	Send a command and wait for the reply. More...

Public Member Functions inherited from QObject
bool	blockSignals (bool block)

const QObjectList &	children () const const

QMetaObject::Connection	connect (const QObject sender, const char signal, const char *method, Qt::ConnectionType type) const const

void	deleteLater ()

void	destroyed (QObject *obj)

bool	disconnect (const char signal, const QObject receiver, const char *method) const const

bool	disconnect (const QObject receiver, const char method) const const

void	dumpObjectInfo ()

void	dumpObjectInfo () const const

void	dumpObjectTree ()

void	dumpObjectTree () const const

QList< QByteArray >	dynamicPropertyNames () const const

virtual bool	event (QEvent *e)

virtual bool	eventFilter (QObject watched, QEvent event)

T	findChild (const QString &name, Qt::FindChildOptions options) const const

QList< T >	findChildren (const QRegExp &regExp, Qt::FindChildOptions options) const const

QList< T >	findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const

QList< T >	findChildren (const QString &name, Qt::FindChildOptions options) const const

bool	inherits (const char *className) const const

void	installEventFilter (QObject *filterObj)

bool	isWidgetType () const const

bool	isWindowType () const const

void	killTimer (int id)

virtual const QMetaObject *	metaObject () const const

void	moveToThread (QThread *targetThread)

QString	objectName () const const

void	objectNameChanged (const QString &objectName)

QObject *	parent () const const

QVariant	property (const char *name) const const

	Q_CLASSINFO (Name, Value)

	Q_DISABLE_COPY (Class)

	Q_DISABLE_COPY_MOVE (Class)

	Q_DISABLE_MOVE (Class)

	Q_EMIT Q_EMIT

	Q_ENUM (...)

	Q_ENUM_NS (...)

	Q_ENUMS (...)

	Q_FLAG (...)

	Q_FLAG_NS (...)

	Q_FLAGS (...)

	Q_GADGET Q_GADGET

	Q_INTERFACES (...)

	Q_INVOKABLE Q_INVOKABLE

	Q_NAMESPACE Q_NAMESPACE

	Q_NAMESPACE_EXPORT (EXPORT_MACRO)

	Q_OBJECT Q_OBJECT

	Q_PROPERTY (...)

	Q_REVISION Q_REVISION

	Q_SET_OBJECT_NAME (Object)

	Q_SIGNAL Q_SIGNAL

	Q_SIGNALS Q_SIGNALS

	Q_SLOT Q_SLOT

	Q_SLOTS Q_SLOTS

T	qFindChild (const QObject *obj, const QString &name)

QList< T >	qFindChildren (const QObject *obj, const QRegExp &regExp)

QList< T >	qFindChildren (const QObject *obj, const QString &name)

	QObject (QObject *parent)

T	qobject_cast (const QObject *object)

T	qobject_cast (QObject *object)

	QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT

void	removeEventFilter (QObject *obj)

void	setObjectName (const QString &name)

void	setParent (QObject *parent)

bool	setProperty (const char *name, const QVariant &value)

bool	signalsBlocked () const const

int	startTimer (int interval, Qt::TimerType timerType)

int	startTimer (std::chrono::milliseconds time, Qt::TimerType timerType)

QThread *	thread () const const

Static Public Member Functions
static QString	commandText (CommandType aCommand)
	Get text representation of a command. More...

static QVariantMap	connection (const QString &aHost, int aPort, const QString &aConnection)
	Get parameters of a remote connection on the proxy server. More...

static QStringList	connections (const QString &aHost, int aPort)
	Get remote connections available on the proxy server. More...

static QVariantList	deserialize (QDataStream &aStream)
	Deserialize a list of values from a data stream. More...

static void	serialize (const QVariantList &aData, QDataStream &aStream)
	Serialize a list of values to a data stream. More...

static QString	statusText (StatusType aStatus)
	Get text representation of a status. More...

Static Public Member Functions inherited from QObject
QMetaObject::Connection	connect (const QObject sender, const char signal, const QObject receiver, const char method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject sender, PointerToMemberFunction signal, const QObject context, Functor functor, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject sender, PointerToMemberFunction signal, const QObject receiver, PointerToMemberFunction method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)

bool	disconnect (const QMetaObject::Connection &connection)

bool	disconnect (const QObject sender, const char signal, const QObject receiver, const char method)

bool	disconnect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method)

bool	disconnect (const QObject sender, PointerToMemberFunction signal, const QObject receiver, PointerToMemberFunction method)

QString	tr (const char sourceText, const char disambiguation, int n)

QString	trUtf8 (const char sourceText, const char disambiguation, int n)

Additional Inherited Members
Public Attributes inherited from QObject
typedef	QObjectList

Protected Member Functions inherited from QObject
virtual void	childEvent (QChildEvent *event)

virtual void	connectNotify (const QMetaMethod &signal)

virtual void	customEvent (QEvent *event)

virtual void	disconnectNotify (const QMetaMethod &signal)

bool	isSignalConnected (const QMetaMethod &signal) const const

int	receivers (const char *signal) const const

QObject *	sender () const const

int	senderSignalIndex () const const

virtual void	timerEvent (QTimerEvent *event)

Properties inherited from QObject
	objectName

Detailed Description

TCP/IP client protocol class for database proxy.

Constructor & Destructor Documentation

◆ BpsDbProxyLink()

BpsDbProxyLink::BpsDbProxyLink ( QObject * aParent = 0 )

Parameters

aParent Pointer to an optional parent object.

Member Function Documentation

◆ commandText()

static QString BpsDbProxyLink::commandText ( CommandType aCommand )

static

Get text representation of a command.

Parameters

aCommand The db proxy command.

Returns: The text.

◆ connection()

static QVariantMap BpsDbProxyLink::connection	(	const QString &	aHost,
		int	aPort,
		const QString &	aConnection
	)

static

Get parameters of a remote connection on the proxy server.

On success a map with the remote connection parameters is returned:

Key	Value
Driver	Name of the database driver (for example BPSORA or BPSPG).
Host	Database host name or address.
Port	Database port number.
Database	Database name for PostgreSQL, TNS name or SID for Oracle.
Schema	BPS schema name.

Parameters

aHost	Proxy host name or IP.
aPort	Proxy port number.
aConnection	Name of the connection.

Exceptions

BpsException on errors.

Returns: The connection parameters.

◆ connections()

static QStringList BpsDbProxyLink::connections	(	const QString &	aHost,
		int	aPort
	)

static

Get remote connections available on the proxy server.

Parameters

aHost	Proxy host name or IP.
aPort	Proxy port number.

Exceptions

Throws BpsException on errors.

Returns: Names of the available remote database connections.

◆ deserialize()

static QVariantList BpsDbProxyLink::deserialize ( QDataStream & aStream )

static

Deserialize a list of values from a data stream.

Parameters

aStream The stream to process, open for reading.

Returns: The deserialized data.

◆ open()

bool BpsDbProxyLink::open	(	const QString &	aHost,
		int	aPort,
		QString *	aErrorMessage = `0`
	)

Open the proxy communication socket.

Parameters

aHost	Proxy host name or IP.
aPort	Proxy port number.
aErrorMessage	Optional address where open error message is stored.

Returns: True on success, false on error.

◆ serialize()

static void BpsDbProxyLink::serialize	(	const QVariantList &	aData,
		QDataStream &	aStream
	)

static

Serialize a list of values to a data stream.

Parameters

aData	The data to serialize.
aStream	The stream to append to, open for writing.

◆ statusText()

static QString BpsDbProxyLink::statusText ( StatusType aStatus )

static

Get text representation of a status.

Parameters

aStatus The db proxy status.

Returns: The text.

◆ transact()

StatusType BpsDbProxyLink::transact	(	CommandType	aCommand,
		const QVariantList &	aSendData,
		QVariantList &	aRecData,
		int	aMinData = `0`,
		int	aMaxData = `0`
	)

Send a command and wait for the reply.

Parameters

aCommand	The command to send.
aSendData	Data/parameters to send along with the command.
aRecData	Data or error information received as reply.
aMinData	Minimum data expected on a successful transaction.
aMaxData	Maximum data expected on a successful transaction (-1 = unlimited).

Returns: The status of the transaction.

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

bpsdbproxylink.h

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ BpsDbProxyLink()

Member Function Documentation

◆ commandText()

◆ connection()

◆ connections()

◆ deserialize()

◆ open()

◆ serialize()

◆ statusText()

◆ transact()