ANSI C UA Server SDK
1.5.0.312
|
Functions | |
OpcUa_StatusCode | UaServer_SetUserAuthenticationType (UaServer *a_pUaServer, UaServer_UserAuthType a_type, UaServer_pfServer_AuthenticateSession a_pUserAuthFunction) |
Sets the authentication type used in ActivateSession. More... | |
OpcUa_StatusCode | UaServer_SetUserAuthenticationTypeEx (UaServer *a_pUaServer, UaServer_UserAuthType a_type, UaServer_pfServer_AuthenticateSessionEx a_pUserAuthFunction) |
Sets the authentication type used in ActivateSession. More... | |
OpcUa_StatusCode | UaServer_SetCallback_SessionCreated (UaServer *a_pUaServer, UaServer_pfServer_SessionCreated a_pCallbackFunction) |
Sets the SessionCreated callback function. More... | |
OpcUa_StatusCode | UaServer_SetCallback_SessionActivated (UaServer *a_pUaServer, UaServer_pfServer_SessionActivated a_pCallbackFunction) |
Sets the SessionActivated callback function. More... | |
OpcUa_StatusCode | UaServer_SetCallback_SessionClosed (UaServer *a_pUaServer, UaServer_pfServer_SessionClosed a_pCallbackFunction) |
Sets the SessionClosed callback function. More... | |
OpcUa_StatusCode | UaServer_Initialize (UaServer *a_pUaServer) |
Initialize the UaServer object structure. More... | |
UaServer_Configuration * | UaServer_GetConfiguration (UaServer *a_pUaServer) |
Returns the configuration struct of the server. More... | |
OpcUa_StatusCode | UaServer_StartUp (UaServer *a_pUaServer) |
Start the UaServer to enable OPC UA connection establishment from clients. More... | |
OpcUa_StatusCode | UaServer_DoCom () |
The internal main 'event loop' which processes messages and triggers timers. More... | |
OpcUa_StatusCode | UaServer_TimedDoCom (OpcUa_UInt32 a_uTimeout) |
The internal main 'event loop' which processes messages and triggers timers. More... | |
OpcUa_StatusCode | UaServer_Shutdown (UaServer *a_pUaServer, OpcUa_UInt32 a_uSecondsTillShutdown, OpcUa_LocalizedText *a_pShutdownReason) |
Shut the server down in the given number of seconds. More... | |
OpcUa_Void | UaServer_Clear (UaServer *a_pUaServer) |
Cleans up application and used resources. More... | |
OpcUa_StatusCode | UaServer_Settings_GetConfigurationFromSettings (UaBase_Settings *pSettings, UaServer_Configuration *pServerConfiguration, const char *szHostname) |
Fill the server configuration object using the provided settings structure. More... | |
OpcUa_Void UaServer_Clear | ( | UaServer * | a_pUaServer | ) |
Cleans up application and used resources.
a_pUaServer | a pointer to the servers object. |
OpcUa_StatusCode UaServer_DoCom | ( | ) |
The internal main 'event loop' which processes messages and triggers timers.
UaServer_Configuration * UaServer_GetConfiguration | ( | UaServer * | a_pUaServer | ) |
Returns the configuration struct of the server.
[in] | a_pUaServer | The server to use |
OpcUa_StatusCode UaServer_Initialize | ( | UaServer * | a_pUaServer | ) |
Initialize the UaServer object structure.
[in] | a_pUaServer | A pointer to the UaServer object. |
OpcUa_StatusCode UaServer_SetCallback_SessionActivated | ( | UaServer * | a_pUaServer, |
UaServer_pfServer_SessionActivated | a_pCallbackFunction | ||
) |
Sets the SessionActivated callback function.
This function was introduced in version 1.2.1.
[in] | a_pUaServer | A pointer to the UaServer object. |
[in] | a_pCallbackFunction | The function to call if a session was activated. |
OpcUa_StatusCode UaServer_SetCallback_SessionClosed | ( | UaServer * | a_pUaServer, |
UaServer_pfServer_SessionClosed | a_pCallbackFunction | ||
) |
Sets the SessionClosed callback function.
This function was introduced in version 1.2.1.
[in] | a_pUaServer | A pointer to the UaServer object. |
[in] | a_pCallbackFunction | The function to call if a session was closed. |
OpcUa_StatusCode UaServer_SetCallback_SessionCreated | ( | UaServer * | a_pUaServer, |
UaServer_pfServer_SessionCreated | a_pCallbackFunction | ||
) |
Sets the SessionCreated callback function.
This function was introduced in version 1.2.1.
[in] | a_pUaServer | A pointer to the UaServer object. |
[in] | a_pCallbackFunction | The function to call if a session was created. |
OpcUa_StatusCode UaServer_Settings_GetConfigurationFromSettings | ( | UaBase_Settings * | pSettings, |
UaServer_Configuration * | pServerConfiguration, | ||
const char * | szHostname | ||
) |
Fill the server configuration object using the provided settings structure.
The provided settings object is expected to contain settings described above.
pSettings | The settings to use. |
pServerConfiguration | The server configuration to set. |
szHostname | Optional: the string to replace [gethostname] placeholders with. |
OpcUa_StatusCode UaServer_SetUserAuthenticationType | ( | UaServer * | a_pUaServer, |
UaServer_UserAuthType | a_type, | ||
UaServer_pfServer_AuthenticateSession | a_pUserAuthFunction | ||
) |
Sets the authentication type used in ActivateSession.
[in] | a_pUaServer | A pointer to the UaServer object. |
[in] | a_type | The authentication type to set. |
[in] | a_pUserAuthFunction | Optional: If a custom authentication module should be set, the function pointer to the authentication callback function must be set here and a_type to UserAuthType_User. If no custom authentication module is set, this parameter is ignored and can be OpcUa_Null. |
OpcUa_StatusCode UaServer_SetUserAuthenticationTypeEx | ( | UaServer * | a_pUaServer, |
UaServer_UserAuthType | a_type, | ||
UaServer_pfServer_AuthenticateSessionEx | a_pUserAuthFunction | ||
) |
Sets the authentication type used in ActivateSession.
[in] | a_pUaServer | A pointer to the UaServer object. |
[in] | a_type | The authentication type to set. |
[in] | a_pUserAuthFunction | Optional: If a custom authentication module should be set, the function pointer to the authentication callback function must be set here and a_type to UserAuthType_User. If no custom authentication module is set, this parameter is ignored and can be OpcUa_Null. |
OpcUa_StatusCode UaServer_Shutdown | ( | UaServer * | a_pUaServer, |
OpcUa_UInt32 | a_uSecondsTillShutdown, | ||
OpcUa_LocalizedText * | a_pShutdownReason | ||
) |
Shut the server down in the given number of seconds.
After a_uSecondsTillShutdown have passed, UaServer_DoCom will return with status OpcUa_BadShutdown.
a_pUaServer | A pointer to the server object. |
a_uSecondsTillShutdown | The number of seconds to wait until shutdown. |
a_pShutdownReason | The reason for shutdown. |
OpcUa_StatusCode UaServer_StartUp | ( | UaServer * | a_pUaServer | ) |
Start the UaServer to enable OPC UA connection establishment from clients.
a_pUaServer | a pointer to the UaServer object. |
OpcUa_StatusCode UaServer_TimedDoCom | ( | OpcUa_UInt32 | a_uTimeout | ) |
The internal main 'event loop' which processes messages and triggers timers.
a_uTimeout | The timeout for the OpcUa_SocketManager_Loop call issued by this function. |