.NET Based OPC UA Client/Server SDK  3.2.2.525
UnifiedAutomation.UaServer.IServerMethods Interface Reference

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...
 

Detailed Description

The interface for methods implemented on the ServerModel object.

Member Function Documentation

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.
Parameters
context
model
SubscriptionId
ServerHandlesout:
ClientHandlesout:
Returns

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.
Parameters
context
model
State
EstimatedReturnTime
SecondsTillShutdown
Reason
Restart
Returns

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.
Parameters
context
model
SubscriptionId
Returns

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.
Parameters
context
model
SubscriptionId
LifetimeInHours
RevisedLifetimeInHoursout:
Returns

Implemented in UnifiedAutomation.UaServer.ServerManager.


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