Call service

Collaboration diagram for Call service:

Detailed Description

This Service is used to call (invoke) a list of methods.

See also

https://reference.opcfoundation.org/Core/Part4/v105/docs/5.12.2

Functions
CallResponse	opcua::services::call (Client &connection, const CallRequest &request) noexcept
template<typename CompletionToken >
auto	opcua::services::callAsync (Client &connection, const CallRequest &request, CompletionToken &&token)
template<typename T >
CallMethodResult	opcua::services::call (T &connection, const NodeId &objectId, const NodeId &methodId, Span< const Variant > inputArguments) noexcept
template<typename CompletionToken >
auto	opcua::services::callAsync (Client &connection, const NodeId &objectId, const NodeId &methodId, Span< const Variant > inputArguments, CompletionToken &&token)

Function Documentation

call() [1/2]

CallResponse opcua::services::call ( Client &  connection, const CallRequest &  request  )

noexcept

Call server methods.

Parameters

connection	Instance of type Client
request	Call request

Referenced by opcua::Node< Connection >::callMethod().

call() [2/2]

template<typename T >

CallMethodResult opcua::services::call ( T &  connection, const NodeId &  objectId, const NodeId &  methodId, Span< const Variant >  inputArguments  )

noexcept

Call a server method.

The objectId must have a HasComponent reference to the method specified in methodId.

Parameters

connection	Instance of type Server or Client
objectId	NodeId of the object on which the method is invoked
methodId	NodeId of the method to invoke
inputArguments	Input argument values

callAsync() [1/2]

template<typename CompletionToken >

auto opcua::services::callAsync	(	Client &	connection,
		const CallRequest &	request,
		CompletionToken &&	token
	)

Call server methods.

Parameters

connection	Instance of type Client
request	Call request
token	The completion token that will be used to produce a completion handler, which will be called when the operation completes. Potential completion tokens include useFuture, useDeferred, useDetached, or a function (object) with the correct completion signature. The function signature of the completion handler must be: void(CallResponse&)

Returns

• void if token is a callback function (object)
• std::future<CallResponse> if token is of type UseFutureToken
• auto(auto&& token) callable for deferred execution if token is of type UseDeferredToken
• void if token is of type UseDetachedToken

Definition at line 49 of file method.hpp.

Referenced by opcua::services::callAsync().

callAsync() [2/2]

template<typename CompletionToken >

auto opcua::services::callAsync	(	Client &	connection,
		const NodeId &	objectId,
		const NodeId &	methodId,
		Span< const Variant >	inputArguments,
		CompletionToken &&	token
	)

Call a server method.

The objectId must have a HasComponent reference to the method specified in methodId.

Parameters

connection	Instance of type Server or Client
objectId	NodeId of the object on which the method is invoked
methodId	NodeId of the method to invoke
inputArguments	Input argument values
token	The completion token that will be used to produce a completion handler, which will be called when the operation completes. Potential completion tokens include useFuture, useDeferred, useDetached, or a function (object) with the correct completion signature. The function signature of the completion handler must be: void(CallMethodResult&)

Returns

• void if token is a callback function (object)
• std::future<CallMethodResult> if token is of type UseFutureToken
• auto(auto&& token) callable for deferred execution if token is of type UseDeferredToken
• void if token is of type UseDetachedToken

Definition at line 78 of file method.hpp.