automotive-message-broker  0.12
 All Classes Functions Variables Typedefs Enumerations Enumerator Pages
Public Types | Public Member Functions | Public Attributes | List of all members
AsyncPropertyReply Class Reference

The AsyncPropertyReply class is used by sources to reply to Get and Set operations. The source should set success to true if the call is successful or 'false' if the request was not successful and set 'error' to the appropriate error. More...

#include <abstractroutingengine.h>

Inheritance diagram for AsyncPropertyReply:
AsyncPropertyRequest

Public Types

enum  Error {
  NoError = 0, Timeout, InvalidOperation, PermissionDenied,
  ZoneNotSupported
}
 The Error enum.
 

Public Member Functions

 AsyncPropertyReply (const AsyncPropertyRequest &request)
 
 AsyncPropertyReply (const AsyncSetPropertyRequest &request)
 
- Public Member Functions inherited from AsyncPropertyRequest
 AsyncPropertyRequest (const AsyncPropertyRequest &request)
 
AsyncPropertyRequestoperator= (const AsyncPropertyRequest &other)
 

Public Attributes

AbstractPropertyTypevalue
 value of the reply. This may be null if success = false. This is owned by the source.
 
bool success
 success indicates if the request was successfull or not. True means success. False means fail and the 'error' member should be set.
 
TimedOutCallback timedout
 timed out callback is called when the reply times out. This is so sources can avoid using this reply which may become invalid after it times out.
 
Error error
 error contains the error if the request was not successful.\ More...
 
- Public Attributes inherited from AsyncPropertyRequest
VehicleProperty::Property property
 property property to request.
 
std::string sourceUuidFilter
 sourceUuidFilter the requesting sink should use this to filter on a specific source or leave blank to use any source
 
Zone::Type zoneFilter
 zoneFilter the requesting sink should use this if he wants to filter on a specific zone
 
GetPropertyCompletedSignal completed
 completed the callback when the request has been completed.
 
uint timeout
 use to specify a timeout in ms for the request. When a timeout occurs, the 'completed' callback will be called with an error. More...
 
std::string pid
 pid requesting process id
 

Detailed Description

The AsyncPropertyReply class is used by sources to reply to Get and Set operations. The source should set success to true if the call is successful or 'false' if the request was not successful and set 'error' to the appropriate error.

See Also
AbstractRoutingEngine::getPropertyAsync
AsyncPropertyReply
AbstractSource::Operations
AbstractSource::getPropertyAsync

Member Data Documentation

Error AsyncPropertyReply::error

error contains the error if the request was not successful.\

See Also
Error

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