Main Content

getServerStatus

Status of OPC UA server

Description

status = getServerStatus(uaClient) retrieves the status of the OPC UA server connected to uaClient. uaClient must specify one connected OPC UA client, not a vector of clients.

example

Examples

collapse all

Connect an OPC UA client and retrieve the status of its server.

s = opcuaserverinfo("localhost");
uaClient = opcua(s);
connect(uaClient);
status = getServerStatus(uaClient)
status =
              StartTime: 10-Jun-2015 16:39:17
            CurrentTime: 10-Jun-2015 16:55:00
                  State: 'Running'
              BuildInfo: [1x1 struct]
    SecondsTillShutdown: 0
         ShutdownReason: ''

Input Arguments

collapse all

OPC UA client, specified as an OPC UA client object.

Example: getServerStatus(uaClient)

Output Arguments

collapse all

Status of OPC UA server, returned as a structure. This table describes the fields in the structure.

Field NameDescription
StartTimeStart time of the server, returned as a MATLAB datetime value.
CurrentTimeCurrent time on the server, returned as a MATLAB datetime value.
StateState of the server, returned as a character vector.
BuildInfoBuild information of the server, returned as a structure with fields ManufacturerName, ProductName, and SoftwareVersion.
SecondsTillShutdownIf the server is shutting down, time to shutdown, returned as a scalar.
ShutdownReasonReason for the server shutdown, returned as a character vector or an empty character vector.

Version History

Introduced in R2015b

See Also

Functions