# class TcpClient

###

Module | soprano
Namespace | Soprano::Client
Class | TcpClient
Inherits | QObject,Soprano::Error::ErrorCache

\class TcpClient tcpclient.h Soprano/Client/TcpClient

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

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>

### methods

- TcpClient (parent)

  returns ctor

  Argument | Type | Default
  --- | --- | ---
  parent | QObject | 0

  Create a new Client instance.

- connect (address, port)

  returns bool

  Argument | Type | Default
  --- | --- | ---
  address | QHostAddress | QHostAddress.LocalHost
  port | int | DEFAULT_PORT

- createModel (name, settings)

  returns Soprano.Model

  Argument | Type | Default
  --- | --- | ---
  name | QString |
  settings | QList<Soprano::BackendSetting> | QList<Soprano.BackendSetting>()

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

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

- disconnect ( )

  returns Nothing

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

- isConnected ( )

  returns bool

  Check if the client is connected to a server.

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

- removeModel (name)

  returns Nothing

  Argument | Type | Default
  --- | --- | ---
  name | QString |

  Deletes a model including all its data.

  name - The name of the model to remove.

  Calling this method will remove all data physically. It can not be reverted. Use with care.

  \since 2.1

### variables

quint16 DEFAULT_PORT | Tries to connect to the %Soprano server. Returns true on success, false if an error occured. Check lastError() for details.