QRemoteServiceRegister Class

 <SFW version="1.1">
 <service>
     <name>MyService</name>
     <ipcaddress>my_executable</ipcaddress>
     <description>My service example</description>
     <interface>
         <name>com.nokia.qt.example.myService</name>
         <version>1.0</version>
         <description>My private service</description>
         <capabilities></capabilities>
     </interface>
 </service>
 </SFW>

 int main(int argc, char** argv)
 {
     QCoreApplication app(argc, argv);

     QRemoteServiceRegister *serviceRegister = new QRemoteServiceRegister();

     QRemoteServiceRegister::Entry myService;
     myService = serviceRegister->createEntry<MyClass>(
         "MyService", "com.nokia.qt.example.myservice", "1.0");

     serviceRegister->publishEntries("my_service");

     return app.exec();
     delete serviceRegister;
 }

Member Function Documentation

QRemoteServiceRegister::QRemoteServiceRegister(QObject * parent = 0)

Creates a service register instance with the given parent.

QRemoteServiceRegister::~QRemoteServiceRegister()

Destroys the service register instance

void QRemoteServiceRegister::allInstancesClosed() [signal]

This signal is emitted whenever all service instances have been closed. This indicates that the last connected client has either shutdown or released the loaded service object.

See also instanceClosed().

Entry QRemoteServiceRegister::createEntry(const QString & serviceName, const QString & interfaceName, const QString & version)

Creates an entry on our remote instance manager. The serviceName, interfaceName and version must match the service XML descriptor in order for the remote service to be discoverable.

See also publishEntries().

qintptr QRemoteServiceRegister::getBaseGroupIdentifier() const

Get the group id set on the socket or pipe.

This function was introduced in Qt 5.0.

qintptr QRemoteServiceRegister::getBaseUserIdentifier() const

Get the user id set on the socket or pipe.

This function was introduced in Qt 5.0.

void QRemoteServiceRegister::instanceClosed(const QRemoteServiceRegister::Entry & entry) [signal]

This signal is emitted whenever a created instance has been closed. This indicates that a connected client has either shutdown or released the loaded service object.

entry is supplied to identify which registered service entry the closed instance belonged to.

See also allInstancesClosed().

void QRemoteServiceRegister::publishEntries(const QString & ident)

Publishes every service QRemoteServiceRegister::Entry that has been created using createEntry(). The ident is the service specific IPC address under which the service can be reached.

This address must match the address provided in the services XML descriptor, otherwise the service will not be discoverable. In some cases this may also cause the IPC rendezvous feature to fail.

See also createEntry().

SecurityAccessOptions QRemoteServiceRegister::securityAccessOptions() const

See also setSecurityAccessOptions().

void QRemoteServiceRegister::setBaseGroupIdentifier(qintptr gid)

Set the group id for the socket or pipe. For backends that use sockets or pipes and provide filesystem based access control.

This function was introduced in Qt 5.0.

void QRemoteServiceRegister::setBaseUserIdentifier(qintptr uid)

Set the user id for the socket or pipe. For backends that use sockets or pipes and provide filesystem based access control.

This function was introduced in Qt 5.0.

void QRemoteServiceRegister::setSecurityAccessOptions(SecurityAccessOptions options)

Set the socket access control. This sets the file system permissions on that socket.

This function was introduced in Qt 5.0.

See also securityAccessOptions().

SecurityFilter QRemoteServiceRegister::setSecurityFilter(SecurityFilter filter)

Allows a security filter to be set which can access QRemoteServiceRegister::QRemoteServiceRegisterCredentials.

The filter is a function pointer where the function code implements possible permission checks and returns true or false. If a connecting client fails the security filter it will be denied access and unable to obtain a valid service instance.

The following snippet is an example of how to use the security filter feature.

 bool myFunction(const void *p)
 {
     const QRemoteServiceRegisterCredentials *cred =
         (const struct QRemoteServiceRegisterCredentials *)p;

     // allow the superuser
     if (cred->uid == 0)
         return true;

     return false;
 }

 int main(int argc, char** argv)
 {
     ...

     QRemoteServiceRegister* serviceRegister = new QRemoteServiceRegister();
     service->setSecurityFilter(myFunction);

     ...
 }