ANSI C UA Server SDK  1.5.1.313
 All Data Structures Functions Variables Typedefs Enumerations Enumerator Modules Pages
UaServerProviders

Data Structures

struct  UaServer_ProviderBrowseContext
 UaServer Provider BrowseContext Structure. More...
 
struct  UaServer_ProviderTranslateContext
 UaServer Provider TranslateContext Structure. More...
 
struct  UaServer_ProviderRegisterNodesContext
 UaServer Provider RegisterNodes Context Structure. More...
 
struct  UaServer_ProviderUnregisterNodesContext
 UaServer Provider UnregisterNodes Context Structure. More...
 
struct  UaServer_ProviderReadContext
 UaServer Provider ReadContext Structure. More...
 
struct  UaServer_ProviderWriteContext
 UaServer Provider WriteContext Structure. More...
 
struct  UaServer_ProviderHistoryReadEventContext
 UaServer Provider HistoryReadEventContext Structure. More...
 
struct  UaServer_ProviderHistoryReadRawModifiedContext
 UaServer Provider HistoryReadRawModifiedContext Structure. More...
 
struct  UaServer_ProviderHistoryReadProcessedContext
 UaServer Provider HistoryReadProcessedContext Structure. More...
 
struct  UaServer_ProviderHistoryReadAtTimeContext
 UaServer Provider HistoryReadAtTimeContext Structure. More...
 
struct  UaServer_ProviderHistoryUpdateContext
 UaServer Provider HistoryUpdateContext Structure. More...
 
struct  UaServer_ProviderCallContext
 UaServer Provider Call Context Structure. More...
 
struct  UaServer_ProviderSubscribeContext
 UaServer Provider SubscribeContext Structure. More...
 
struct  UaServer_pProviderInterface
 Provider interface table. More...
 
struct  UaServer_Provider
 The internal provider management structure. More...
 

Typedefs

typedef OpcUa_StatusCode(* UaServer_pfProviderCleanup )()
 Provider cleanup function. More...
 
typedef OpcUa_StatusCode(* UaServer_pfProviderBrowseAsync )(UaServer_ProviderBrowseContext *a_pBrowseContext)
 Provider browse function. More...
 
typedef OpcUa_StatusCode(* UaServer_pfProviderTranslateAsync )(UaServer_ProviderTranslateContext *a_pTranslateContext)
 Provider translate function. More...
 
typedef OpcUa_StatusCode(* UaServer_pfProviderRegisterNodesAsync )(UaServer_ProviderRegisterNodesContext *a_pRegisterContext)
 Provider RegisterNodes function. More...
 
typedef OpcUa_StatusCode(* UaServer_pfProviderUnregisterNodesAsync )(UaServer_ProviderUnregisterNodesContext *a_pUnregisterContext)
 Provider UnregisterNodes function. More...
 
typedef OpcUa_StatusCode(* UaServer_pfProviderReadAsync )(UaServer_ProviderReadContext *a_pReadContext)
 Provider read function. More...
 
typedef OpcUa_StatusCode(* UaServer_pfProviderWriteAsync )(UaServer_ProviderWriteContext *a_pWriteContext)
 Provider write function. More...
 
typedef OpcUa_StatusCode(* UaServer_pfProviderHistoryReadEventAsync )(UaServer_ProviderHistoryReadEventContext *a_pHistoryReadEventContext)
 Provider HistoryReadEvent function. More...
 
typedef OpcUa_StatusCode(* UaServer_pfProviderHistoryReadRawModifiedAsync )(UaServer_ProviderHistoryReadRawModifiedContext *a_pHistoryReadRawModifiedContext)
 Provider HistoryReadRawModified function. More...
 
typedef OpcUa_StatusCode(* UaServer_pfProviderHistoryReadProcessedAsync )(UaServer_ProviderHistoryReadProcessedContext *a_pHistoryReadProcessedContext)
 Provider HistoryReadProcessed function. More...
 
typedef OpcUa_StatusCode(* UaServer_pfProviderHistoryReadAtTimeAsync )(UaServer_ProviderHistoryReadAtTimeContext *a_pHistoryReadAtTimeContext)
 Provider HistoryReadAtTime function. More...
 
typedef OpcUa_StatusCode(* UaServer_pfProviderHistoryUpdateAsync )(UaServer_ProviderHistoryUpdateContext *a_pHistoryUpdateContext)
 Provider HistoryUpdate function. More...
 
typedef OpcUa_StatusCode(* UaServer_pfProviderCallAsync )(UaServer_ProviderCallContext *a_pCallContext)
 Provider Call function. More...
 
typedef OpcUa_StatusCode(* UaServer_pfProviderAddItem )(UaServer_MonitoredItem *a_pItem)
 Provider add item function. More...
 
typedef OpcUa_StatusCode(* UaServer_pfProviderRemoveItem )(UaServer_MonitoredItem *a_pItem)
 Provider remove item function. More...
 
typedef OpcUa_StatusCode(* UaServer_pfProviderSubscribe )(UaServer_ProviderSubscribeContext *a_pContext)
 Provider subscribe function. More...
 
typedef OpcUa_StatusCode(UABASE_DLLCALL * UaServer_pfInitializeProvider )(struct _UaServer_Provider *pProvider, UaServer_pProviderInterface *pProviderInterface)
 Initialize function. More...
 

Functions

OpcUa_StatusCode UaServer_RequestNamespaceIndex (OpcUa_Handle a_hReserved, OpcUa_Handle a_hProvider, OpcUa_UInt16 *a_pRequestedNamespaceIndex, const OpcUa_CharA *a_sNamespaceUri)
 Request NamespaceIndex. More...
 
OpcUa_StatusCode UaServer_RegisterAddressSpace (OpcUa_Handle a_hProvider, OpcUa_UInt16 *a_puNamespaceIndex, const OpcUa_CharA *a_sNamespaceUri, OpcUa_UInt32 a_uRequestedAdressSpaceSize)
 This function gets called from the provider during initalization to register its basenode. More...
 
UaServer_UserCtx * UaServer_UserMgt_GetUserContext (UaServer_MonitoredItem *pMonitoredItem)
 Get the user context of the session associated with the given monitored item. More...
 
OpcUa_StatusCode UaServer_Providers_Initialize (UaServer *a_pServer)
 Build interface for providers and load and initialize all providers in the list. More...
 

Detailed Description

Typedef Documentation

typedef OpcUa_StatusCode(UABASE_DLLCALL * UaServer_pfInitializeProvider)(struct _UaServer_Provider *pProvider, UaServer_pProviderInterface *pProviderInterface)

Initialize function.

This function initializes the provider interface and is called by the server.

typedef OpcUa_StatusCode(* UaServer_pfProviderAddItem)(UaServer_MonitoredItem *a_pItem)

Provider add item function.

This function is called by the server to add new items. This function works synchronous.

typedef OpcUa_StatusCode(* UaServer_pfProviderBrowseAsync)(UaServer_ProviderBrowseContext *a_pBrowseContext)

Provider browse function.

This function is called by the server to browse the address space. This functions works asynchronous, this means the provider should start the browse operation and immediatly return. The browse result must be returned in the BrowseComplete callback using the _UaServer_pProviderCBInterface.

typedef OpcUa_StatusCode(* UaServer_pfProviderCallAsync)(UaServer_ProviderCallContext *a_pCallContext)

Provider Call function.

This function is called by the server to Call a method. This functions works asynchronous, this means the provider should start the Call operation and immediatly return. The Call result must be returned in the CallComplete callback using the _UaServer_pProviderCBInterface.

typedef OpcUa_StatusCode(* UaServer_pfProviderCleanup)()

Provider cleanup function.

This function is called by the server before the provider is unloaded. The provider should cleanup all its resources when this function is called.

typedef OpcUa_StatusCode(* UaServer_pfProviderHistoryReadAtTimeAsync)(UaServer_ProviderHistoryReadAtTimeContext *a_pHistoryReadAtTimeContext)

Provider HistoryReadAtTime function.

This function is called by the server to HistoryReadAtTime IO data. This functions works asynchronous, this means the provider should start the read operation and immediately return. The HistoryReadAtTime result must be returned in the HistoryReadAtTimeComplete callback using the _UaServer_pProviderCBInterface.

typedef OpcUa_StatusCode(* UaServer_pfProviderHistoryReadEventAsync)(UaServer_ProviderHistoryReadEventContext *a_pHistoryReadEventContext)

Provider HistoryReadEvent function.

This function is called by the server to HistoryReadEvent IO data. This functions works asynchronous, this means the provider should start the read operation and immediately return. The HistoryReadEvent result must be returned in the HistoryReadEventComplete callback using the _UaServer_pProviderCBInterface.

typedef OpcUa_StatusCode(* UaServer_pfProviderHistoryReadProcessedAsync)(UaServer_ProviderHistoryReadProcessedContext *a_pHistoryReadProcessedContext)

Provider HistoryReadProcessed function.

This function is called by the server to HistoryReadProcessed IO data. This functions works asynchronous, this means the provider should start the read operation and immediately return. The HistoryReadProcessed result must be returned in the HistoryReadProcessedComplete callback using the _UaServer_pProviderCBInterface.

typedef OpcUa_StatusCode(* UaServer_pfProviderHistoryReadRawModifiedAsync)(UaServer_ProviderHistoryReadRawModifiedContext *a_pHistoryReadRawModifiedContext)

Provider HistoryReadRawModified function.

This function is called by the server to HistoryReadRawModified IO data. This functions works asynchronous, this means the provider should start the read operation and immediately return. The HistoryReadRawModified result must be returned in the HistoryReadRawModifiedComplete callback using the _UaServer_pProviderCBInterface.

typedef OpcUa_StatusCode(* UaServer_pfProviderHistoryUpdateAsync)(UaServer_ProviderHistoryUpdateContext *a_pHistoryUpdateContext)

Provider HistoryUpdate function.

This function is called by the server to HistoryUpdate IO data. This functions works asynchronous, this means the provider should start the read operation and immediatly return. The HistoryUpdate result must be returned in the HistoryUpdateComplete callback using the _UaServer_pProviderCBInterface.

typedef OpcUa_StatusCode(* UaServer_pfProviderReadAsync)(UaServer_ProviderReadContext *a_pReadContext)

Provider read function.

This function is called by the server to read IO data. This functions works asynchronous, this means the provider should start the read operation and immediatly return. The read result must be returned in the ReadComplete callback using the _UaServer_pProviderCBInterface.

typedef OpcUa_StatusCode(* UaServer_pfProviderRegisterNodesAsync)(UaServer_ProviderRegisterNodesContext *a_pRegisterContext)

Provider RegisterNodes function.

This function is called by the server to RegisterNodes. This functions works asynchronous, this means the provider should start the RegisterNodes operation and immediatly return. The translate result must be returned in the RegisterNodesComplete callback using the _UaServer_pProviderCBInterface.

typedef OpcUa_StatusCode(* UaServer_pfProviderRemoveItem)(UaServer_MonitoredItem *a_pItem)

Provider remove item function.

This function is called by the server to remove items. This function works synchronous. If this function is called all denoted items will be removed.

typedef OpcUa_StatusCode(* UaServer_pfProviderSubscribe)(UaServer_ProviderSubscribeContext *a_pContext)

Provider subscribe function.

This function is called by the server to subscribe. This function works synchronous.

typedef OpcUa_StatusCode(* UaServer_pfProviderTranslateAsync)(UaServer_ProviderTranslateContext *a_pTranslateContext)

Provider translate function.

This function is called by the server to translate browse paths to node ids. This functions works asynchronous, this means the provider should start the translate operation and immediatly return. The translate result must be returned in the TranslateComplete callback using the _UaServer_pProviderCBInterface.

typedef OpcUa_StatusCode(* UaServer_pfProviderUnregisterNodesAsync)(UaServer_ProviderUnregisterNodesContext *a_pUnregisterContext)

Provider UnregisterNodes function.

This function is called by the server to UnregisterNodes. This functions works asynchronous, this means the provider should start the UnregisterNodes operation and immediatly return. The UnregisterNodes result must be returned in the UnregisterNodesComplete callback using the _UaServer_pProviderCBInterface.

typedef OpcUa_StatusCode(* UaServer_pfProviderWriteAsync)(UaServer_ProviderWriteContext *a_pWriteContext)

Provider write function.

This function is called by the server to write IO data. This functions works asynchronous, this means the provider should start the write operation and immediatly return. The write result must be returned in the WriteComplete callback using the _UaServer_pProviderCBInterface.

Function Documentation

OpcUa_StatusCode UaServer_Providers_Initialize ( UaServer *  a_pServer)

Build interface for providers and load and initialize all providers in the list.

Parameters
a_pServera pointer to the server.
Returns
the OPC UA Status code.
OpcUa_StatusCode UaServer_RegisterAddressSpace ( OpcUa_Handle  a_hProvider,
OpcUa_UInt16 *  a_puNamespaceIndex,
const OpcUa_CharA *  a_sNamespaceUri,
OpcUa_UInt32  a_uRequestedAdressSpaceSize 
)

This function gets called from the provider during initalization to register its basenode.

Provider register addressspace function.

Parameters
[in]a_hProvidera handle to the Provider with all needed information.
[out]a_puNamespaceIndexthe actual NamespaceIndex.
[in]a_sNamespaceUrithe actual NamespaceUri.
[in]a_uRequestedAdressSpaceSizethe size for the addressspace that is requested.
Returns
Error code.

This function gets called from the provider during initalization to register its basenode.

OpcUa_StatusCode UaServer_RequestNamespaceIndex ( OpcUa_Handle  a_hReserved,
OpcUa_Handle  a_hProvider,
OpcUa_UInt16 *  a_pRequestedNamespaceIndex,
const OpcUa_CharA *  a_sNamespaceUri 
)

Request NamespaceIndex.

Provider request new Namespace index This function gets called from the provider.

Parameters
a_hReservedreserved for future use, is not evaluated. Pass OpcUa_Null as value.
a_hProvidera handle to the Provider with all needed information.
a_pRequestedNamespaceIndexpointer to the NamespaceIndex to request (0xFFFF to get the next free index).
a_sNamespaceUrithe actual NamespaceUri.
Returns
the OPC UA Status code.
UaServer_UserCtx * UaServer_UserMgt_GetUserContext ( UaServer_MonitoredItem *  pMonitoredItem)

Get the user context of the session associated with the given monitored item.

Parameters
pMonitoredItemThe monitored item to get the associated user context from.
Returns
The user context or OpcUa_Null if an error occured.