.NET Based OPC UA Client/Server SDK
2.5.7.406
|
The interface for methods implemented on the ServerModel object. More...
Inherited by UnifiedAutomation.UaServer.ServerManager.
Public Member Functions | |
StatusCode | GetMonitoredItems (RequestContext context, ServerModel model, uint SubscriptionId, out uint[] ServerHandles, out uint[] ClientHandles) |
Used to identify the monitored items of a subscription. More... | |
StatusCode | RequestServerStateChange (RequestContext context, ServerModel model, ServerState State, DateTime EstimatedReturnTime, uint SecondsTillShutdown, LocalizedText Reason, bool Restart) |
Allows a Client to request a state change in the Server. More... | |
StatusCode | ResendData (RequestContext context, ServerModel model, uint SubscriptionId) |
Used to get the latest values of the data monitored items of a Subscription. More... | |
StatusCode | SetSubscriptionDurable (RequestContext context, ServerModel model, uint SubscriptionId, uint LifetimeInHours, out uint RevisedLifetimeInHours) |
Used to set a subscription into a mode where monitored item data and event queues are stored and delivered even if an OPC UA Client was disconnected for a longer time or the OPC UA Server was restarted. More... | |
The interface for methods implemented on the ServerModel object.
StatusCode UnifiedAutomation.UaServer.IServerMethods.GetMonitoredItems | ( | RequestContext | context, |
ServerModel | model, | ||
uint | SubscriptionId, | ||
out uint[] | ServerHandles, | ||
out uint[] | ClientHandles | ||
) |
Used to identify the monitored items of a subscription.
The intended usage is defined in Part 4 of the OPC UA Specification.
Method Result Codes:
Result Code | Description |
---|---|
Bad_SubscriptionIdInvalid | The subscription id is not valid. |
Bad_UserAccessDenied | User does not have permission to perform the requested operation. The Method was not called in the context of the Session that owns the Subscription. |
context | |
model | |
SubscriptionId | Identifier of the subscription. |
ServerHandles | Array of server handles for all monitored items of the subscription identified by SubscriptionId. |
ClientHandles | Array of client handles for all monitored items of the subscription identified by SubscriptionId |
Implemented in UnifiedAutomation.UaServer.ServerManager.
StatusCode UnifiedAutomation.UaServer.IServerMethods.RequestServerStateChange | ( | RequestContext | context, |
ServerModel | model, | ||
ServerState | State, | ||
DateTime | EstimatedReturnTime, | ||
uint | SecondsTillShutdown, | ||
LocalizedText | Reason, | ||
bool | Restart | ||
) |
Allows a Client to request a state change in the Server.
The intended usage is defined in Part 4 of the OPC UA Specification.
The Client shall provide credentials with administrative rights when invoking this method on the Server.
Method Result Codes:
Result Code | Description |
---|---|
Bad_UserAccessDenied | The current user is not authorized to invoke the method. |
Bad_InvalidState | The requested state was not accepted by the server. |
context | |
model | |
State | The requested target state for the Server. If the new state is accepted by the Server, the state in the UnifiedAutomation.UaServer.ServerModel.ServerStatus is updated with the new value. |
EstimatedReturnTime | Indicates the time at which the Server is expected to be available in the state RUNNING_0. If no estimate is known, a null DateTime shall be provided. This time will be available in the EstimatedReturnTime property. This parameter shall be ignored by the Server and the property EstimatedReturnTime shall be set to null if the new state is RUNNING_0. |
SecondsTillShutdown | The number of seconds until a Server shutdown. This parameter is ignored unless the state is set to SHUTDOWN_4 or restart is set to true. |
Reason | A localized text string that describes the reason for the state change request. |
Restart | A flag indicating if the Server should be restarted before it attempts to change into the requested change. If restart is true, the server changes its state to SHUTDOWN_4 before the restart if secondsTillShudown is not 0. |
Implemented in UnifiedAutomation.UaServer.ServerManager.
StatusCode UnifiedAutomation.UaServer.IServerMethods.ResendData | ( | RequestContext | context, |
ServerModel | model, | ||
uint | SubscriptionId | ||
) |
Used to get the latest values of the data monitored items of a Subscription.
The intended usage is defined in Part 4 of the OPC UA Specification.
Method Result Codes:
Result Code | Description |
---|---|
Bad_SubscriptionIdInvalid | The subscription id is not valid. |
Bad_UserAccessDenied | User does not have permission to perform the requested operation. The Method was not called in the context of the Session that owns the Subscription. |
context | |
model | |
SubscriptionId | Identifier of the subscription to refresh. |
Implemented in UnifiedAutomation.UaServer.ServerManager.
StatusCode UnifiedAutomation.UaServer.IServerMethods.SetSubscriptionDurable | ( | RequestContext | context, |
ServerModel | model, | ||
uint | SubscriptionId, | ||
uint | LifetimeInHours, | ||
out uint | RevisedLifetimeInHours | ||
) |
Used to set a subscription into a mode where monitored item data and event queues are stored and delivered even if an OPC UA Client was disconnected for a longer time or the OPC UA Server was restarted.
The intended usage is defined in Part 4 of the OPC UA Specification.
Method Result Codes:
Result Code | Description |
---|---|
Bad_SubscriptionIdInvalid | The subscription id is not valid. |
Bad_InvalidState | The operation cannot be completed because the object is closed, uninitialized or in some other invalid state. This is returned when a Subscription already contains MonitoredItems. |
Bad_UserAccessDenied | User does not have permission to perform the requested operation. The Method was not called in the context of the Session that owns the Subscription. |
context | |
model | |
SubscriptionId | Identifier of the subscription. |
LifetimeInHours | The requested lifetime in hours for the durable subscription. |
RevisedLifetimeInHours | The revised lifetime in hours the server applied to the durable subscription. |
Implemented in UnifiedAutomation.UaServer.ServerManager.