C++ Based OPC UA Client/Server/PubSub SDK
MethodManager Class Referenceabstract

Interface definition of the MethodManager used for calling methods in the server. More...

#include <methodmanager.h>

Inherited by OpcUa::BaseObjectType.

Public Member Functions

 MethodManager ()
virtual ~MethodManager ()
virtual UaStatus beginCall (MethodManagerCallback *pCallback, const ServiceContext &serviceContext, OpcUa_UInt32 callbackHandle, MethodHandle *pMethodHandle, const UaVariantArray &inputArguments)=0
 Call method of an UA object. More...

Detailed Description

Interface definition of the MethodManager used for calling methods in the server.

The MethodManager interface provides the method call capability for objects. The MethodManager interface is asynchronous. For the MethodManager callback the MethodManagerCallback interface is implemented by the consumer of the call results. One of the consumers is the UA Module. This interface is used by the SDK to multiplex the list of calls in the UA service to different MethodManagers.

Member Function Documentation

virtual UaStatus MethodManager::beginCall ( MethodManagerCallback pCallback,
const ServiceContext serviceContext,
OpcUa_UInt32  callbackHandle,
MethodHandle pMethodHandle,
const UaVariantArray inputArguments 
pure virtual

Call method of an UA object.

pCallbackCallback interface used for the transaction. The MethodManager must use this interface to finish the action for each passed node in the transaction. The callback interface pointer is valid until the transaction is completely finished.
serviceContextGeneral context for the service calls containing information like the session object, return diagnostic mask and timeout hint.
callbackHandleHandle for the method call in the callback.
pMethodHandleMethodHandle provided by the NodeManager::getMethodHandle. This object contains the information needed by the MethodManager to identify the object and the method to call. The object is reference counted. The reference used by the SDK is released after beginCall is returned. If the MethodManager needs the MethodHandle of asynchronous handling, the MethodManager must add its own reference as long as the MethodHandle is used.
inputArgumentsThe list of input arguments for the method call.
Error code

Implemented in OpcUa::ConditionTypeBase, OpcUa::AlarmConditionTypeBase, OpcUa::AcknowledgeableConditionTypeBase, OpcUa::DialogConditionTypeBase, OpcUa::ShelvedStateMachineTypeBase, OpcUa::ProgramStateMachineTypeBase, OpcUa::DataSetReaderTypeBase, OpcUa::BaseObjectType, OpcUa::TrustListTypeBase, OpcUa::NamespaceMetadataType, OpcUa::AddressSpaceFileType, OpcUa::WriterGroupTypeBase, OpcUa::FileTransferStateMachineTypeBase, OpcUa::PubSubConnectionTypeBase, OpcUa::CertificateGroupType, OpcUa::DataSetWriterTypeBase, OpcUa::PublishSubscribeTypeBase, OpcUa::FileDirectoryTypeBase, OpcUa::ReaderGroupTypeBase, OpcUa::ServerConfigurationTypeBase, OpcUa::PublishedDataSetTypeBase, OpcUa::PubSubDiagnosticsTypeBase, OpcUa::AlarmMetricsTypeBase, OpcUa::TemporaryFileTransferTypeBase, OpcUa::DataSetFolderTypeBase, OpcUa::FileTypeBase, OpcUa::RoleTypeBase, OpcUaDi::TopologyElementTypeBase, OpcUaPlc::CtrlConfigurationTypeBase, OpcUaPlc::CtrlResourceTypeBase, OpcUaDi::NetworkTypeBase, OpcUa::AliasNameCategoryTypeBase, OpcUa::TargetVariablesTypeBase, OpcUa::RoleSetTypeBase, OpcUa::PublishedEventsTypeBase, OpcUaDi::LockingServicesTypeBase, OpcUa::SecurityGroupFolderTypeBase, OpcUa::PublishedDataItemsTypeBase, OpcUa::PubSubStatusTypeBase, OpcUa::ExtensionFieldsTypeBase, OpcUa::PubSubKeyServiceTypeBase, and OpcUaDi::TransferServicesTypeBase.

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