client-cpp  0.6.1
kaa Namespace Reference

Classes

class  AbstractKaaTransport
 
class  AbstractProfileContainer
 
class  AbstractServerInfo
 
class  AbstractTransactable
 
class  AvroByteArrayConverter
 
class  BootstrapDataProcessor
 
class  BootstrapManager
 
class  BootstrapTransport
 
class  ClientStatus
 
class  ConnackMessage
 
class  ConnectMessage
 
struct  DetailedTopicState
 
class  DisconnectMessage
 
class  EndpointObjectHash
 
class  HttpLPServerInfo
 
class  HttpServerInfo
 
class  HttpUrl
 
class  IBootstrapManager
 
class  IBootstrapTransport
 
class  IConfigurationTrasnport
 
class  IConnectivityChecker
 
class  IDataChannel
 
class  IEncoderDecoder
 
class  IEventTransport
 
class  IKaaChannelManager
 
class  IKaaClient
 
class  IKaaClientStateStorage
 
class  IKaaDataDemultiplexer
 
class  IKaaDataMultiplexer
 
class  IKaaTcpRequest
 
class  IKaaTransport
 
class  ILogger
 
class  ILoggingTransport
 
class  IMetaDataTransport
 
class  ImpermanentDataChannel
 
class  INotificationTransport
 
class  IPingServerStorage
 
class  IProfileContainer
 
class  IProfileListener
 
class  IProfileManager
 
class  IProfileTransport
 
class  IRedirectionTransport
 
class  ISerializedProfileContainer
 
class  IServerInfo
 
class  ITransactable
 
class  IUserTransport
 
class  Kaa
 
class  KaaChannelManager
 
class  KaaClient
 
class  KaaException
 
class  KaaObservable
 
class  KaaSyncRequest
 
class  KaaSyncResponse
 
class  KaaTcpCommon
 
class  KaaTcpParser
 
class  KaaTcpResponseProcessor
 
class  KaaTcpServerInfo
 
class  KeyUtils
 
class  LoggingUtils
 
class  MetaDataTransport
 
class  OperationsDataProcessor
 
class  PingRequest
 
class  ProfileListener
 
class  ProfileManager
 
class  ProfileTransport
 
class  RedirectionTransport
 
class  RsaEncoderDecoder
 
struct  SequenceNumber
 
class  SerializedProfileContainer
 
class  ServerInfo
 
class  TransactionId
 
class  TransportException
 
class  UnavailableTopicException
 

Typedefs

typedef std::vector
< OperationsServer > 
EndpointServerList
 
typedef std::shared_ptr
< IBootstrapTransport
IBootstrapTransportPtr
 
typedef std::shared_ptr
< IConnectivityChecker
ConnectivityCheckerPtr
 
typedef IDataChannelIDataChannelPtr
 
typedef std::shared_ptr
< IMetaDataTransport
IMetaDataTransportPtr
 
typedef std::shared_ptr
< IConfigurationTrasnport
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
< HttpLPServerInfo
OperationServerLongPollInfoPtr
 
typedef std::shared_ptr
< HttpServerInfo
OperationServerHttpInfoPtr
 
typedef std::shared_ptr
< IServerInfo
IServerInfoPtr
 
typedef std::shared_ptr
< KaaTcpServerInfo
OperationServerKaaTcpInfoPtr
 
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::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
< IServerInfoPtr
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< ILoggerLoggerPtr
 
typedef std::shared_ptr
< IProfileContainer
ProfileContainerPtr
 
typedef std::shared_ptr
< IProfileListener
ProfileListenerPtr
 
typedef std::shared_ptr
< ISerializedProfileContainer
ISerializedProfileContainerPtr
 
typedef std::shared_ptr
< SerializedProfileContainer
SerializedProfileContainerPtr
 
typedef std::pair
< Botan::MemoryVector
< std::uint8_t >, std::string > 
KeyPair
 
typedef std::shared_ptr
< TransactionId
TransactionIdPtr
 

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  CommonValueType {
  CommonValueType::COMMON_NULL, CommonValueType::COMMON_BOOL, CommonValueType::COMMON_INT32, CommonValueType::COMMON_INT64,
  CommonValueType::COMMON_FLOAT, CommonValueType::COMMON_DOUBLE, CommonValueType::COMMON_STRING, CommonValueType::COMMON_BYTES,
  CommonValueType::COMMON_SCHEMA_INDEPENDENT, CommonValueType::COMMON_FIXED, CommonValueType::COMMON_ENUM, CommonValueType::COMMON_ARRAY,
  CommonValueType::COMMON_RECORD, CommonValueType::COMMON_UNKNOWN
}
 
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  LogLevel {
  LogLevel::TRACE = 0, LogLevel::DEBUG, LogLevel::INFO, LogLevel::WARNING,
  LogLevel::ERROR, LogLevel::FATAL
}
 

Functions

const BootstrapServersgetServerInfoList ()
 
const Botan::SecureVector
< std::uint8_t > & 
getDefaultConfigData ()
 
const std::string & getDefaultConfigSchema ()
 
const
EventClassFamilyVersionInfos
getEventClassFamilyVersionInfo ()
 
SharedDataBuffer 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
 

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.

typedef std::vector<IServerInfoPtr> kaa::BootstrapServers

Definition at line 70 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 std::vector<OperationsServer> kaa::EndpointServerList

Definition at line 27 of file IBootstrapManager.hpp.

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

Definition at line 76 of file KaaDefaults.hpp.

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

Definition at line 48 of file KaaClient.hpp.

Definition at line 30 of file BootstrapDataProcessor.hpp.

Definition at line 38 of file OperationsDataProcessor.hpp.

Definition at line 158 of file IDataChannel.hpp.

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

Definition at line 41 of file OperationsDataProcessor.hpp.

Definition at line 85 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 42 of file OperationsDataProcessor.hpp.

Definition at line 37 of file OperationsDataProcessor.hpp.

Definition at line 39 of file OperationsDataProcessor.hpp.

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

Definition at line 67 of file IProfileTransport.hpp.

Definition at line 43 of file OperationsDataProcessor.hpp.

typedef std::shared_ptr<IServerInfo> kaa::IServerInfoPtr

Definition at line 53 of file IServerInfo.hpp.

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

Definition at line 40 of file OperationsDataProcessor.hpp.

typedef std::pair<Botan::MemoryVector<std::uint8_t>, std::string> kaa::KeyPair

Definition at line 29 of file KeyUtils.hpp.

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

Definition at line 38 of file ILogger.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.

Definition at line 66 of file HttpServerInfo.hpp.

Definition at line 41 of file KaaTcpServerInfo.hpp.

Definition at line 43 of file HttpLPServerInfo.hpp.

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

Definition at line 25 of file IProfileContainer.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 std::pair<boost::shared_array<std::uint8_t>, std::uint32_t> kaa::SharedDataBuffer

Definition at line 30 of file EndpointObjectHash.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.

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::CommonValueType
strong

Describes types which CommonValue may contain.

Enumerator
COMMON_NULL 
COMMON_BOOL 
COMMON_INT32 
COMMON_INT64 
COMMON_FLOAT 
COMMON_DOUBLE 
COMMON_STRING 
COMMON_BYTES 
COMMON_SCHEMA_INDEPENDENT 
COMMON_FIXED 
COMMON_ENUM 
COMMON_ARRAY 
COMMON_RECORD 
COMMON_UNKNOWN 

Definition at line 25 of file CommonValueTypes.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 54 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.

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 Botan::SecureVector<std::uint8_t>& kaa::getDefaultConfigData ( )
const std::string& kaa::getDefaultConfigSchema ( )
const EventClassFamilyVersionInfos& kaa::getEventClassFamilyVersionInfo ( )
SharedDataBuffer kaa::getPropertiesHash ( )
const BootstrapServers& kaa::getServerInfoList ( )

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 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