com.prosysopc.ua.client

Interface ServerStatusListener

public interface ServerStatusListener

Event interface for listening changes in the OPC UA Server status.

The default implementation for the methods does nothing, you only need to implement the ones you wish to listen.

Method Summary

Modifier and Type	Method and Description
default void	onShutdown(UaClient client, long secondsTillShutdown, LocalizedText shutdownReason) A notification of a server shutdown.
default void	onStateChange(UaClient client, ServerState oldState, ServerState newState) A notification of the change in the server state.
default void	onStatusChange(UaClient client, ServerStatusDataType status, StatusCode errorCode) A notification of a new server status.

Method Detail

onShutdown

default void onShutdown(UaClient client,
                        long secondsTillShutdown,
                        LocalizedText shutdownReason)

A notification of a server shutdown. The method is called whenever the server status changes to Shutdown, meaning that it will close down.

Parameters:

client - the client object that is connected to the server.

secondsTillShutdown - number of seconds to the expected shutdown.

shutdownReason - the reason for the shutdown as reported by the server.

onStateChange

default void onStateChange(UaClient client,
                           ServerState oldState,
                           ServerState newState)

A notification of the change in the server state.

Parameters:

client - the client object that is connected to the server.

oldState - the previous ServerState (Unknown, if it was not available)

newState - the new ServerState (Unknown, if it was not available)

onStatusChange

default void onStatusChange(UaClient client,
                            ServerStatusDataType status,
                            StatusCode errorCode)

A notification of a new server status. The method is called whenever a new status is received from the server, which means every StatusCheckInterval. In case the status of the server cannot be read, status will be null. You can read errorCode in this case to learn the reason for the failure.

Parameters:

client - the client object that is connected to the server.

status - the new status. If null, errorCode provides the reason for failure.

errorCode - StatusCode of the status.