client-cpp  0.10.0
kaa::GenericTransportInfo Class Reference

#include <GenericTransportInfo.hpp>

+ Inheritance diagram for kaa::GenericTransportInfo:
+ Collaboration diagram for kaa::GenericTransportInfo:

Public Member Functions

 GenericTransportInfo (ServerType type, const ProtocolMetaData &metaData)
 
 GenericTransportInfo (ServerType type, const std::int32_t &accessPointId, const TransportProtocolId &protocolId, const std::vector< std::uint8_t > &connectionData)
 
virtual ServerType getServerType () const
 
virtual std::int32_t getAccessPointId () const
 
virtual TransportProtocolId getTransportId () const
 
virtual const std::vector
< std::uint8_t > & 
getConnectionInfo () const
 
virtual bool isFailedState () const
 
virtual void setFailedState ()
 
virtual void resetFailedState ()
 
- Public Member Functions inherited from kaa::ITransportConnectionInfo
virtual ~ITransportConnectionInfo ()
 

Protected Attributes

ServerType serverType_
 
std::int32_t accessPointId_
 
TransportProtocolId protocolId_
 
std::vector< std::uint8_t > connectionData_
 
bool isFailedState_
 

Detailed Description

Definition at line 27 of file GenericTransportInfo.hpp.

Constructor & Destructor Documentation

kaa::GenericTransportInfo::GenericTransportInfo ( ServerType  type,
const ProtocolMetaData &  metaData 
)
inline

Definition at line 30 of file GenericTransportInfo.hpp.

kaa::GenericTransportInfo::GenericTransportInfo ( ServerType  type,
const std::int32_t &  accessPointId,
const TransportProtocolId protocolId,
const std::vector< std::uint8_t > &  connectionData 
)
inline

Definition at line 34 of file GenericTransportInfo.hpp.

Member Function Documentation

virtual std::int32_t kaa::GenericTransportInfo::getAccessPointId ( ) const
inlinevirtual

Retrieves the access point id (operations/bootstrap service id).

Returns
The access point id.

Implements kaa::ITransportConnectionInfo.

Definition at line 43 of file GenericTransportInfo.hpp.

virtual const std::vector<std::uint8_t>& kaa::GenericTransportInfo::getConnectionInfo ( ) const
inlinevirtual

Retrieves serialized connection data.

Serialization may be specific for each transport protocol implementation.

Returns
The serialized connection data.

Implements kaa::ITransportConnectionInfo.

Definition at line 51 of file GenericTransportInfo.hpp.

virtual ServerType kaa::GenericTransportInfo::getServerType ( ) const
inlinevirtual

Retrieves the channel's server type (i.e. OPERATIONS or BOOTSTRAP).

Returns
The channel's server type.
See Also
ServerType

Implements kaa::ITransportConnectionInfo.

Definition at line 39 of file GenericTransportInfo.hpp.

virtual TransportProtocolId kaa::GenericTransportInfo::getTransportId ( ) const
inlinevirtual

Retrieves the TransportProtocolId.

Returns
The transport protocol id.
See Also
TransportProtocolId

Implements kaa::ITransportConnectionInfo.

Definition at line 47 of file GenericTransportInfo.hpp.

virtual bool kaa::GenericTransportInfo::isFailedState ( ) const
inlinevirtual

Implements kaa::ITransportConnectionInfo.

Definition at line 55 of file GenericTransportInfo.hpp.

virtual void kaa::GenericTransportInfo::resetFailedState ( )
inlinevirtual

Implements kaa::ITransportConnectionInfo.

Definition at line 63 of file GenericTransportInfo.hpp.

virtual void kaa::GenericTransportInfo::setFailedState ( )
inlinevirtual

Implements kaa::ITransportConnectionInfo.

Definition at line 59 of file GenericTransportInfo.hpp.

Member Data Documentation

std::int32_t kaa::GenericTransportInfo::accessPointId_
protected

Definition at line 69 of file GenericTransportInfo.hpp.

std::vector<std::uint8_t> kaa::GenericTransportInfo::connectionData_
protected

Definition at line 71 of file GenericTransportInfo.hpp.

bool kaa::GenericTransportInfo::isFailedState_
protected

Definition at line 72 of file GenericTransportInfo.hpp.

TransportProtocolId kaa::GenericTransportInfo::protocolId_
protected

Definition at line 70 of file GenericTransportInfo.hpp.

ServerType kaa::GenericTransportInfo::serverType_
protected

Definition at line 68 of file GenericTransportInfo.hpp.


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