Soprano 2.9.4
Public Member Functions | Static Public Attributes | List of all members
Soprano::Client::TcpClient Class Reference

Creates a connection to the Soprano server through a TCP connection. More...

#include <Soprano/Client/TcpClient>

+ Inheritance diagram for Soprano::Client::TcpClient:

Public Member Functions

 TcpClient (QObject *parent=0)
 
virtual ~TcpClient ()
 
bool connect (const QHostAddress &address=QHostAddress::LocalHost, int port=DEFAULT_PORT)
 
bool isConnected ()
 
void disconnect ()
 
ModelcreateModel (const QString &name, const QList< BackendSetting > &settings=QList< BackendSetting >())
 
void removeModel (const QString &name)
 
- Public Member Functions inherited from QObject
 QObject (QObject *parent=0)
 
 blockSignals (bool block)
 
 childEvent (QChildEvent *event)
 
 children ()
 
 connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type=Qt::AutoCompatConnection)
 
 connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type=Qt::AutoCompatConnection)
 
 connectNotify (const char *signal)
 
 customEvent (QEvent *event)
 
 deleteLater ()
 
 destroyed (QObject *obj=0)
 
 disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
 
 disconnect (const char *signal=0, const QObject *receiver=0, const char *method=0)
 
 disconnect (const QObject *receiver, const char *method=0)
 
 disconnectNotify (const char *signal)
 
 dumpObjectInfo ()
 
 dumpObjectTree ()
 
 dynamicPropertyNames ()
 
 event (QEvent *e)
 
 eventFilter (QObject *watched, QEvent *event)
 
 findChild (const QString &name=QString()
 
 findChildren (const QString &name=QString()
 
 findChildren (const QRegExp &regExp)
 
 inherits (const char *className)
 
 installEventFilter (QObject *filterObj)
 
 isWidgetType ()
 
 killTimer (int id)
 
 metaObject ()
 
 moveToThread (QThread *targetThread)
 
 parent ()
 
 property (const char *name)
 
 receivers (const char *signal)
 
 removeEventFilter (QObject *obj)
 
 sender ()
 
 setParent (QObject *parent)
 
 setProperty (const char *name, const QVariant &value)
 
 signalsBlocked ()
 
 startTimer (int interval)
 
 thread ()
 
 timerEvent (QTimerEvent *event)
 
 tr (const char *sourceText, const char *comment=0, int n=-1)
 
 trUtf8 (const char *sourceText, const char *comment=0, int n=-1)
 
 staticMetaObject
 
 QObject (QObject *parent, const char *name)
 
 checkConnectArgs (const char *signal, const QObject *object, const char *method)
 
 child (const char *objName, const char *inheritsClass=0, bool recursiveSearch=true)
 
 className ()
 
 insertChild (QObject *object)
 
 isA (const char *className)
 
 name ()
 
 name (const char *defaultName)
 
 normalizeSignalSlot (const char *signalSlot)
 
 removeChild (QObject *object)
 
 setName (const char *name)
 
- Public Member Functions inherited from Soprano::Error::ErrorCache
virtual ~ErrorCache ()
 
virtual Error lastError () const
 

Static Public Attributes

static const quint16 DEFAULT_PORT
 

Additional Inherited Members

- Protected Member Functions inherited from Soprano::Error::ErrorCache
 ErrorCache ()
 
void clearError () const
 
void setError (const Error &) const
 
void setError (const QString &errorMessage, int code=ErrorUnknown) const
 

Detailed Description

Creates a connection to the Soprano server through a TCP connection.

The Soprano server supports more than one way of communication. Beside D-Bus (see DBusClient) and local socket communication (LocalSocketClient) it can be contacted via TCP. For that to work the server has to be listening on some port (Server::ServerCore::listen).

Warning
The TcpClient does not support signals. Thus, the models created by it will not emit signals such as Model::statementAdded. Also no permission handling or any kind of security is implemented at the moment. Thus, if a server is running and is listening on a port, it is open to connections from any client on any computer in the network.
Author
Sebastian Trueg trueg.nosp@m.@kde.nosp@m..org

Definition at line 57 of file tcpclient.h.

Constructor & Destructor Documentation

◆ TcpClient()

Soprano::Client::TcpClient::TcpClient ( QObject parent = 0)

Create a new Client instance.

◆ ~TcpClient()

virtual Soprano::Client::TcpClient::~TcpClient ( )
virtual

Destructor.

Member Function Documentation

◆ connect()

bool Soprano::Client::TcpClient::connect ( const QHostAddress address = QHostAddress::LocalHost,
int  port = DEFAULT_PORT 
)

Tries to connect to the Soprano server.

Returns
true on success, false if an error occured. Check lastError() for details.

◆ isConnected()

bool Soprano::Client::TcpClient::isConnected ( )

Check if the client is connected to a server.

Returns
true if this client is connected to a server, false otherwise.

◆ disconnect()

void Soprano::Client::TcpClient::disconnect ( )

Disconnect from the server. The created model instances are not deleted but remain useless; open iterators are closed.

◆ createModel()

Model * Soprano::Client::TcpClient::createModel ( const QString name,
const QList< BackendSetting > &  settings = QListBackendSetting >() 
)

Creates a new Model instance that wraps a server model. Client models are very light wrappers and creating them is very fast.

Parameters
nameThe name of the model to access.
settingsThe settings to send to the server for creating a new model. These settings may be ignored by the server if a model with that name has already been created.
Returns
A new Model instance wrapping the requested server model or 0 on error (check lastError() for details.)

◆ removeModel()

void Soprano::Client::TcpClient::removeModel ( const QString name)

Deletes a model including all its data.

Parameters
nameThe name of the model to remove.
Warning
Calling this method will remove all data physically. It can not be reverted. Use with care.
Since
2.1

Member Data Documentation

◆ DEFAULT_PORT

const quint16 Soprano::Client::TcpClient::DEFAULT_PORT
static

The default Soprano server connection port.

Definition at line 75 of file tcpclient.h.


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