#include <rpcresult.hpp>
◆ RPCResult() [1/2]
C++ constructor - initialize the object.
- Parameters
-
object | object that implements the result. |
◆ RPCResult() [2/2]
◆ addCallback()
Add callback.
- Parameters
-
callback | to be called when ready. |
- Returns
- subscription handle.
◆ addCallbackEx()
Add callback.
- Parameters
-
callback | to be called when ready. |
- Returns
- subscription handle.
◆ complete()
Completes the object.
Normally this is not meant to be used by RPC users but completion is done internally by the Kanzi Connect framework.
- Parameters
-
rpcresult | the RPC level completion value. |
- Returns
- If completion is done, true. If completion has already been completed, false.
◆ create()
Factory function to create a pending RPC Result object with handle provided.
- Parameters
-
handle | the handle for the object. |
- Returns
- newly created RPCResult instance.
◆ getRPCCallResult()
Retrieve low level rpc status of the method call.
- Returns
- RPC status.
◆ getValue()
Return the value of a call. Will block calling thread if remote-call is not complete yet.
◆ invalidate()
Releases all the referenced resources. After calling this it is not safe to access any other methods except the valid().
◆ isComplete()
Check has call completed.
- Returns
- true if completed.
◆ isLinkBroken()
Has the link been broken and caused the RPC call to terminate.
- Returns
- true if link was broken and caused the operation to fail because if that.
◆ isTimedOut()
Has the request been timed out.
- Returns
- true if timed out.
◆ object()
Gets access to contained object.
In general there should be no need to access the object directly.
- Returns
- Implementation object.
◆ removeCallback()
Remove a callback.
- Parameters
-
token | subscription to remove. |
◆ setTimeout()
Sets the timeout after which the operation is completed locally with timed-out status.
- Parameters
-
◆ valid()
is object OK
- Returns
- true if ok.
◆ waitComplete()
Wait until complete.
- Parameters
-
ms | maximum amount of milliseconds to wait. |
- Returns
- true if call became ready. false if still pending.
◆ RPCCallStore
◆ RPCResultImpl< void >
The documentation for this class was generated from the following file: