              
QRemoteServiceRegister Class ReferenceThe QRemoteServiceRegister class manages instances of remote service objects. More... #include <QRemoteServiceRegister> Inherits QObject. Public Types
Properties
Public Functions
Signals
Additional Inherited Members
Detailed DescriptionThe QRemoteServiceRegister class manages instances of remote service objects. This class registers and publishes IPC based service objects. It owns the service's objects and uess the platform specific IPC mechanism to publish the service. In order for the remote services to be discoverable by QServiceManager each QRemoteServiceRegister::Entry must be registered with the same information in the XML description, otherwise no corresponding QServiceInterfaceDescriptor can be found. The following XML descriptor is used for subsequent examples. <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>
The snippet belows demonstrates how an application can register the class MyClass as a remote service, which is published and accessible to clients who wish to load service object instances. 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;
}
By default all entries are created as QRemoteServiceRegister::GlobalInstance types. This can be changed by calling QRemoteServiceRegister::Entry::setInstantiationType() on the entry. Once the service register has been published the associated service entries can no longer be changed. See also QRemoteServiceRegister::Entry. Member Type Documentation
|
| Constant | Value | Description |
|---|---|---|
| QRemoteServiceRegister::GlobalInstance | 0 | New requests for a service gets the same service instance |
| QRemoteServiceRegister::PrivateInstance | 1 | New requests for a service gets a new service instance |
Property Documentation
quitOnLastInstanceClosed : bool
This property holds terminate the service when all clients have closed all objects. Default value is true.
Access functions:
| bool | quitOnLastInstanceClosed () const |
| void | setQuitOnLastInstanceClosed ( const bool quit ) |
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().
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().
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);
...
}