Soprano::Client::TcpClient Class Reference

Creates a connection to the Soprano server. 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 ()
ModelcreateModel (const QString &name, const QList< BackendSetting > &settings=QList< BackendSetting >())

Static Public Attributes

static const quint16 DEFAULT_PORT


Detailed Description

Creates a connection to the Soprano server.

The Soprano server can be accessed normally through PluginManager::discoverBackendByName() with name "sopranoserver" or by simply creating an instance of TcpClient. The latter solution can have advantages as it uses a new connection to the server.

Author:
Sebastian Trueg <trueg@kde.org>

Definition at line 51 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 = QListBackendSetting >() 
)

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.)


Member Data Documentation

The default Soprano server connection port.

Definition at line 69 of file tcpclient.h.


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

Generated on Wed Mar 5 20:45:27 2008 for Soprano by  doxygen 1.5.5