ANSI C Based OPC UA Client/Server SDK
1.8.3.398
|
Data Structures | |
struct | UaServer_SimpleBrowsePath |
Helper struct for browse paths. More... | |
struct | UaServer_EventField |
Helper struct for event fields. More... | |
struct | UaServer_Event |
An actual event. More... | |
Functions | |
OpcUa_StatusCode | UaServer_EventField_Initialize (UaServer_EventField *pValue) |
Initialize the passed UaServer_EventField. More... | |
OpcUa_Void | UaServer_EventField_Clear (UaServer_EventField *pValue) |
Clear the passed UaServer_EventField. More... | |
OpcUa_StatusCode | UaServer_Events_RegisterEventType (OpcUa_NodeId *a_pEventTypeId, OpcUa_NodeId *a_pParentEventTypeId) |
Registers a new event type. More... | |
OpcUa_Int32 | UaServer_Events_RegisterEventField (OpcUa_NodeId *a_pEventTypeId, UaServer_EventField *a_pEventField) |
Registers an EventField. More... | |
OpcUa_StatusCode | UaServer_Events_UnregisterEventType (OpcUa_NodeId *a_pEventTypeId) |
Unregisters an existing event type. More... | |
UaServer_Event * | UaServer_Events_CreateEvent (OpcUa_NodeId *a_pEventTypeId) |
Creates a new event structure configured for the given event type. More... | |
OpcUa_Void | UaServer_Events_DeleteEvent (UaServer_Event **a_ppEvent) |
Deletes an event structure created with UaServer_Events_CreateEvent. More... | |
OpcUa_StatusCode | UaServer_Events_SetEventField (UaServer_Event *a_pEvent, OpcUa_UInt32 a_LocalIndex, OpcUa_Variant *a_pValue) |
Sets an event field value. More... | |
OpcUa_StatusCode | UaServer_Events_AttachEventField (UaServer_Event *a_pEvent, OpcUa_UInt32 a_LocalIndex, OpcUa_Variant *a_pValue) |
Sets an event field value. More... | |
OpcUa_Variant * | UaServer_Events_GetEventField (UaServer_Event *a_pEvent, OpcUa_Int a_LocalIndex) |
Gets an event field value. More... | |
OpcUa_Variant * | UaServer_Events_GetEventFieldByPath (UaServer_Event *a_pEvent, UaServer_SimpleBrowsePath *a_pPath) |
Gets an event field value based on its browse path. More... | |
OpcUa_Int | UaServer_Events_GetLocalIndexByPath (UaServer_Event *a_pEvent, UaServer_SimpleBrowsePath *a_pPath) |
Gets the local index of an event field. More... | |
OpcUa_StatusCode | UaServer_Events_FireEvent (UaServer_Event *a_pEvent) |
FireEvent method used by providers to fire a event. More... | |
OpcUa_StatusCode | UaServer_Events_RegisterEventNotifier (OpcUa_NodeId *a_pEventNotifier, OpcUa_NodeId *a_pParentNotifier) |
Registers a new EventNotifier. More... | |
OpcUa_StatusCode | UaServer_Events_RegisterEventSource (OpcUa_NodeId *a_pEventSource, OpcUa_NodeId *a_pParentNotifier) |
Registers a new EventSource. More... | |
OpcUa_StatusCode | UaServer_Events_UnregisterEventNotifier (OpcUa_NodeId *a_pEventNotifier) |
Unregisters an existing EventNotifier. More... | |
OpcUa_StatusCode | UaServer_Events_UnregisterEventSource (OpcUa_NodeId *a_pEventSource) |
Unregisters an existing EventSource. More... | |
OpcUa_ByteString * | UaServer_Events_GetEventId (UaServer_Event *a_pEvent) |
Optimized method for returning the EventId. More... | |
OpcUa_NodeId * | UaServer_Events_GetEventType (UaServer_Event *a_pEvent) |
Optimized method for returning the EventType. More... | |
OpcUa_NodeId * | UaServer_Events_GetSourceNode (UaServer_Event *a_pEvent) |
Optimized method for returning the SourceNode. More... | |
OpcUa_String * | UaServer_Events_GetSourceName (UaServer_Event *a_pEvent) |
Optimized method for returning the SourceName. More... | |
OpcUa_DateTime | UaServer_Events_GetTime (UaServer_Event *a_pEvent) |
Optimized method for returning the Time. More... | |
OpcUa_DateTime | UaServer_Events_GetReceiveTime (UaServer_Event *a_pEvent) |
Optimized method for returning the ReceiveTime. More... | |
OpcUa_TimeZoneDataType * | UaServer_Events_GetLocalTime (UaServer_Event *a_pEvent) |
Optimized method for returning the LocalTime. More... | |
OpcUa_LocalizedText * | UaServer_Events_GetMessage (UaServer_Event *a_pEvent) |
Optimized method for returning the Message. More... | |
OpcUa_UInt16 | UaServer_Events_GetSeverity (UaServer_Event *a_pEvent) |
Optimized method for returning the Severity. More... | |
OpcUa_StatusCode | UaServer_Events_SetEventId (UaServer_Event *a_pEvent, OpcUa_ByteString *a_pEventId) |
Optimized method for setting the EventId. More... | |
OpcUa_StatusCode | UaServer_Events_SetEventType (UaServer_Event *a_pEvent, OpcUa_NodeId *a_pEventType) |
Optimized method for setting the EventType. More... | |
OpcUa_StatusCode | UaServer_Events_SetSourceNode (UaServer_Event *a_pEvent, OpcUa_NodeId *a_pSourceNode) |
Optimized method for setting the SourceNode. More... | |
OpcUa_StatusCode | UaServer_Events_SetSourceName (UaServer_Event *a_pEvent, const OpcUa_CharA *a_sourceName) |
Optimized method for setting the SourceName. More... | |
OpcUa_StatusCode | UaServer_Events_SetTime (UaServer_Event *a_pEvent, OpcUa_DateTime a_time) |
Optimized method for setting the Time. More... | |
OpcUa_StatusCode | UaServer_Events_SetReceiveTime (UaServer_Event *a_pEvent, OpcUa_DateTime a_receiveTime) |
Optimized method for setting the ReceiveTime. More... | |
OpcUa_StatusCode | UaServer_Events_SetLocalTime (UaServer_Event *a_pEvent, OpcUa_TimeZoneDataType *a_localTime) |
Optimized method for setting the LocalTime. More... | |
OpcUa_StatusCode | UaServer_Events_SetMessage (UaServer_Event *a_pEvent, const OpcUa_CharA *a_locale, const OpcUa_CharA *a_message) |
Optimized method for setting the Message. More... | |
OpcUa_StatusCode | UaServer_Events_SetSeverity (UaServer_Event *a_pEvent, OpcUa_UInt16 a_severity) |
Optimized method for setting the Severity. More... | |
OpcUa_StatusCode | UaServer_Events_CreateEventId (const OpcUa_ByteString *a_pUserEventId, OpcUa_ByteString *a_pNewEventId) |
Create an unique EventId and include a user specific part if provided. More... | |
OpcUa_StatusCode | UaServer_Events_GetUserEventId (const OpcUa_ByteString *a_pEventId, OpcUa_ByteString *a_pUserEventId) |
Gets the user specific part of an EventId that was created by UaServer_Events_CreateEventId. More... | |
UaServer_Event * | UaServer_Events_GetConditionByNodeId (OpcUa_UInt16 a_providerNsIdx, const OpcUa_NodeId *a_pNodeId) |
Searches for a condition type event of a certain provider with the given condition NodeId. More... | |
OpcUa_StatusCode | UaServer_Events_ApplyHistoryReadFilter (OpcUa_EventFilter *a_pRecordingEventFilter, OpcUa_EventFilter *a_pHistoryReadEventFilter, OpcUa_HistoryReadResult *a_pHistoryReadResult, UaServer_Session *a_pSession) |
Apply the HistoryRead event filter on data received from a data logger. More... | |
OpcUa_Void UaServer_EventField_Clear | ( | UaServer_EventField * | pValue | ) |
Clear the passed UaServer_EventField.
[in] | pValue | The UaServer_EventField to clear |
OpcUa_StatusCode UaServer_EventField_Initialize | ( | UaServer_EventField * | pValue | ) |
Initialize the passed UaServer_EventField.
[in] | pValue | The UaServer_EventField to initialize |
OpcUa_StatusCode UaServer_Events_ApplyHistoryReadFilter | ( | OpcUa_EventFilter * | a_pRecordingEventFilter, |
OpcUa_EventFilter * | a_pHistoryReadEventFilter, | ||
OpcUa_HistoryReadResult * | a_pHistoryReadResult, | ||
UaServer_Session * | a_pSession | ||
) |
Apply the HistoryRead event filter on data received from a data logger.
Data read out from a data logger will be filtered and reordered to match the event filter passed by the client in the HistoryRead request.
a_pRecordingEventFilter | The event filter that was used for logging the event history. |
a_pHistoryReadEventFilter | The event filter that was passed by the client in the HistoryRead request. |
a_pHistoryReadResult | The historical event data returned by the data logger. Size and order of the HistoryEventFieldLists has to match the SelectClause of a_pRecordingEventFilter. |
a_pSession | The session that issued the HistoryRead request. |
OpcUa_StatusCode UaServer_Events_AttachEventField | ( | UaServer_Event * | a_pEvent, |
OpcUa_UInt32 | a_LocalIndex, | ||
OpcUa_Variant * | a_pValue | ||
) |
Sets an event field value.
Used by providers to fill events.
[in] | a_pEvent | Pointer to event structure. |
[in] | a_LocalIndex | Index which identifies the event field. |
[in] | a_pValue | The event field value to set |
UaServer_Event * UaServer_Events_CreateEvent | ( | OpcUa_NodeId * | a_pEventTypeId | ) |
Creates a new event structure configured for the given event type.
[in] | a_pEventTypeId | The NodeId of the event type |
OpcUa_StatusCode UaServer_Events_CreateEventId | ( | const OpcUa_ByteString * | a_pUserEventId, |
OpcUa_ByteString * | a_pNewEventId | ||
) |
Create an unique EventId and include a user specific part if provided.
[in] | a_pUserEventId | Optional: User specific part that can be retrieved by UaServer_Events_GetUserEventId. |
[in] | a_pNewEventId | The new EventId. The caller is responsible for clearing it. |
OpcUa_Void UaServer_Events_DeleteEvent | ( | UaServer_Event ** | a_ppEvent | ) |
Deletes an event structure created with UaServer_Events_CreateEvent.
[in,out] | a_ppEvent | The event to delete |
OpcUa_StatusCode UaServer_Events_FireEvent | ( | UaServer_Event * | a_pEvent | ) |
FireEvent method used by providers to fire a event.
All subscriptions of all clients get notified.
[in] | a_pEvent | The event to fire. |
UaServer_Event * UaServer_Events_GetConditionByNodeId | ( | OpcUa_UInt16 | a_providerNsIdx, |
const OpcUa_NodeId * | a_pNodeId | ||
) |
Searches for a condition type event of a certain provider with the given condition NodeId.
This function was introduced in version 1.2.1.
[in] | a_providerNsIdx | The namespace index of the provider the event belongs to. |
[in] | a_pNodeId | The condition NodeId of the condition. |
OpcUa_Variant * UaServer_Events_GetEventField | ( | UaServer_Event * | a_pEvent, |
OpcUa_Int | a_LocalIndex | ||
) |
Gets an event field value.
[in] | a_pEvent | Pointer to event structure. |
[in] | a_LocalIndex | The local index which identifies the EventField |
OpcUa_Variant * UaServer_Events_GetEventFieldByPath | ( | UaServer_Event * | a_pEvent, |
UaServer_SimpleBrowsePath * | a_pPath | ||
) |
Gets an event field value based on its browse path.
[in] | a_pEvent | Pointer to event structure. |
[in] | a_pPath | The browse path of the event field |
OpcUa_ByteString * UaServer_Events_GetEventId | ( | UaServer_Event * | a_pEvent | ) |
Optimized method for returning the EventId.
[in] | a_pEvent | Pointer to the event. |
OpcUa_NodeId * UaServer_Events_GetEventType | ( | UaServer_Event * | a_pEvent | ) |
Optimized method for returning the EventType.
[in] | a_pEvent | Pointer to the event. |
OpcUa_Int UaServer_Events_GetLocalIndexByPath | ( | UaServer_Event * | a_pEvent, |
UaServer_SimpleBrowsePath * | a_pPath | ||
) |
Gets the local index of an event field.
[in] | a_pEvent | Pointer to event structure. |
[in] | a_pPath | The browse path of the event field |
OpcUa_TimeZoneDataType * UaServer_Events_GetLocalTime | ( | UaServer_Event * | a_pEvent | ) |
Optimized method for returning the LocalTime.
[in] | a_pEvent | Pointer to the event. |
OpcUa_LocalizedText * UaServer_Events_GetMessage | ( | UaServer_Event * | a_pEvent | ) |
Optimized method for returning the Message.
[in] | a_pEvent | Pointer to the event. |
OpcUa_DateTime UaServer_Events_GetReceiveTime | ( | UaServer_Event * | a_pEvent | ) |
Optimized method for returning the ReceiveTime.
[in] | a_pEvent | Pointer to the event. |
OpcUa_UInt16 UaServer_Events_GetSeverity | ( | UaServer_Event * | a_pEvent | ) |
Optimized method for returning the Severity.
[in] | a_pEvent | Pointer to the event. |
OpcUa_String * UaServer_Events_GetSourceName | ( | UaServer_Event * | a_pEvent | ) |
Optimized method for returning the SourceName.
[in] | a_pEvent | Pointer to the event. |
OpcUa_NodeId * UaServer_Events_GetSourceNode | ( | UaServer_Event * | a_pEvent | ) |
Optimized method for returning the SourceNode.
[in] | a_pEvent | Pointer to the event. |
OpcUa_DateTime UaServer_Events_GetTime | ( | UaServer_Event * | a_pEvent | ) |
Optimized method for returning the Time.
[in] | a_pEvent | Pointer to the event. |
OpcUa_StatusCode UaServer_Events_GetUserEventId | ( | const OpcUa_ByteString * | a_pEventId, |
OpcUa_ByteString * | a_pUserEventId | ||
) |
Gets the user specific part of an EventId that was created by UaServer_Events_CreateEventId.
[in] | a_pEventId | The EventId to use. |
[in] | a_pUserEventId | A copy of the user part of the EventId. The caller is responsible for clearing it. |
OpcUa_Int32 UaServer_Events_RegisterEventField | ( | OpcUa_NodeId * | a_pEventTypeId, |
UaServer_EventField * | a_pEventField | ||
) |
Registers an EventField.
[in] | a_pEventTypeId | The EventType the EventField belongs to. |
[in] | a_pEventField | Structure defining the new EventField. |
OpcUa_StatusCode UaServer_Events_RegisterEventNotifier | ( | OpcUa_NodeId * | a_pEventNotifier, |
OpcUa_NodeId * | a_pParentNotifier | ||
) |
Registers a new EventNotifier.
The notifier will be inserted in the internal area tree as a child of a_pParentNotifier.
[in] | a_pEventNotifier | The NodeId of the new EventNotifier. |
[in] | a_pParentNotifier | The NodeId of an existing EventNotifier the new notifier will be added to as child. |
OpcUa_StatusCode UaServer_Events_RegisterEventSource | ( | OpcUa_NodeId * | a_pEventSource, |
OpcUa_NodeId * | a_pParentNotifier | ||
) |
Registers a new EventSource.
The event source will be inserted in the internal area tree as a child of a_pParentNotifier. EventSources need to be registered in order to filter out events in UaServer_Events_IsEventSourceInArea.
[in] | a_pEventSource | The NodeId of the new EventSource. |
[in] | a_pParentNotifier | The NodeId of an existing EventNotifier the new event source will be added to as child. |
OpcUa_StatusCode UaServer_Events_RegisterEventType | ( | OpcUa_NodeId * | a_pEventTypeId, |
OpcUa_NodeId * | a_pParentEventTypeId | ||
) |
Registers a new event type.
[in] | a_pEventTypeId | The NodeId of the new event type |
[in] | a_pParentEventTypeId | The NodeId of the new event's parent type |
OpcUa_StatusCode UaServer_Events_SetEventField | ( | UaServer_Event * | a_pEvent, |
OpcUa_UInt32 | a_LocalIndex, | ||
OpcUa_Variant * | a_pValue | ||
) |
Sets an event field value.
Used by providers to fill events.
[in] | a_pEvent | Pointer to event structure. |
[in] | a_LocalIndex | Index which identifies the event field. |
[in] | a_pValue | The event field value to set |
OpcUa_StatusCode UaServer_Events_SetEventId | ( | UaServer_Event * | a_pEvent, |
OpcUa_ByteString * | a_pEventId | ||
) |
Optimized method for setting the EventId.
To ensure that an unique EventId is used, the EventId should be created with UaServer_Events_CreateEventId.
[in] | a_pEvent | Pointer to the event. |
[in] | a_pEventId | The new EventId to set. |
OpcUa_StatusCode UaServer_Events_SetEventType | ( | UaServer_Event * | a_pEvent, |
OpcUa_NodeId * | a_pEventType | ||
) |
Optimized method for setting the EventType.
[in] | a_pEvent | Pointer to the event. |
[in] | a_pEventType | The new EventType to set. |
OpcUa_StatusCode UaServer_Events_SetLocalTime | ( | UaServer_Event * | a_pEvent, |
OpcUa_TimeZoneDataType * | a_localTime | ||
) |
Optimized method for setting the LocalTime.
[in] | a_pEvent | Pointer to the event. |
[in] | a_localTime | The new LocalTime to set. |
OpcUa_StatusCode UaServer_Events_SetMessage | ( | UaServer_Event * | a_pEvent, |
const OpcUa_CharA * | a_locale, | ||
const OpcUa_CharA * | a_message | ||
) |
Optimized method for setting the Message.
[in] | a_pEvent | Pointer to the event. |
[in] | a_locale | The locale of the new Message. |
[in] | a_message | The new Message to set. |
OpcUa_StatusCode UaServer_Events_SetReceiveTime | ( | UaServer_Event * | a_pEvent, |
OpcUa_DateTime | a_receiveTime | ||
) |
Optimized method for setting the ReceiveTime.
[in] | a_pEvent | Pointer to the event. |
[in] | a_receiveTime | The new ReceiveTime to set. |
OpcUa_StatusCode UaServer_Events_SetSeverity | ( | UaServer_Event * | a_pEvent, |
OpcUa_UInt16 | a_severity | ||
) |
Optimized method for setting the Severity.
[in] | a_pEvent | Pointer to the event. |
[in] | a_severity | The new Severity to set. |
OpcUa_StatusCode UaServer_Events_SetSourceName | ( | UaServer_Event * | a_pEvent, |
const OpcUa_CharA * | a_sourceName | ||
) |
Optimized method for setting the SourceName.
[in] | a_pEvent | Pointer to the event. |
[in] | a_sourceName | The new SourceName to set. |
OpcUa_StatusCode UaServer_Events_SetSourceNode | ( | UaServer_Event * | a_pEvent, |
OpcUa_NodeId * | a_pSourceNode | ||
) |
Optimized method for setting the SourceNode.
[in] | a_pEvent | Pointer to the event. |
[in] | a_pSourceNode | The new SourceNode to set. |
OpcUa_StatusCode UaServer_Events_SetTime | ( | UaServer_Event * | a_pEvent, |
OpcUa_DateTime | a_time | ||
) |
Optimized method for setting the Time.
[in] | a_pEvent | Pointer to the event. |
[in] | a_time | The new Time to set. |
OpcUa_StatusCode UaServer_Events_UnregisterEventNotifier | ( | OpcUa_NodeId * | a_pEventNotifier | ) |
Unregisters an existing EventNotifier.
All child notifiers and sources will be unregistered recursively.
[in] | a_pEventNotifier | The NodeId of the EventNotifier. |
OpcUa_StatusCode UaServer_Events_UnregisterEventSource | ( | OpcUa_NodeId * | a_pEventSource | ) |
Unregisters an existing EventSource.
[in] | a_pEventSource | The NodeId of the EventSource. |
OpcUa_StatusCode UaServer_Events_UnregisterEventType | ( | OpcUa_NodeId * | a_pEventTypeId | ) |
Unregisters an existing event type.
[in] | a_pEventTypeId | The NodeId of the event type to unregister |