Callback interface for providing application control funtions through methods. More...

#include <servermanagerhelper.h>

Public Member Functions
	UaApplicationControlCallback ()
	Construction.

virtual	~UaApplicationControlCallback ()
	Destruction.

virtual OpcUa_UInt32	getEndpointCount ()=0
	Returns the number of OPC UA endpoints in the server. More...

virtual UaEndpoint *	getEndpoint (OpcUa_UInt32 endpointIndex)=0
	Returns the endpoint at the sepcified index. More...

virtual UaStatus	pauseUaServer ()=0
	Pause the OPC UA communication and close endpoints. More...

virtual UaStatus	restartUaServer ()=0
	Open endpoints to restart OPC UA communication. More...

virtual UaStatus	requestServerStateChange (Session *pSession, OpcUa_ServerState state, const UaDateTime &estimatedReturnTime, OpcUa_UInt32 secondsTillShutdown, const UaLocalizedText &shutdownReason, OpcUa_Boolean restart)=0
	Requests the state change, shutdown or restart of the OPC UA Server application. More...

virtual void	beforeEndpointOpen (UaEndpoint *pEndpoint, bool certificateAvailable)=0
	Information about an endpoint that will be opened by the server. More...

Detailed Description

Callback interface for providing application control funtions through methods.

This callback interface needs to be implemented if the application wants to allow control of application behaviour like server shutdown or close/reopen of endpoints to be controlled through methods in the server address space.

Member Function Documentation

virtual void UaApplicationControlCallback::beforeEndpointOpen	(	UaEndpoint *	pEndpoint,
		bool	certificateAvailable
	)

pure virtual

Information about an endpoint that will be opened by the server.

This callbacks allows certificate checks or creation.

Parameters

[in]	pEndpoint	UaEndpoint that will be opened by the server
[in]	certificateAvailable	Flag indicating if a certificate is available

Implemented in UaServerApplication.

virtual UaEndpoint* UaApplicationControlCallback::getEndpoint ( OpcUa_UInt32 endpointIndex )

pure virtual

Returns the endpoint at the sepcified index.

Parameters

[in] endpointIndex Index of the Endpoint to return

Implemented in UaServerApplication.

virtual OpcUa_UInt32 UaApplicationControlCallback::getEndpointCount ( )

pure virtual

Returns the number of OPC UA endpoints in the server.

Implemented in UaServerApplication.

virtual UaStatus UaApplicationControlCallback::pauseUaServer ( )

pure virtual

Pause the OPC UA communication and close endpoints.

Implemented in UaServerApplication.

virtual UaStatus UaApplicationControlCallback::requestServerStateChange	(	Session *	pSession,
		OpcUa_ServerState	state,
		const UaDateTime &	estimatedReturnTime,
		OpcUa_UInt32	secondsTillShutdown,
		const UaLocalizedText &	shutdownReason,
		OpcUa_Boolean	restart
	)

pure virtual

Requests the state change, shutdown or restart of the OPC UA Server application.

Returns: Result of the request. If the result is Bad, the application will not change its state

Parameters

[in]	pSession	Session context for the client request
[in]	state	The requested target state for the Server
[in]	estimatedReturnTime	Indicates the time at which the Server is expected to be available in the state RUNNING_0.
[in]	secondsTillShutdown	Seconds till shutdown of the server. This parameter is ignored unless the state is set to SHUTDOWN_4 or restart is set to True.
[in]	shutdownReason	Reason for the shutdown
[in]	restart	A flag indicating if the Server should be restarted after shutdown

Implemented in UaServerApplication.

virtual UaStatus UaApplicationControlCallback::restartUaServer ( )

pure virtual

Open endpoints to restart OPC UA communication.

Implemented in UaServerApplication.

The documentation for this class was generated from the following file:

C:/work/uasdkcpp/src/uaserver/uaservercpp/coremodule/servermanagerhelper.h

Public Member Functions

Detailed Description

Member Function Documentation