client-cpp  0.7.0
kaa Namespace Reference

Classes

class  AbstractHttpChannel
 
class  AbstractKaaTransport
 
class  AbstractTransactable
 
class  AvroByteArrayConverter
 
class  BadCredentials
 The exception is thrown to indicate that something is wrong with the input identification data. More...
 
class  BootstrapManager
 
class  BootstrapTransport
 
class  ClientStatus
 
class  ConfigurationManager
 
class  ConfigurationPersistenceManager
 
class  ConfigurationProcessor
 
class  ConfigurationTransport
 
class  ConnackMessage
 
class  ConnectMessage
 
class  DefaultBootstrapChannel
 
class  DefaultLogUploadStrategy
 The default ILogUploadStrategy implementation. More...
 
class  DefaultOperationHttpChannel
 
class  DefaultOperationLongPollChannel
 
class  DefaultOperationTcpChannel
 
struct  DetailedTopicState
 
class  DisconnectMessage
 
class  EndpointObjectHash
 
class  EndpointRegistrationManager
 
class  EventManager
 
class  EventTransport
 
class  FileConfigurationStorage
 
class  GenericTransportInfo
 
class  HttpClient
 
class  HttpDataProcessor
 
class  HttpResponse
 
class  HttpUrl
 
class  HttpUtils
 
class  IAttachEndpointCallback
 Interface to the listener notifies of the result of whether the current endpoint has successfully attached a target endpoint. More...
 
class  IAttachStatusListener
 Interface to the listener notifies of the current endpoint is attached/detached by the another endpoint. More...
 
class  IBootstrapManager
 
class  IBootstrapTransport
 
class  IConfigurationHashContainer
 
class  IConfigurationManager
 
class  IConfigurationPersistenceManager
 
class  IConfigurationProcessedObservable
 
class  IConfigurationProcessedObserver
 
class  IConfigurationProcessor
 
class  IConfigurationReceiver
 
class  IConfigurationStorage
 
class  IConfigurationTransport
 
class  IConnectivityChecker
 
class  IDataChannel
 
class  IDecodedDeltaObservable
 
class  IDetachEndpointCallback
 Interface to the listener notifies of the result of whether the current endpoint has successfully detached a target endpoint. More...
 
class  IEncoderDecoder
 
class  IEndpointRegistrationManager
 The interface to a module which associates endpoints with users. More...
 
class  IEventDataProcessor
 
class  IEventFamily
 
class  IEventListenersResolver
 
class  IEventManager
 
class  IEventTransport
 
class  IFetchEventListeners
 
class  IGenericDeltaReceiver
 
class  IHttpClient
 
class  IHttpRequest
 
class  IHttpResponse
 
class  IKaaChannelManager
 
class  IKaaClient
 
class  IKaaClientStateStorage
 
class  IKaaDataDemultiplexer
 
class  IKaaDataMultiplexer
 
class  IKaaTcpRequest
 
class  IKaaTransport
 
class  ILogCollector
 The public interface to the Kaa log collecting subsystem. More...
 
class  ILogger
 
class  ILoggingTransport
 
class  ILogProcessor
 
class  ILogStorage
 The public interface to access to the log storage. More...
 
class  ILogStorageStatus
 The public interface to represent the current log storage state. More...
 
class  ILogUploadStrategy
 The public interface for the log upload strategy. More...
 
class  IMetaDataTransport
 
class  ImpermanentDataChannel
 
class  INotificationListener
 The listener which receives notifications on the specified topic. More...
 
class  INotificationManager
 The public interface to topic subscription and notification delivery subsystems. More...
 
class  INotificationProcessor
 
class  INotificationTopicListListener
 The listener which receives updates on available topics. More...
 
class  INotificationTransport
 
class  IPingServerStorage
 
class  IProfileContainer
 The interface for the profile container. More...
 
class  IProfileListener
 
class  IProfileManager
 
class  IProfileTransport
 
class  IPTransportInfo
 
class  IRedirectionTransport
 
class  IRegistrationProcessor
 
class  ITransactable
 
class  ITransportConnectionInfo
 
class  IUserAttachCallback
 Interface to the listener notifies of the result of whether the current endpoint has successfully attached itself to the user. More...
 
class  IUserTransport
 
class  Kaa
 
class  KaaChannelManager
 
class  KaaClient
 
class  KaaException
 
class  KaaObservable
 
class  KaaSyncRequest
 
class  KaaSyncResponse
 
class  KaaTcpCommon
 
class  KaaTcpParser
 
class  KaaTcpResponseProcessor
 
class  KeyPair
 
class  KeyUtils
 
class  LogCollector
 
class  LoggingTransport
 
class  LoggingUtils
 
class  LogRecord
 
class  MemoryLogStorage
 The default ILogStorage implementation. More...
 
class  MetaDataTransport
 
class  MultipartPostHttpRequest
 
class  NotificationManager
 
class  NotificationTransport
 
class  PingRequest
 
class  ProfileManager
 
class  ProfileTransport
 
class  RedirectionTransport
 
class  RsaEncoderDecoder
 
struct  SequenceNumber
 
class  SyncDataProcessor
 
class  TransactionId
 
class  TransportException
 
class  TransportNotFoundException
 The exception is thrown to indicate that Kaa SDK isn't fully initialized. More...
 
class  TransportProtocolId
 
class  TransportProtocolIdConstants
 
class  UnavailableTopicException
 
class  UserTransport
 
class  UuidGenerator
 

Typedefs

typedef std::shared_ptr
< IConnectivityChecker
ConnectivityCheckerPtr
 
typedef IDataChannelIDataChannelPtr
 
typedef IKaaChannelManagerIKaaChannelManagerPtr
 
typedef std::shared_ptr
< ITransportConnectionInfo
ITransportConnectionInfoPtr
 
typedef std::shared_ptr
< IMetaDataTransport
IMetaDataTransportPtr
 
typedef std::shared_ptr
< IBootstrapTransport
IBootstrapTransportPtr
 
typedef std::shared_ptr
< IConfigurationTransport
IConfigurationTransportPtr
 
typedef std::shared_ptr
< INotificationTransport
INotificationTransportPtr
 
typedef std::shared_ptr
< IUserTransport
IUserTransportPtr
 
typedef std::shared_ptr
< IEventTransport
IEventTransportPtr
 
typedef std::shared_ptr
< ILoggingTransport
ILoggingTransportPtr
 
typedef std::shared_ptr
< IRedirectionTransport
IRedirectionTransportPtr
 
typedef std::shared_ptr
< IKaaTransport
IKaaTransportPtr
 
typedef std::list
< SubscriptionCommand > 
SubscriptionCommands
 
typedef std::shared_ptr
< NotificationSyncRequest > 
NotificationSyncRequestPtr
 
typedef std::shared_ptr
< ProfileSyncRequest > 
ProfileSyncRequestPtr
 
typedef std::shared_ptr
< IProfileTransport
IProfileTransportPtr
 
typedef boost::bimaps::bimap
< boost::bimaps::set_of
< ClientParameterT >
, boost::bimaps::set_of
< std::string >
, boost::bimaps::left_based > 
bimap
 
typedef std::pair
< boost::shared_array
< std::uint8_t >
, std::uint32_t > 
SharedDataBuffer
 
typedef std::vector< std::uint8_t > HashDigest
 
typedef std::shared_ptr
< IConfigurationHashContainer
IConfigurationHashContainerPtr
 
typedef std::shared_ptr
< IConfigurationProcessor
IConfigurationProcessorPtr
 
typedef std::shared_ptr
< IConfigurationManager
IConfigurationManagerPtr
 
typedef std::shared_ptr
< IConfigurationPersistenceManager
IConfigurationPersistenceManagerPtr
 
typedef std::shared_ptr
< IConfigurationStorage
IConfigurationStoragePtr
 
typedef std::list< std::string > FQNList
 
typedef std::shared_ptr
< IFetchEventListeners
IFetchEventListenersPtr
 
typedef std::shared_ptr
< IAttachEndpointCallback
IAttachEndpointCallbackPtr
 
typedef std::shared_ptr
< IAttachStatusListener
IAttachStatusListenerPtr
 
typedef std::shared_ptr
< IDetachEndpointCallback
IDetachEndpointCallbackPtr
 
typedef std::shared_ptr
< UserAttachRequest > 
UserAttachRequestPtr
 
typedef std::shared_ptr
< IUserAttachCallback
IUserAttachCallbackPtr
 
typedef std::pair
< boost::shared_array
< std::uint8_t >, size_t > 
SharedBody
 
typedef std::map< std::string,
DetailedTopicState
DetailedTopicStates
 
typedef std::map< std::string,
std::string > 
AttachedEndpoints
 
typedef std::shared_ptr
< IKaaClientStateStorage
IKaaClientStateStoragePtr
 
typedef std::shared_ptr
< IBootstrapManager
IBootstrapManagerPtr
 
typedef enum kaa::KaaOption KaaOption
 
typedef std::vector
< ITransportConnectionInfoPtr
BootstrapServers
 
typedef std::map< std::string,
std::int32_t > 
EventClassFamilyVersionInfos
 
typedef std::pair
< KaaTcpMessageType, std::pair
< boost::shared_array< char >
, std::uint32_t > > 
MessageRecord
 
typedef std::list< MessageRecordMessageRecordList
 
typedef std::shared_ptr
< LogRecord
LogRecordPtr
 
typedef std::shared_ptr
< ILogStorage
ILogStoragePtr
 
typedef std::shared_ptr
< ILogUploadStrategy
ILogUploadStrategyPtr
 
typedef std::shared_ptr< ILoggerLoggerPtr
 
typedef std::shared_ptr
< IProfileContainer
IProfileContainerPtr
 
typedef std::shared_ptr
< IProfileListener
ProfileListenerPtr
 
typedef Botan::MemoryVector
< std::uint8_t > 
PublicKey
 
typedef std::string PrivateKey
 
typedef Botan::SymmetricKey SessionKey
 
typedef Botan::SecureVector
< std::uint8_t > 
EncodedSessionKey
 
typedef Botan::SecureVector
< std::uint8_t > 
Signature
 
typedef std::shared_ptr
< TransactionId
TransactionIdPtr
 
typedef std::shared_ptr
< HttpDataProcessor
HttpDataProcessorPtr
 

Enumerations

enum  ChannelDirection { UP, DOWN, BIDIRECTIONAL }
 
enum  ServerType { ServerType::BOOTSTRAP, ServerType::OPERATIONS }
 
enum  TransportType {
  TransportType::BOOTSTRAP = 0, TransportType::PROFILE, TransportType::CONFIGURATION, TransportType::NOTIFICATION,
  TransportType::USER, TransportType::EVENT, TransportType::LOGGING
}
 
enum  KaaOption {
  USE_DEFAULT_BOOTSTRAP_HTTP_CHANNEL = 0x01, USE_DEFAULT_OPERATION_KAATCP_CHANNEL = 0x02, USE_DEFAULT_OPERATION_HTTP_CHANNEL = 0x04, USE_DEFAULT_OPERATION_LONG_POLL_CHANNEL = 0x08,
  USE_DEFAULT_CONNECTIVITY_CHECKER = 0x10
}
 
enum  ConnackReturnCode : std::uint8_t {
  ConnackReturnCode::UNKNOWN = 0x00, ConnackReturnCode::SUCCESS = 0x01, ConnackReturnCode::UNACCEPTABLE_VERSION = 0x02, ConnackReturnCode::IDENTIFIER_REJECTED = 0x03,
  ConnackReturnCode::SERVER_UNAVAILABLE = 0x04, ConnackReturnCode::BAD_USER_PASSWORD = 0x05, ConnackReturnCode::NOT_AUTHORIZED = 0x06
}
 
enum  DisconnectReason : std::uint8_t { DisconnectReason::NONE = 0x00, DisconnectReason::BAD_REQUEST = 0x01, DisconnectReason::INTERNAL_ERROR = 0x02 }
 
enum  KaaSyncMessageType : std::uint8_t { KaaSyncMessageType::UNUSED = 0x0, KaaSyncMessageType::SYNC = 0x1, KaaSyncMessageType::BOOTSTRAP = 0x2 }
 
enum  KaaTcpMessageType : std::uint8_t {
  KaaTcpMessageType::MESSAGE_UNKNOWN = 0x00, KaaTcpMessageType::MESSAGE_CONNECT = 0x01, KaaTcpMessageType::MESSAGE_CONNACK = 0x02, KaaTcpMessageType::MESSAGE_PINGREQ = 0x0C,
  KaaTcpMessageType::MESSAGE_PINGRESP = 0x0D, KaaTcpMessageType::MESSAGE_DISCONNECT = 0x0E, KaaTcpMessageType::MESSAGE_KAASYNC = 0x0F
}
 
enum  KaaTcpParserState : std::uint8_t { KaaTcpParserState::NONE = 0x00, KaaTcpParserState::PROCESSING_LENGTH = 0x01, KaaTcpParserState::PROCESSING_PAYLOAD = 0x02 }
 
enum  LogUploadStrategyDecision { LogUploadStrategyDecision::NOOP = 0, LogUploadStrategyDecision::UPLOAD }
 Log upload decisions. More...
 
enum  LogLevel {
  LogLevel::TRACE = 0, LogLevel::DEBUG, LogLevel::INFO, LogLevel::WARNING,
  LogLevel::ERROR, LogLevel::FATAL
}
 

Functions

const BootstrapServersgetBootstrapServers ()
 
const Botan::SecureVector
< std::uint8_t > & 
getDefaultConfigData ()
 
const
EventClassFamilyVersionInfos
getEventClassFamilyVersionInfo ()
 
HashDigest getPropertiesHash ()
 

Variables

const char *const BUILD_VERSION
 
const char *const BUILD_COMMIT_HASH
 
const char *const APPLICATION_TOKEN
 
const std::uint32_t PROFILE_VERSION
 
const std::uint32_t CONFIG_VERSION
 
const std::uint32_t SYSTEM_NF_VERSION
 
const std::uint32_t USER_NF_VERSION
 
const std::uint32_t LOG_SCHEMA_VERSION
 
const std::uint32_t POLLING_PERIOD_SECONDS
 
const char *const CLIENT_PUB_KEY_LOCATION
 
const char *const CLIENT_PRIV_KEY_LOCATION
 
const char *const CLIENT_STATUS_FILE_LOCATION
 
const char *const DEFAULT_USER_VERIFIER_TOKEN
 

Typedef Documentation

typedef std::map<std::string, std::string> kaa::AttachedEndpoints

Definition at line 42 of file IKaaClientStateStorage.hpp.

typedef boost::bimaps::bimap< boost::bimaps::set_of<ClientParameterT> , boost::bimaps::set_of<std::string> , boost::bimaps::left_based> kaa::bimap

Definition at line 35 of file ClientStatus.hpp.

Definition at line 67 of file KaaDefaults.hpp.

Definition at line 39 of file IConnectivityChecker.hpp.

typedef std::map<std::string, DetailedTopicState> kaa::DetailedTopicStates

Definition at line 40 of file IKaaClientStateStorage.hpp.

typedef Botan::SecureVector<std::uint8_t> kaa::EncodedSessionKey

Definition at line 29 of file SecurityDefinitions.hpp.

typedef std::map<std::string, std::int32_t> kaa::EventClassFamilyVersionInfos

Definition at line 72 of file KaaDefaults.hpp.

typedef std::list<std::string> kaa::FQNList

Definition at line 30 of file IEventFamily.hpp.

typedef std::vector<std::uint8_t> kaa::HashDigest

Definition at line 32 of file EndpointObjectHash.hpp.

typedef std::shared_ptr<HttpDataProcessor> kaa::HttpDataProcessorPtr

Definition at line 65 of file HttpDataProcessor.hpp.

Definition at line 48 of file IAttachEndpointCallback.hpp.

Definition at line 51 of file IAttachStatusListener.hpp.

typedef std::shared_ptr<IBootstrapManager> kaa::IBootstrapManagerPtr

Definition at line 44 of file KaaClient.hpp.

Definition at line 39 of file SyncDataProcessor.hpp.

Definition at line 55 of file IConfigurationManager.hpp.

Definition at line 48 of file IConfigurationProcessor.hpp.

Definition at line 51 of file IConfigurationStorage.hpp.

Definition at line 40 of file SyncDataProcessor.hpp.

Definition at line 164 of file IDataChannel.hpp.

Definition at line 45 of file IDetachEndpointCallback.hpp.

typedef std::shared_ptr<IEventTransport> kaa::IEventTransportPtr

Definition at line 43 of file SyncDataProcessor.hpp.

Definition at line 54 of file IFetchEventListeners.hpp.

Definition at line 88 of file IKaaClientStateStorage.hpp.

typedef std::shared_ptr<IKaaTransport> kaa::IKaaTransportPtr

Definition at line 54 of file IKaaTransport.hpp.

typedef std::shared_ptr<ILoggingTransport> kaa::ILoggingTransportPtr

Definition at line 44 of file SyncDataProcessor.hpp.

typedef std::shared_ptr<ILogStorage> kaa::ILogStoragePtr

Definition at line 104 of file ILogStorage.hpp.

Definition at line 100 of file ILogUploadStrategy.hpp.

Definition at line 38 of file SyncDataProcessor.hpp.

Definition at line 41 of file SyncDataProcessor.hpp.

typedef std::shared_ptr<IProfileContainer> kaa::IProfileContainerPtr

Definition at line 43 of file IProfileContainer.hpp.

typedef std::shared_ptr<IProfileTransport> kaa::IProfileTransportPtr

Definition at line 78 of file IProfileTransport.hpp.

Definition at line 45 of file SyncDataProcessor.hpp.

Definition at line 76 of file ITransportConnectionInfo.hpp.

Definition at line 52 of file IUserAttachCallback.hpp.

typedef std::shared_ptr<IUserTransport> kaa::IUserTransportPtr

Definition at line 42 of file SyncDataProcessor.hpp.

typedef std::shared_ptr<ILogger> kaa::LoggerPtr

Definition at line 38 of file ILogger.hpp.

typedef std::shared_ptr< LogRecord > kaa::LogRecordPtr

Definition at line 36 of file ILogStorage.hpp.

typedef std::pair<KaaTcpMessageType, std::pair<boost::shared_array<char>, std::uint32_t> > kaa::MessageRecord

Definition at line 28 of file KaaTcpParser.hpp.

Definition at line 29 of file KaaTcpParser.hpp.

typedef std::shared_ptr<NotificationSyncRequest> kaa::NotificationSyncRequestPtr

Definition at line 28 of file INotificationTransport.hpp.

typedef std::string kaa::PrivateKey

Definition at line 26 of file SecurityDefinitions.hpp.

typedef std::shared_ptr<IProfileListener> kaa::ProfileListenerPtr

Definition at line 26 of file IProfileListener.hpp.

typedef std::shared_ptr<ProfileSyncRequest> kaa::ProfileSyncRequestPtr

Definition at line 26 of file IProfileTransport.hpp.

typedef Botan::MemoryVector<std::uint8_t> kaa::PublicKey

Definition at line 25 of file SecurityDefinitions.hpp.

typedef Botan::SymmetricKey kaa::SessionKey

Definition at line 28 of file SecurityDefinitions.hpp.

typedef std::pair<boost::shared_array<std::uint8_t>, size_t> kaa::SharedBody

Definition at line 29 of file IHttpResponse.hpp.

typedef std::pair<boost::shared_array<std::uint8_t>, std::uint32_t> kaa::SharedDataBuffer

Definition at line 31 of file EndpointObjectHash.hpp.

typedef Botan::SecureVector<std::uint8_t> kaa::Signature

Definition at line 31 of file SecurityDefinitions.hpp.

typedef std::list<SubscriptionCommand> kaa::SubscriptionCommands

Definition at line 27 of file INotificationTransport.hpp.

typedef std::shared_ptr<TransactionId> kaa::TransactionIdPtr

Definition at line 68 of file TransactionId.hpp.

typedef std::shared_ptr<UserAttachRequest> kaa::UserAttachRequestPtr

Definition at line 31 of file IRegistrationProcessor.hpp.

Enumeration Type Documentation

Describes traffic direction that channel supports.

Enumerator
UP 

From the endpoint to the server

DOWN 

From the server to the enpoint

BIDIRECTIONAL 

In both way

Definition at line 25 of file ChannelDirection.hpp.

enum kaa::ConnackReturnCode : std::uint8_t
strong
Enumerator
UNKNOWN 
SUCCESS 
UNACCEPTABLE_VERSION 
IDENTIFIER_REJECTED 
SERVER_UNAVAILABLE 
BAD_USER_PASSWORD 
NOT_AUTHORIZED 

Definition at line 25 of file ConnackMessage.hpp.

enum kaa::DisconnectReason : std::uint8_t
strong
Enumerator
NONE 
BAD_REQUEST 
INTERNAL_ERROR 

Definition at line 27 of file DisconnectMessage.hpp.

Enumerator
USE_DEFAULT_BOOTSTRAP_HTTP_CHANNEL 
USE_DEFAULT_OPERATION_KAATCP_CHANNEL 
USE_DEFAULT_OPERATION_HTTP_CHANNEL 
USE_DEFAULT_OPERATION_LONG_POLL_CHANNEL 
USE_DEFAULT_CONNECTIVITY_CHECKER 

Definition at line 46 of file KaaClient.hpp.

enum kaa::KaaSyncMessageType : std::uint8_t
strong
Enumerator
UNUSED 
SYNC 
BOOTSTRAP 

Definition at line 26 of file KaaSyncRequest.hpp.

enum kaa::KaaTcpMessageType : std::uint8_t
strong
Enumerator
MESSAGE_UNKNOWN 
MESSAGE_CONNECT 
MESSAGE_CONNACK 
MESSAGE_PINGREQ 
MESSAGE_PINGRESP 
MESSAGE_DISCONNECT 
MESSAGE_KAASYNC 

Definition at line 24 of file KaaTcpCommon.hpp.

enum kaa::KaaTcpParserState : std::uint8_t
strong
Enumerator
NONE 
PROCESSING_LENGTH 
PROCESSING_PAYLOAD 

Definition at line 31 of file KaaTcpParser.hpp.

enum kaa::LogLevel
strong
Enumerator
TRACE 
DEBUG 
INFO 
WARNING 
ERROR 
FATAL 

Definition at line 22 of file ILogger.hpp.

Log upload decisions.

Enumerator
NOOP 

Nothing to be done.

UPLOAD 

Initiate log upload.

Definition at line 35 of file ILogUploadStrategy.hpp.

enum kaa::ServerType
strong
Enumerator
BOOTSTRAP 
OPERATIONS 

Definition at line 22 of file ServerType.hpp.

enum kaa::TransportType
strong

TransportTypes - enum with list of all possible transport types which every Channel can support.

Enumerator
BOOTSTRAP 
PROFILE 
CONFIGURATION 
NOTIFICATION 
USER 
EVENT 
LOGGING 

Definition at line 27 of file TransportType.hpp.

Function Documentation

const BootstrapServers& kaa::getBootstrapServers ( )
const Botan::SecureVector<std::uint8_t>& kaa::getDefaultConfigData ( )
const EventClassFamilyVersionInfos& kaa::getEventClassFamilyVersionInfo ( )
HashDigest kaa::getPropertiesHash ( )

Variable Documentation

const char* const kaa::APPLICATION_TOKEN
const char* const kaa::BUILD_COMMIT_HASH
const char* const kaa::BUILD_VERSION

Base endpoint configuration

const char* const kaa::CLIENT_PRIV_KEY_LOCATION
const char* const kaa::CLIENT_PUB_KEY_LOCATION
const char* const kaa::CLIENT_STATUS_FILE_LOCATION
const std::uint32_t kaa::CONFIG_VERSION
const char* const kaa::DEFAULT_USER_VERIFIER_TOKEN
const std::uint32_t kaa::LOG_SCHEMA_VERSION
const std::uint32_t kaa::POLLING_PERIOD_SECONDS
const std::uint32_t kaa::PROFILE_VERSION
const std::uint32_t kaa::SYSTEM_NF_VERSION
const std::uint32_t kaa::USER_NF_VERSION