/* This Source Code Form is subject to the terms of the Mozilla Public * License, v. 2.0. If a copy of the MPL was not distributed with this * file, You can obtain one at http://mozilla.org/MPL/2.0/. * * Copyright 2016-2020 (c) Fraunhofer IOSB (Author: Julius Pfrommer) * Copyright 2016 (c) Sten Grüner * Copyright 2016-2017 (c) Stefan Profanter, fortiss GmbH * Copyright 2017 (c) Florian Palm * Copyright 2020 (c) HMS Industrial Networks AB (Author: Jonas Green) */ #ifndef UA_COMMON_H_ #define UA_COMMON_H_ #include #include _UA_BEGIN_DECLS /** * Common Definitions * ================== * * Common definitions for Client, Server and PubSub. * * .. _attribute-id: * * Attribute Id * ------------ * Every node in an OPC UA information model contains attributes depending on * the node type. Possible attributes are as follows: */ typedef enum { UA_ATTRIBUTEID_NODEID = 1, UA_ATTRIBUTEID_NODECLASS = 2, UA_ATTRIBUTEID_BROWSENAME = 3, UA_ATTRIBUTEID_DISPLAYNAME = 4, UA_ATTRIBUTEID_DESCRIPTION = 5, UA_ATTRIBUTEID_WRITEMASK = 6, UA_ATTRIBUTEID_USERWRITEMASK = 7, UA_ATTRIBUTEID_ISABSTRACT = 8, UA_ATTRIBUTEID_SYMMETRIC = 9, UA_ATTRIBUTEID_INVERSENAME = 10, UA_ATTRIBUTEID_CONTAINSNOLOOPS = 11, UA_ATTRIBUTEID_EVENTNOTIFIER = 12, UA_ATTRIBUTEID_VALUE = 13, UA_ATTRIBUTEID_DATATYPE = 14, UA_ATTRIBUTEID_VALUERANK = 15, UA_ATTRIBUTEID_ARRAYDIMENSIONS = 16, UA_ATTRIBUTEID_ACCESSLEVEL = 17, UA_ATTRIBUTEID_USERACCESSLEVEL = 18, UA_ATTRIBUTEID_MINIMUMSAMPLINGINTERVAL = 19, UA_ATTRIBUTEID_HISTORIZING = 20, UA_ATTRIBUTEID_EXECUTABLE = 21, UA_ATTRIBUTEID_USEREXECUTABLE = 22, UA_ATTRIBUTEID_DATATYPEDEFINITION = 23, UA_ATTRIBUTEID_ROLEPERMISSIONS = 24, UA_ATTRIBUTEID_USERROLEPERMISSIONS = 25, UA_ATTRIBUTEID_ACCESSRESTRICTIONS = 26, UA_ATTRIBUTEID_ACCESSLEVELEX = 27 } UA_AttributeId; /** * .. _access-level-mask: * * Access Level Masks * ------------------ * The access level to a node is given by the following constants that are ANDed * with the overall access level. */ #define UA_ACCESSLEVELMASK_READ (0x01u << 0u) #define UA_ACCESSLEVELMASK_WRITE (0x01u << 1u) #define UA_ACCESSLEVELMASK_HISTORYREAD (0x01u << 2u) #define UA_ACCESSLEVELMASK_HISTORYWRITE (0x01u << 3u) #define UA_ACCESSLEVELMASK_SEMANTICCHANGE (0x01u << 4u) #define UA_ACCESSLEVELMASK_STATUSWRITE (0x01u << 5u) #define UA_ACCESSLEVELMASK_TIMESTAMPWRITE (0x01u << 6u) /** * .. _write-mask: * * Write Masks * ----------- * The write mask and user write mask is given by the following constants that * are ANDed for the overall write mask. Part 3: 5.2.7 Table 2 */ #define UA_WRITEMASK_ACCESSLEVEL (0x01u << 0u) #define UA_WRITEMASK_ARRRAYDIMENSIONS (0x01u << 1u) #define UA_WRITEMASK_BROWSENAME (0x01u << 2u) #define UA_WRITEMASK_CONTAINSNOLOOPS (0x01u << 3u) #define UA_WRITEMASK_DATATYPE (0x01u << 4u) #define UA_WRITEMASK_DESCRIPTION (0x01u << 5u) #define UA_WRITEMASK_DISPLAYNAME (0x01u << 6u) #define UA_WRITEMASK_EVENTNOTIFIER (0x01u << 7u) #define UA_WRITEMASK_EXECUTABLE (0x01u << 8u) #define UA_WRITEMASK_HISTORIZING (0x01u << 9u) #define UA_WRITEMASK_INVERSENAME (0x01u << 10u) #define UA_WRITEMASK_ISABSTRACT (0x01u << 11u) #define UA_WRITEMASK_MINIMUMSAMPLINGINTERVAL (0x01u << 12u) #define UA_WRITEMASK_NODECLASS (0x01u << 13u) #define UA_WRITEMASK_NODEID (0x01u << 14u) #define UA_WRITEMASK_SYMMETRIC (0x01u << 15u) #define UA_WRITEMASK_USERACCESSLEVEL (0x01u << 16u) #define UA_WRITEMASK_USEREXECUTABLE (0x01u << 17u) #define UA_WRITEMASK_USERWRITEMASK (0x01u << 18u) #define UA_WRITEMASK_VALUERANK (0x01u << 19u) #define UA_WRITEMASK_WRITEMASK (0x01u << 20u) #define UA_WRITEMASK_VALUEFORVARIABLETYPE (0x01u << 21u) #define UA_WRITEMASK_ACCESSLEVELEX (0x01u << 25u) /** * .. _valuerank-defines: * * ValueRank * --------- * The following are the most common ValueRanks used for Variables, * VariableTypes and method arguments. ValueRanks higher than 3 are valid as * well (but less common). */ #define UA_VALUERANK_SCALAR_OR_ONE_DIMENSION -3 #define UA_VALUERANK_ANY -2 #define UA_VALUERANK_SCALAR -1 #define UA_VALUERANK_ONE_OR_MORE_DIMENSIONS 0 #define UA_VALUERANK_ONE_DIMENSION 1 #define UA_VALUERANK_TWO_DIMENSIONS 2 #define UA_VALUERANK_THREE_DIMENSIONS 3 /** * .. _eventnotifier: * * EventNotifier * ------------- * The following are the available EventNotifier used for Nodes. * The EventNotifier Attribute is used to indicate if the Node can be used * to subscribe to Events or to read / write historic Events. * Part 3: 5.4 Table 10 */ #define UA_EVENTNOTIFIER_SUBSCRIBE_TO_EVENT (0x01u << 0u) #define UA_EVENTNOTIFIER_HISTORY_READ (0x01u << 2u) #define UA_EVENTNOTIFIER_HISTORY_WRITE (0x01u << 3u) /** * .. _rule-handling: * * Rule Handling * ------------- * * The RuleHanding settings define how error cases that result from rules in the * OPC UA specification shall be handled. The rule handling can be softened, * e.g. to workaround misbehaving implementations or to mitigate the impact of * additional rules that are introduced in later versions of the OPC UA * specification. */ typedef enum { UA_RULEHANDLING_DEFAULT = 0, UA_RULEHANDLING_ABORT, /* Abort the operation and return an error code */ UA_RULEHANDLING_WARN, /* Print a message in the logs and continue */ UA_RULEHANDLING_ACCEPT, /* Continue and disregard the broken rule */ } UA_RuleHandling; /** * Order * ----- * * The Order enum is used to establish an absolute ordering between elements. */ typedef enum { UA_ORDER_LESS = -1, UA_ORDER_EQ = 0, UA_ORDER_MORE = 1 } UA_Order; /** * Connection State * ---------------- */ typedef enum { UA_CONNECTIONSTATE_CLOSED, /* The socket has been closed and the connection * will be deleted */ UA_CONNECTIONSTATE_OPENING, /* The socket is open, but the HEL/ACK handshake * is not done */ UA_CONNECTIONSTATE_ESTABLISHED,/* The socket is open and the connection * configured */ UA_CONNECTIONSTATE_CLOSING /* The socket is closing down */ } UA_ConnectionState; typedef enum { UA_SECURECHANNELSTATE_CLOSED = 0, UA_SECURECHANNELSTATE_REVERSE_LISTENING, UA_SECURECHANNELSTATE_CONNECTING, UA_SECURECHANNELSTATE_CONNECTED, UA_SECURECHANNELSTATE_REVERSE_CONNECTED, UA_SECURECHANNELSTATE_RHE_SENT, UA_SECURECHANNELSTATE_HEL_SENT, UA_SECURECHANNELSTATE_HEL_RECEIVED, UA_SECURECHANNELSTATE_ACK_SENT, UA_SECURECHANNELSTATE_ACK_RECEIVED, UA_SECURECHANNELSTATE_OPN_SENT, UA_SECURECHANNELSTATE_OPEN, UA_SECURECHANNELSTATE_CLOSING, } UA_SecureChannelState; typedef enum { UA_SESSIONSTATE_CLOSED = 0, UA_SESSIONSTATE_CREATE_REQUESTED, UA_SESSIONSTATE_CREATED, UA_SESSIONSTATE_ACTIVATE_REQUESTED, UA_SESSIONSTATE_ACTIVATED, UA_SESSIONSTATE_CLOSING } UA_SessionState; /** * Statistic Counters * ------------------ * * The stack manages statistic counters for SecureChannels and Sessions. * * The Session layer counters are matching the counters of the * ServerDiagnosticsSummaryDataType that are defined in the OPC UA Part 5 * specification. The SecureChannel counters are not defined in the OPC UA spec, * but are harmonized with the Session layer counters if possible. */ typedef enum { UA_SHUTDOWNREASON_CLOSE = 0, UA_SHUTDOWNREASON_REJECT, UA_SHUTDOWNREASON_SECURITYREJECT, UA_SHUTDOWNREASON_TIMEOUT, UA_SHUTDOWNREASON_ABORT, UA_SHUTDOWNREASON_PURGE } UA_ShutdownReason; typedef struct { size_t currentChannelCount; size_t cumulatedChannelCount; size_t rejectedChannelCount; size_t channelTimeoutCount; /* only used by servers */ size_t channelAbortCount; size_t channelPurgeCount; /* only used by servers */ } UA_SecureChannelStatistics; typedef struct { size_t currentSessionCount; size_t cumulatedSessionCount; size_t securityRejectedSessionCount; /* only used by servers */ size_t rejectedSessionCount; size_t sessionTimeoutCount; /* only used by servers */ size_t sessionAbortCount; /* only used by servers */ } UA_SessionStatistics; /** * Lifecycle States * ---------------- * * Generic lifecycle states. The STOPPING state indicates that the lifecycle is * being terminated. But it might take time to (asynchronously) perform a * graceful shutdown. */ typedef enum { UA_LIFECYCLESTATE_STOPPED = 0, UA_LIFECYCLESTATE_STARTED, UA_LIFECYCLESTATE_STOPPING } UA_LifecycleState; /** * Forward Declarations * -------------------- * Opaque pointers used in Client, Server and PubSub. */ struct UA_Server; typedef struct UA_Server UA_Server; struct UA_ServerConfig; typedef struct UA_ServerConfig UA_ServerConfig; typedef void (*UA_ServerCallback)(UA_Server *server, void *data); struct UA_Client; typedef struct UA_Client UA_Client; /** * .. include:: util.rst */ _UA_END_DECLS #endif /* UA_COMMON_H_ */