Hyperspace REST

Classes

class  Hyperspace::REST::Collection
 The base class for Collections. More...
 
class  Hyperspace::REST::FixedCachedCollection
 Convenience RESTful-compliant Collection based on a cached set of resources. More...
 
class  Hyperspace::REST::Gate
 An implementation of Hyperspace::Gate for REST collections. More...
 
class  Hyperspace::REST::KeyValueCollection
 Convenience RESTful-compliant Collection returning Key/Value payloads. More...
 
class  Hyperspace::REST::KeyValueResource
 Convenience RESTful-compliant Resource returning Key/Value payloads. More...
 
class  Hyperspace::REST::PropertyCollection
 Convenience RESTful-compliant Collection based on QObject's properties. More...
 
class  Hyperspace::REST::PropertyResource
 Convenience RESTful-compliant Resource based on QObject's properties. More...
 
class  Hyperspace::REST::Resource
 The base class for Resources. More...
 
class  Hyperspace::REST::ResourceFactory
 The base class for Resource factories. More...
 

Macros

#define HYPERSPACE_REST_FACTORY_FOR_RESOURCE(RClass)
 Generates a basic ResourceFactory for a Resource class. More...
 

Detailed Description

Hyperspace REST contains all the needed classes to export REST Collections and Resources over Hyperspace. It tries to follow strictly the Representational state transfer paradigm, and implements a series of helper to export resources and collections in the easiest possible way.

It is contained in the Hyperspace::REST namespace.

Macro Definition Documentation

#define HYPERSPACE_REST_FACTORY_FOR_RESOURCE (   RClass)

Generates a basic ResourceFactory for a Resource class.

This Macro generates a very simple ResourceFactory subclass which returns a new Resource built with its ID as the only parameter to the constructor. Unless you need to supply your resource with additional parameters during construction, it is advised to use this macro to generate the class.

The class name will be <ResourceClassName>Factory.

See also
Hyperspace::REST::ResourceFactory
Hyperspace::REST::Resource