BeeeOn Gateway  v2020.3.1-2-g6f737dc
Platform to interconnect the IoT world
Public Types | Public Member Functions | Protected Member Functions
BeeeOn::GWDeviceListRequest Class Reference

Represents a message sent by the gateway to the server, intended to requests a list of paired devices with a specific prefix. More...

#include <GWDeviceListRequest.h>

Inheritance diagram for BeeeOn::GWDeviceListRequest:
BeeeOn::GWRequest BeeeOn::GWMessage

Public Types

typedef Poco::SharedPtr
< GWDeviceListRequest
Ptr
 
- Public Types inherited from BeeeOn::GWRequest
typedef Poco::SharedPtr
< GWRequest
Ptr
 
- Public Types inherited from BeeeOn::GWMessage
typedef Poco::SharedPtr
< GWMessage
Ptr
 

Public Member Functions

 GWDeviceListRequest (const Poco::JSON::Object::Ptr object)
 
void setDevicePrefix (const DevicePrefix &prefix)
 
DevicePrefix devicePrefix () const
 
- Public Member Functions inherited from BeeeOn::GWRequest
template<typename T >
Poco::SharedPtr< T > derive (std::function< void(Poco::SharedPtr< T >)> f=[](Poco::SharedPtr< T >){}) const
 Derive the appropriate response and apply the given function to construct it.
 
GWResponse::Ptr derive (std::function< void(GWResponse::Ptr)> f=[](GWResponse::Ptr){}) const
 Derive the appropriate response and apply the given function to construct it.
 
- Public Member Functions inherited from BeeeOn::GWMessage
void setID (const GlobalID &id)
 Set unique identifier intended to match request message with its response.
 
GlobalID id () const
 Return unique identifier intended to match request message with its response.
 
GWMessageType type () const
 Returns the type of the message.
 
std::string toString () const
 Returns the string representation of the message.
 
std::string toBriefString () const
 

Protected Member Functions

GWResponse::Ptr deriveResponse () const override
 
- Protected Member Functions inherited from BeeeOn::GWRequest
 GWRequest (const GWMessageType::Raw &type)
 
 GWRequest (const Poco::JSON::Object::Ptr object)
 
GWResponse::Ptr deriveGenericResponse (GWResponse::Ptr response) const
 
- Protected Member Functions inherited from BeeeOn::GWMessage
 GWMessage (const GWMessageType::Raw &type)
 Constructs a GWMessage depending on the given type. More...
 
 GWMessage (const Poco::JSON::Object::Ptr object)
 Constructs a GWMessage from the JSON::Object.
 
Poco::JSON::Object::Ptr json () const
 

Additional Inherited Members

- Static Public Member Functions inherited from BeeeOn::GWMessage
static GWMessage::Ptr fromJSON (const std::string &json)
 Factory method for creating subclasses of the GWMessage from the json string. More...
 
static GWMessage::Ptr fromJSON (Poco::JSON::Object::Ptr object)
 Factory method for creating subclasses of the GWMessage from the JSON::Object. More...
 

Detailed Description

Represents a message sent by the gateway to the server, intended to requests a list of paired devices with a specific prefix.

GWDeviceListRequest represents response to this request.

An example message:

{
  "id": "ffd0da59-5f6d-4363-b2ad-afa95ef85d59",
  "message_type": "device_list_request",
  "device_prefix": "vdev"
}

The documentation for this class was generated from the following files: