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

Functions

OpcUa_StatusCode UaClient_Initialize (UaClient *a_pUaClient)
 Initialize the UaClient object structure. More...
 
UaClient_ConfigurationUaClient_GetConfiguration ()
 Returns the configuration struct of the client. More...
 
OpcUa_StatusCode UaClient_StartUp (UaClient *a_pUaClient)
 Set the client up using the settings made in the configuration struct. More...
 
OpcUa_StatusCode UaClient_DoCom ()
 The internal main 'event loop' which processes messages and triggers timers. More...
 
OpcUa_StatusCode UaClient_TimedDoCom (OpcUa_UInt32 a_uTimeout)
 The internal main 'event loop' which processes messages and triggers timers. More...
 
OpcUa_StatusCode UaClient_Clear ()
 Cleans up application and used resources.
 
OpcUa_StatusCode UaClient_Settings_GetConfigurationFromSettings (UaBase_Settings *pSettings, UaClient_Configuration *pClientConfiguration)
 Fill the server configuration object using the provided settings structure. More...
 

Detailed Description

Function Documentation

OpcUa_StatusCode UaClient_DoCom ( )

The internal main 'event loop' which processes messages and triggers timers.

Returns
OpcUa_Good if no error occured.
UaClient_Configuration * UaClient_GetConfiguration ( )

Returns the configuration struct of the client.

Returns
A pointer to the configuration struct of the client.
OpcUa_StatusCode UaClient_Initialize ( UaClient a_pUaClient)

Initialize the UaClient object structure.

Parameters
[in]a_pUaClientA pointer to the UaClient object.
Returns
OPC UA Status code.
OpcUa_StatusCode UaClient_Settings_GetConfigurationFromSettings ( UaBase_Settings pSettings,
UaClient_Configuration pClientConfiguration 
)

Fill the server configuration object using the provided settings structure.

The provided settings object is expected to contain settings described above.

Parameters
pSettingsThe settings to use.
pClientConfigurationThe server configuration to set.
Returns
OpcUa_StatusCode
OpcUa_StatusCode UaClient_StartUp ( UaClient a_pUaClient)

Set the client up using the settings made in the configuration struct.

Parameters
a_pUaClienta pointer to the UaClient object.
Returns
OPC UA Status code.
OpcUa_StatusCode UaClient_TimedDoCom ( OpcUa_UInt32  a_uTimeout)

The internal main 'event loop' which processes messages and triggers timers.

Parameters
a_uTimeoutThe timeout for the OpcUa_SocketManager_Loop call issued by this function.
Returns
OpcUa_Good if no error occured.