Callback interface for the Server application object.
More...
#include <uacoreserverapplication.h>
Callback interface for the Server application object.
This callback interface needs to be implemented if the application wants to implement user authentication.
| void UaServerApplicationCallback::afterLoadConfiguration |
( |
ServerConfig * |
pServerConfig | ) |
|
|
virtual |
Optional method used to inform the application that the configuration was loaded.
This callback allows the application to overwrite settings from configuration files before the server is started. This ensures that hard coded settings can not be changed by entering the configuration setting into the configuration file.
- Parameters
-
| pServerConfig | The server configuration interface |
| void UaServerApplicationCallback::beforeEndpointOpen |
( |
UaEndpoint * |
pEndpoint, |
|
|
bool |
certificateAvailable |
|
) |
| |
|
virtual |
Optional method providing information about an endpoint that will be opened and the certificate that will be used by the server.
This callbacks allows certificate checks or the creation of a certificate before it is created by the SDK. /ref UaEndpoint::pEndpointCertificateSettings() returns the certificate configuration used by the endpoint
- Parameters
-
| [in] | pEndpoint | UaEndpoint that will be opened by the server |
| [in] | certificateAvailable | Flag indicating if a certificate is available |
| virtual Session* UaServerApplicationCallback::createSession |
( |
OpcUa_Int32 |
sessionID, |
|
|
const UaNodeId & |
authenticationToken |
|
) |
| |
|
pure virtual |
Creates a session object for the OPC server.
This callback allows the application to create its own session class derived from UaSession to store user specific information and to implement the user logon and user verification.
- Parameters
-
| sessionID | Session Id created by the server application. |
| authenticationToken | Secret session Id created by the server application. |
- Returns
- A pointer to the created session.
| virtual UaServer* UaServerApplicationCallback::createUaServer |
( |
| ) |
|
|
inlinevirtual |
Optional method used to create an application specific UaServer object used as main entry point for the UA communication.
The SDK creates an instance of the UaServer class as default implementation.
- Returns
- UaServer object or NULL if the SDK should use the default implementation.
Validates the user identity token and sets the user for the session.
- Parameters
-
| pSession | Interface to the Session context for the method call |
| pUserIdentityToken | Secret session Id created by the server application. |
| pServerConfig | The server configuration interface |
- Returns
- Error code.
| UaStatus UaServerApplicationCallback::requestServerShutDown |
( |
OpcUa_Int32 |
secondsTillShutdown, |
|
|
const UaLocalizedText & |
shutdownReason, |
|
|
OpcUa_Boolean |
restart |
|
) |
| |
|
virtual |
Optional method to requests the shutdown of the OPC UA Server application.
- Returns
- Result of the request. If the resul tis Good, the application must shutdown the server. If the result is Bad, the application will not shut down.
- Parameters
-
| [in] | secondsTillShutdown | Seconds till shutdown of the server |
| [in] | shutdownReason | Reason for the shutdown |
| [in] | restart | A flag indicating if the Server should be restarted after shutdown |
The documentation for this class was generated from the following files:
- D:/work/uasdkcpp/src/uaserver/uaservercpp/coremodule/uacoreserverapplication.h
- D:/work/uasdkcpp/src/uaserver/uaservercpp/coremodule/uacoreserverapplication.cpp
