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:

[legend]

List of all members.

Public Member Functions
	TcpClient (QObject *parent=0)
virtual	~TcpClient ()
bool	connect (const QHostAddress &address=QHostAddress::LocalHost, int port=DEFAULT_PORT)
bool	isConnected ()
void	disconnect ()
Model *	createModel (const QString &name, const QList< BackendSetting > &settings=QList< BackendSetting >())
void	removeModel (const QString &name)
Static Public Attributes
static const quint16	DEFAULT_PORT

---

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@kde.org>

Definition at line 57 of file tcpclient.h.

---

Constructor & Destructor Documentation

Soprano::Client::TcpClient::TcpClient

(

QObject *

parent = 0

)

Create a new Client instance.

virtual Soprano::Client::TcpClient::~TcpClient

(

)

[virtual]

Destructor.

---

Member Function Documentation

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.

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.

void Soprano::Client::TcpClient::disconnect

(

)

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

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

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

Parameters:

	name	The name of the model to access.
	settings	The 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.)

void Soprano::Client::TcpClient::removeModel

(

const QString &

name

)

Deletes a model including all its data.

Parameters:

name

The 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

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:

• /builddir/build/BUILD/soprano-2.3.1/server/tcpclient.h