# class ServerCore

###

Module | soprano
Namespace | Soprano::Server
Class | ServerCore
Inherits | QObject,Soprano::Error::ErrorCache

\class ServerCore servercore.h Soprano/Server/ServerCore

Central %Soprano server class.

The %ServerCore provides a %Soprano server which maintains a set of named Model instances that can be accessed by clients over a tcp connection through Server.BackendPlugin.

Creating a server is very simple: Either derive from ServerCore or create an instance and then call start() to make the server listen for incoming connections.

    Soprano.Server.ServerCore core;
    core.start();

Optionally ServerCore can be configured using normal BackendSetting settings through setBackendSettings().

Be aware the ServerCode supports multiple ways of communication. start() opens a TCP socket to accept new connections, registerAsDBusObject() registers a DBus interface on the DBus session bus. Both ways of communication can be used simultaneously.

ServerCore is designed for single-threaded usage. Thus, model() uses Util.AsyncModel to protect against deadlocks. This behaviour can of course be changed by reimplementing model().

Author Sebastian Trueg <trueg@kde.org>

### methods

- ServerCore (parent)

  returns ctor

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

- allModels ( )

  returns QStringList

  Retrieve all models that have been loaded.

  Returns A list of Model names.

- backend ( )

  returns Soprano.Backend

  The Backend used by the Server to create Model instances.

- backendSettings ( )

  returns QList<Soprano::BackendSetting>

  Retrieve the backend settings configured via setBackendSettings().

  Returns A list of BackendSetting objects.

- createModel (settings)

  returns Soprano.Model

  Argument | Type | Default
  --- | --- | ---
  settings | QList<Soprano::BackendSetting> |

  Create a new Model. The default implementation uses the configured Backend with the configured settings to create a new Model. This method can be reimplemented to create specialized Model, for example in combination with some FilterModel.

  settings - The settings to use (a reimplementation may choose to ignore the settings.)

  Returns A newly create Model.

- listen (port)

  returns bool

  Argument | Type | Default
  --- | --- | ---
  port | quint16 | DEFAULT_PORT

  Start the Server. Calling this method will make the Server listen on the specified port for incoming client connections.

  port - The port to listen on for client connections.

  Use Client.TcpClient to connect.

  Via the TCP connection signals are not supported. 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.

  Returns true if the server was successfully started, false otherwise.

- model (name)

  returns Soprano.Model

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

  Get or create Model with the specific name. The default implementation will use createModel() to create a new Model if none with the specified name exists and protect it against deadlocks with a Util.AsyncModel.

  name - The name of the requested Model.

- registerAsDBusObject (objectPath)

  returns Nothing

  Argument | Type | Default
  --- | --- | ---
  objectPath | QString | QString()

  Register the ServerCore as a DBus object. The process needs to be registered as a DBus service before (QDBusConnection.registerService()).

  objectPath - The DBus object path to register the server as. If empty the default path will be used (/org/soprano/Server).

  Use Client.DBusClient to connect.

- removeModel (name)

  returns Nothing

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

  Remove a model and delete all data in it. Use with care.

  Be aware that the Model instance will also be deleted.

  Should be reimplemented if model() is reimplemented.

  name - The name of the requested Model.

  This is not the same as deleting the Model instance. It will also delete all the data on the harddisk.

- serverPort ( )

  returns quint16

  Returns The port this server is listening on or 0 if listen has not been called successfully.

  \since 2.1

- setBackend (backend)

  returns Nothing

  Argument | Type | Default
  --- | --- | ---
  backend | Soprano.Backend |

- setBackendSettings (settings)

  returns Nothing

  Argument | Type | Default
  --- | --- | ---
  settings | QList<Soprano::BackendSetting> |

  Set the settings that are to be used by createModel() to create new Model instances. Be aware that Soprano.BackendOptionStorageDir will be changed to include a subdir which is the Model's name.

  settings - The settings to use for new Models.

- start (socketPath)

  returns bool

  Argument | Type | Default
  --- | --- | ---
  socketPath | QString | QString()

  Start the core on a local socket. On Windows this is a named pipe and on Unix this this is a local domain socket.

  Use Client.LocalSocketClient to connect.

  Via the local socket connection signals are not supported.

  Returns true if the local socket could be successfully opened. false on error. See ErrorCache.lastError() for details.

### variables

quint16 DEFAULT_PORT | Set the Backend used in the Server to create Models.