ifw-fnd 2.0.1
 
Loading...
Searching...
No Matches
ifw::fnd::defs Namespace Reference

Classes

struct  BrowseRequest
 
struct  BrowseResult
 
struct  CallArgument
 
struct  CallArgumentResult
 
struct  CallRequest
 
struct  CallResult
 
class  CancellationSource
 
class  CancellationToken
 
struct  Capabilities
 
struct  ConnectionInfo
 
struct  ConnectionOptions
 
struct  ConnectionStateChange
 
struct  ConnectionStatus
 
struct  DataValue
 
struct  DiscoveredEndpoint
 
struct  DiscoverRequest
 
struct  DiscoverResult
 
class  ICommAdapter
 
struct  NodeDescriptor
 
struct  Notification
 
class  PropertyMap
 
struct  ReadItem
 
struct  ReadItemResult
 
struct  ReadRequest
 
struct  ReadResult
 
class  RegistrationToken
 
struct  RequestOptions
 
struct  Result
 
struct  SubscribeItemResult
 
struct  SubscribeOpts
 
struct  SubscribeResult
 
struct  UnsubscribeItemResult
 
struct  UnsubscribeResult
 
struct  WriteItem
 
struct  WriteItemResult
 
struct  WriteRequest
 
struct  WriteResult
 

Typedefs

using Address = std::string
 
using RequestId = std::string
 
using Value
 
using ConnectionStateHandler
 
using SubscriptionHandler = std::function<void(const Notification&)>
 

Enumerations

enum class  Status {
  Ok , Timeout , NotConnected , AlreadyConnected ,
  InvalidState , BadRequest , NotFound , AccessDenied ,
  TypeMismatch , Unsupported , Cancelled , RemoteError ,
  TransportError , InternalError
}
 
enum class  ConnectionState {
  Disconnected , Connecting , Connected , Disconnecting ,
  Faulted
}
 

Variables

constexpr std::uint32_t kCommAdapterContractVersion = 1
 

Typedef Documentation

◆ Address

using ifw::fnd::defs::Address = std::string

◆ ConnectionStateHandler

Initial value:
std::function<void(const ConnectionStateChange&)>
Definition iCommAdapter.hpp:325

◆ RequestId

using ifw::fnd::defs::RequestId = std::string

◆ SubscriptionHandler

using ifw::fnd::defs::SubscriptionHandler = std::function<void(const Notification&)>

◆ Value

Initial value:
std::variant<
std::monostate,
bool,
std::int32_t,
std::uint32_t,
std::int64_t,
std::uint64_t,
float,
double,
std::string,
std::vector<std::uint8_t>,
std::vector<bool>,
std::vector<std::int32_t>,
std::vector<std::uint32_t>,
std::vector<std::int64_t>,
std::vector<std::uint64_t>,
std::vector<float>,
std::vector<double>,
std::vector<std::string>,
std::int16_t,
std::uint16_t,
std::int8_t,
std::uint8_t,
std::vector<std::int16_t>,
std::vector<std::uint16_t>,
std::vector<std::int8_t>>
Definition iCommAdapter.hpp:72

Enumeration Type Documentation

◆ ConnectionState

Enumerator
Disconnected 
Connecting 
Connected 
Disconnecting 
Faulted 

◆ Status

enum class ifw::fnd::defs::Status
strong
Enumerator
Ok 
Timeout 
NotConnected 
AlreadyConnected 
InvalidState 
BadRequest 
NotFound 
AccessDenied 
TypeMismatch 
Unsupported 
Cancelled 
RemoteError 
TransportError 
InternalError 

Variable Documentation

◆ kCommAdapterContractVersion

std::uint32_t ifw::fnd::defs::kCommAdapterContractVersion = 1
inlineconstexpr