open62541pp 0.17.0
C++ wrapper of open62541
|
Namespaces | |
namespace | services |
namespace | ua |
Typedefs | |
using | DefaultCompletionToken = UseFutureToken |
using | StateCallback = std::function<void()> |
using | InactivityCallback = std::function<void()> |
using | SubscriptionInactivityCallback = std::function<void(IntegerId subscriptionId)> |
using | NamespaceIndex = uint16_t |
using | TypeIndex = uint16_t |
using | DataTypeMember = UA_DataTypeMember |
using | MonitoringParametersEx = services::MonitoringParametersEx |
using | LogFunction = std::function<void(LogLevel, LogCategory, std::string_view msg)> |
using | SubscriptionParameters = services::SubscriptionParameters |
using | DataChangeNotificationCallback = services::DataChangeNotificationCallback |
using | EventNotificationCallback = services::EventNotificationCallback |
using | NumericRangeDimension = UA_NumericRangeDimension |
using | IntegerId = uint32_t |
using | FilterOperand |
using | AggregateConfiguration = UA_AggregateConfiguration |
Enumerations | |
enum class | AttributeId : int32_t |
enum class | NodeClass : int32_t |
enum class | AccessLevel : uint8_t |
enum class | WriteMask : uint32_t |
enum class | ValueRank : int32_t |
enum class | EventNotifier : uint8_t |
enum class | ModellingRule : uint16_t |
enum class | CertificateFormat |
enum class | LogLevel |
enum class | LogCategory |
enum class | NodeIdType : uint8_t |
enum class | VariantPolicy |
enum class | ExtensionObjectEncoding |
enum class | DataTypeId : int32_t |
enum class | ReferenceTypeId : int32_t |
enum class | ObjectTypeId : int32_t |
enum class | VariableTypeId : int32_t |
enum class | ObjectId : int32_t |
enum class | VariableId : int32_t |
enum class | MethodId : int32_t |
enum class | MessageSecurityMode : int32_t |
enum class | UserTokenType : int32_t |
enum class | NodeAttributesMask : uint32_t |
enum class | BrowseDirection : int32_t |
enum class | BrowseResultMask : uint32_t |
enum class | TimestampsToReturn : int32_t |
enum class | MonitoringMode : int32_t |
enum class | FilterOperator : int32_t |
enum class | DataChangeTrigger : int32_t |
enum class | DeadbandType : int32_t |
enum class | PerformUpdateType : int32_t |
enum class | StructureType : int32_t |
Functions | |
template<typename T , typename Initiation , typename CompletionToken , typename... Args> | |
auto | asyncInitiate (Initiation &&initiation, CompletionToken &&token, Args &&... args) |
template<typename T > | |
constexpr std::false_type | isBitmaskEnum (T) |
constexpr void | throwIfBad (UA_StatusCode code) |
CreateCertificateResult | createCertificate (Span< const String > subject, Span< const String > subjectAltName, CertificateFormat certificateFormat=CertificateFormat::DER) |
template<typename T > | |
const UA_DataType & | getDataType () noexcept |
constexpr Namespace | namespaceOf (DataTypeId) noexcept |
constexpr Namespace | namespaceOf (ReferenceTypeId) noexcept |
constexpr Namespace | namespaceOf (ObjectTypeId) noexcept |
constexpr Namespace | namespaceOf (VariableTypeId) noexcept |
constexpr Namespace | namespaceOf (ObjectId) noexcept |
constexpr Namespace | namespaceOf (VariableId) noexcept |
constexpr Namespace | namespaceOf (MethodId) noexcept |
constexpr std::true_type | isBitmaskEnum (NodeAttributesMask) |
constexpr std::true_type | isBitmaskEnum (BrowseResultMask) |
ContentFilter | operator&& (const ContentFilterElement &lhs, const ContentFilter &rhs) |
ContentFilter | operator&& (const ContentFilter &lhs, const ContentFilterElement &rhs) |
ContentFilter | operator|| (const ContentFilterElement &lhs, const ContentFilter &rhs) |
ContentFilter | operator|| (const ContentFilter &lhs, const ContentFilterElement &rhs) |
template<typename T > | |
constexpr std::enable_if_t< IsBitmaskEnum< T >::value, T > | operator& (T lhs, T rhs) noexcept |
template<typename T > | |
constexpr std::enable_if_t< IsBitmaskEnum< T >::value, T > | operator| (T lhs, T rhs) noexcept |
template<typename T > | |
constexpr std::enable_if_t< IsBitmaskEnum< T >::value, T > | operator^ (T lhs, T rhs) noexcept |
template<typename T > | |
constexpr std::enable_if_t< IsBitmaskEnum< T >::value, T > | operator~ (T rhs) noexcept |
template<typename T > | |
constexpr std::enable_if_t< IsBitmaskEnum< T >::value, T > | operator|= (T &lhs, T rhs) noexcept |
template<typename T > | |
constexpr std::enable_if_t< IsBitmaskEnum< T >::value, T > | operator&= (T &lhs, T rhs) noexcept |
template<typename T > | |
constexpr std::enable_if_t< IsBitmaskEnum< T >::value, T > | operator^= (T &lhs, T rhs) noexcept |
template<typename T , typename U > | |
constexpr bool | operator== (Bitmask< T > lhs, U rhs) noexcept |
template<typename T , typename U > | |
constexpr bool | operator!= (Bitmask< T > lhs, U rhs) noexcept |
template<typename T , typename U > | |
constexpr bool | operator== (U lhs, Bitmask< T > rhs) noexcept |
template<typename T , typename U > | |
constexpr bool | operator!= (U lhs, Bitmask< T > rhs) noexcept |
Client * | asWrapper (UA_Client *client) noexcept |
bool | operator== (const Client &lhs, const Client &rhs) noexcept |
bool | operator!= (const Client &lhs, const Client &rhs) noexcept |
bool | operator== (const UA_DataType &lhs, const UA_DataType &rhs) noexcept |
bool | operator!= (const UA_DataType &lhs, const UA_DataType &rhs) noexcept |
bool | operator== (const UA_DataTypeMember &lhs, const UA_DataTypeMember &rhs) noexcept |
bool | operator!= (const UA_DataTypeMember &lhs, const UA_DataTypeMember &rhs) noexcept |
bool | operator== (const Event &lhs, const Event &rhs) noexcept |
bool | operator!= (const Event &lhs, const Event &rhs) noexcept |
template<typename T > | |
bool | operator== (const MonitoredItem< T > &lhs, const MonitoredItem< T > &rhs) noexcept |
template<typename T > | |
bool | operator!= (const MonitoredItem< T > &lhs, const MonitoredItem< T > &rhs) noexcept |
template<typename Connection > | |
bool | operator== (const Node< Connection > &lhs, const Node< Connection > &rhs) noexcept |
template<typename Connection > | |
bool | operator!= (const Node< Connection > &lhs, const Node< Connection > &rhs) noexcept |
Server * | asWrapper (UA_Server *server) noexcept |
bool | operator== (const Server &lhs, const Server &rhs) noexcept |
bool | operator!= (const Server &lhs, const Server &rhs) noexcept |
bool | operator== (const Session &lhs, const Session &rhs) noexcept |
bool | operator!= (const Session &lhs, const Session &rhs) noexcept |
template<typename Container > | |
Span (Container &) -> Span< typename Container::value_type > | |
template<typename Container > | |
Span (const Container &) -> Span< const typename Container::value_type > | |
template<typename T , typename U , typename = detail::EnableIfEqualityComparable<T, U>> | |
constexpr bool | operator== (Span< T > lhs, Span< U > rhs) |
template<typename T , typename U , typename = detail::EnableIfEqualityComparable<T, U>> | |
constexpr bool | operator!= (Span< T > lhs, Span< U > rhs) |
template<typename T > | |
bool | operator== (const Subscription< T > &lhs, const Subscription< T > &rhs) noexcept |
template<typename T > | |
bool | operator!= (const Subscription< T > &lhs, const Subscription< T > &rhs) noexcept |
bool | operator== (const UA_String &lhs, const UA_String &rhs) noexcept |
bool | operator!= (const UA_String &lhs, const UA_String &rhs) noexcept |
bool | operator== (const String &lhs, std::string_view rhs) noexcept |
bool | operator!= (const String &lhs, std::string_view rhs) noexcept |
bool | operator== (std::string_view lhs, const String &rhs) noexcept |
bool | operator!= (std::string_view lhs, const String &rhs) noexcept |
std::ostream & | operator<< (std::ostream &os, const String &str) |
bool | operator== (const UA_Guid &lhs, const UA_Guid &rhs) noexcept |
bool | operator!= (const UA_Guid &lhs, const UA_Guid &rhs) noexcept |
std::ostream & | operator<< (std::ostream &os, const Guid &guid) |
bool | operator== (const ByteString &lhs, std::string_view rhs) noexcept |
bool | operator!= (const ByteString &lhs, std::string_view rhs) noexcept |
bool | operator== (std::string_view lhs, const ByteString &rhs) noexcept |
bool | operator!= (std::string_view lhs, const ByteString &rhs) noexcept |
std::ostream & | operator<< (std::ostream &os, const XmlElement &xmlElement) |
bool | operator== (const UA_NodeId &lhs, const UA_NodeId &rhs) noexcept |
bool | operator!= (const UA_NodeId &lhs, const UA_NodeId &rhs) noexcept |
bool | operator< (const UA_NodeId &lhs, const UA_NodeId &rhs) noexcept |
bool | operator> (const UA_NodeId &lhs, const UA_NodeId &rhs) noexcept |
bool | operator<= (const UA_NodeId &lhs, const UA_NodeId &rhs) noexcept |
bool | operator>= (const UA_NodeId &lhs, const UA_NodeId &rhs) noexcept |
bool | operator== (const UA_ExpandedNodeId &lhs, const UA_ExpandedNodeId &rhs) noexcept |
bool | operator!= (const UA_ExpandedNodeId &lhs, const UA_ExpandedNodeId &rhs) noexcept |
bool | operator< (const UA_ExpandedNodeId &lhs, const UA_ExpandedNodeId &rhs) noexcept |
bool | operator> (const UA_ExpandedNodeId &lhs, const UA_ExpandedNodeId &rhs) noexcept |
bool | operator<= (const UA_ExpandedNodeId &lhs, const UA_ExpandedNodeId &rhs) noexcept |
bool | operator>= (const UA_ExpandedNodeId &lhs, const UA_ExpandedNodeId &rhs) noexcept |
bool | operator== (const UA_QualifiedName &lhs, const UA_QualifiedName &rhs) noexcept |
bool | operator!= (const UA_QualifiedName &lhs, const UA_QualifiedName &rhs) noexcept |
bool | operator== (const UA_LocalizedText &lhs, const UA_LocalizedText &rhs) noexcept |
bool | operator!= (const UA_LocalizedText &lhs, const UA_LocalizedText &rhs) noexcept |
bool | operator== (const NumericRangeDimension &lhs, const NumericRangeDimension &rhs) noexcept |
bool | operator!= (const NumericRangeDimension &lhs, const NumericRangeDimension &rhs) noexcept |
ContentFilter | operator! (const ContentFilterElement &filterElement) |
ContentFilter | operator! (const ContentFilter &filter) |
ContentFilter | operator&& (const ContentFilterElement &lhs, const ContentFilterElement &rhs) |
ContentFilter | operator&& (const ContentFilterElement &lhs, const ContentFilter &rhs) |
ContentFilter | operator&& (const ContentFilter &lhs, const ContentFilterElement &rhs) |
ContentFilter | operator&& (const ContentFilter &lhs, const ContentFilter &rhs) |
ContentFilter | operator|| (const ContentFilterElement &lhs, const ContentFilterElement &rhs) |
ContentFilter | operator|| (const ContentFilterElement &lhs, const ContentFilter &rhs) |
ContentFilter | operator|| (const ContentFilter &lhs, const ContentFilterElement &rhs) |
ContentFilter | operator|| (const ContentFilter &lhs, const ContentFilter &rhs) |
Variables | |
constexpr UseFutureToken | useFuture |
constexpr UseDeferredToken | useDeferred |
constexpr UseDetachedToken | useDetached |
using opcua::StateCallback = std::function<void()> |
Definition at line 101 of file client.hpp.
using opcua::InactivityCallback = std::function<void()> |
Definition at line 102 of file client.hpp.
using opcua::SubscriptionInactivityCallback = std::function<void(IntegerId subscriptionId)> |
Definition at line 103 of file client.hpp.
using opcua::NamespaceIndex = uint16_t |
Namespace index.
Definition at line 12 of file common.hpp.
using opcua::TypeIndex = uint16_t |
Type index of the UA_TYPES array.
Definition at line 21 of file common.hpp.
Definition at line 22 of file datatype.hpp.
typedef services::MonitoringParametersEx opcua::MonitoringParametersEx = services::MonitoringParametersEx |
Definition at line 17 of file monitoreditem.hpp.
using opcua::LogFunction = std::function<void(LogLevel, LogCategory, std::string_view msg)> |
Log function.
Definition at line 11 of file log_default.hpp.
Definition at line 21 of file subscription.hpp.
Definition at line 23 of file subscription.hpp.
Definition at line 24 of file subscription.hpp.
|
strong |
Attribute identifiers.
Enumerator | |
---|---|
NodeId | Unambiguous identifier of a node. |
NodeClass | Identifies the class of the node. |
BrowseName | A non-localised human-readable name used to browse the address space. The browse name of a reference type must be unique in a server. |
DisplayName | The localized name of the node. |
Description | Explains the meaning of the node in a localized text. |
WriteMask | Exposes the possibilities of a client to write the attributes of the node. |
UserWriteMask | Exposes the possibilities of a client to write the attributes of the node. In contrast to the write mask, the user write mask is taking access rights into account. |
IsAbstract | If a reference is abstract, no reference of this type shall exist, only of its subtypes. |
Symmetric | If a reference is symmetric, it can seen from both the source and target node. |
InverseName | The inverse name describes the reference type as seen from the target node. For example, the reference type |
ContainsNoLoops | Indicates that by following the references in the context of the view there are no loops. |
EventNotifier | Indicates if the node can be used to subscribe to events or the read/write historic events. |
Value | The most recent value of the variable that the server has. |
DataType | The NodeId of the data type definition for the |
ValueRank | Indicates whether the
|
ArrayDimensions | Specifies the maximum supported length of each dimension of the Should be unspecified if |
AccessLevel | Indicate how the value of a variable can be accessed (read/write) and if it contains current and/or historic data. |
UserAccessLevel | Indicates how the value of a variable can be accessed (read/write) and if it contains current and/or historic data. In contrast to the |
MinimumSamplingInterval | Specifies (in milliseconds) how fast the server can reasonably sample the value for changes. A minimum sampling interval of |
Historizing | Indicates whether the server is actively collecting data for the history of the variable. |
Executable | Indicates if the method is currently executable. |
UserExecutable | Indicates if the method is currently executable taking user access rights into account. |
DataTypeDefinition | Provides the meta data and encoding information for custom data types. |
RolePermissions | Permissions that apply to a node. |
UserRolePermissions | Specifies the permissions that apply to a node for all roles granted to current session. |
AccessRestrictions | Specifies access restrictions that apply to a node. |
AccessLevelEx | Extended version of the |
Definition at line 28 of file common.hpp.
|
strong |
Node class.
The enum can be used as a bitmask and allows bitwise operations, e.g.:
Enumerator | |
---|---|
Unspecified | |
Object | |
Variable | |
Method | |
ObjectType | |
VariableType | |
ReferenceType | |
DataType | |
View |
Definition at line 111 of file common.hpp.
|
strong |
Access level.
Indicates how the value of an variable can be accessed (read/write) and if it contains current and/or historic data.
Enumerator | |
---|---|
None | |
CurrentRead | |
CurrentWrite | |
HistoryRead | |
HistoryWrite | |
SemanticChange | |
StatusWrite | |
TimestampWrite |
Definition at line 134 of file common.hpp.
|
strong |
Write mask.
Indicates which attributes of a node a writeable.
Definition at line 156 of file common.hpp.
|
strong |
Value rank.
Indicates whether the value attribute of the variable is an array and how many dimensions the array has.
Enumerator | |
---|---|
ScalarOrOneDimension | |
Any | |
Scalar | |
OneOrMoreDimensions | |
OneDimension | |
TwoDimensions | |
ThreeDimensions |
Definition at line 197 of file common.hpp.
|
strong |
Event notifier.
Indicates if a node can be used to subscribe to events or read/write historic events.
Enumerator | |
---|---|
None | |
SubscribeToEvents | |
HistoryRead | |
HistoryWrite |
Definition at line 214 of file common.hpp.
|
strong |
Modelling rules.
Enumerator | |
---|---|
Mandatory | |
Optional | |
ExposesItsArray | |
OptionalPlaceholder | |
MandatoryPlaceholder |
Definition at line 230 of file common.hpp.
|
strong |
Enumerator | |
---|---|
DER | |
PEM |
Definition at line 11 of file create_certificate.hpp.
|
strong |
|
strong |
Log category.
Enumerator | |
---|---|
Network | |
SecureChannel | |
Session | |
Server | |
Client | |
Userland | |
SecurityPolicy |
|
strong |
|
strong |
Policies for variant factory methods Variant::fromScalar, Variant::fromArray.
|
strong |
Extension object encoding.
Enumerator | |
---|---|
EncodedNoBody | |
EncodedByteString | |
EncodedXml | |
Decoded | |
DecodedNoDelete |
|
constexpr |
Check the status code and throw a BadStatus exception if the status code is bad.
Definition at line 85 of file exception.hpp.
Referenced by opcua::services::createMonitoredItemsDataChangeAsync(), opcua::services::createMonitoredItemsEventAsync(), opcua::services::deleteMonitoredItemsAsync(), opcua::services::deleteSubscriptionsAsync(), opcua::services::modifyMonitoredItemsAsync(), opcua::services::modifySubscriptionAsync(), and opcua::StatusCode::throwIfBad().
CreateCertificateResult opcua::createCertificate | ( | Span< const String > | subject, |
Span< const String > | subjectAltName, | ||
CertificateFormat | certificateFormat = CertificateFormat::DER ) |
Create a self-signed X.509 v3 certificate.
It is recommended to store the generated certificate on disk for reuse, so the application can be recognized across several executions.
subject | Elements for the subject, e.g. {"C=DE", "O=SampleOrganization", "CN=Open62541Server@localhost"} |
subjectAltName | Elements for SubjectAltName, e.g. {"DNS:localhost", "URI:urn:open62541.server.application"} |
certificateFormat | Certificate format, either DER or PEM |
BadStatus | (BadOutOfMemory) |
CreateCertificateError |
|
noexcept |
Definition at line 46 of file typeregistry.hpp.
Referenced by opcua::Variant::assign(), opcua::Variant::assign(), opcua::Variant::assign(), opcua::Variant::isType(), opcua::ua::VariableAttributes::setDataType(), opcua::ua::VariableTypeAttributes::setDataType(), and opcua::Node< Connection >::writeDataType().