Astarte device API for C++ 0.8.1
Astarte device SDK for C++
Loading...
Searching...
No Matches
AstarteDeviceSdk Namespace Reference

Umbrella namespace for the Astarte device SDK. More...

Classes

class  AstarteData
 Astarte data class, representing the basic Astarte types. More...
 
class  AstarteDatastreamIndividual
 Representing the Astarte individual datastream data. More...
 
class  AstarteDatastreamObject
 Astarte object class, representing the Astarte object datastream data. More...
 
class  AstarteDevice
 Interface for an Astarte device. More...
 
class  AstarteDeviceGrpc
 Class for the Astarte devices. More...
 
class  AstarteErrorBase
 Base error class representing any possible error from the Astarte device library. More...
 
class  AstarteFileOpenError
 Specific error for when a file cannot be opened. More...
 
class  AstarteGrpcLibError
 Error reported by the gRPC transport library. More...
 
class  AstarteInternalError
 Specific error for when an operation failed due to an internal error. More...
 
class  AstarteInvalidInputError
 Specific error for when an operation failed due to incompatible user input. More...
 
class  AstarteMessage
 Astarte message class, represents a full message for/from Astarte. More...
 
class  AstarteMsgHubError
 Error reported by the Astarte message hub library. More...
 
class  AstarteOperationRefusedError
 Attempted an operation which is not permitted according to the current device status. More...
 
class  AstartePropertyIndividual
 Representing the Astarte individual datastream data. More...
 
class  AstarteStoredProperty
 Representing data for a stored property. More...
 

Concepts

concept  AstarteDataAllowedType
 Restricts the allowed types for instances of an Astarte data class.
 

Typedefs

using AstarteError
 A variant type representing any possible error from the Astarte device library.
 

Enumerations

enum  AstarteOwnership : int8_t { kDevice , kServer }
 Possible Astarte ownership. More...
 
enum  AstarteType : int8_t {
  kBinaryBlob , kBoolean , kDatetime , kDouble ,
  kInteger , kLongInteger , kString , kBinaryBlobArray ,
  kBooleanArray , kDatetimeArray , kDoubleArray , kIntegerArray ,
  kLongIntegerArray , kStringArray
}
 Possible Astarte types. More...
 

Detailed Description

Umbrella namespace for the Astarte device SDK.

Typedef Documentation

◆ AstarteError

Initial value:
Specific error for when a file cannot be opened.
Definition errors.hpp:116
Error reported by the gRPC transport library.
Definition errors.hpp:179
Specific error for when an operation failed due to an internal error.
Definition errors.hpp:95
Specific error for when an operation failed due to incompatible user input.
Definition errors.hpp:137
Error reported by the Astarte message hub library.
Definition errors.hpp:214
Attempted an operation which is not permitted according to the current device status.
Definition errors.hpp:158

A variant type representing any possible error from the Astarte device library.

This type is intended to be used as the error type 'E' in std::expected<T, E>.

Enumeration Type Documentation

◆ AstarteOwnership

Possible Astarte ownership.

Enumerator
kDevice 

Ownership is retained by the device.

kServer 

Ownership is retained by the Astarte cloud server.

◆ AstarteType

Possible Astarte types.

Enumerator
kBinaryBlob 

Binary blob Astarte type.

kBoolean 

Boolean Astarte type.

kDatetime 

Date-time Astarte type.

kDouble 

Double Astarte type.

kInteger 

Integer Astarte type.

kLongInteger 

Long integer Astarte type.

kString 

String Astarte type.

kBinaryBlobArray 

Binary blob array Astarte type.

kBooleanArray 

Boolean array Astarte type.

kDatetimeArray 

Datetime array Astarte type.

kDoubleArray 

Double array Astarte type.

kIntegerArray 

Integer array Astarte type.

kLongIntegerArray 

Long integer array Astarte type.

kStringArray 

String array Astarte type.