NetworkTables Remote Procedure Call.
More...
#include <RpcCall.h>
NetworkTables Remote Procedure Call.
◆ RpcCall()
| nt::RpcCall::RpcCall |
( |
NT_Entry |
entry, |
|
|
NT_RpcCall |
call |
|
) |
| |
|
inline |
Construct from native handles.
- Parameters
-
| entry | Entry handle |
| call | Call handle |
◆ ~RpcCall()
| nt::RpcCall::~RpcCall |
( |
| ) |
|
|
inline |
Destructor.
Cancels the result if no other action taken.
◆ CancelResult()
| void nt::RpcCall::CancelResult |
( |
| ) |
|
|
inline |
Ignore the result.
This function is non-blocking.
◆ GetCall()
| NT_RpcCall nt::RpcCall::GetCall |
( |
| ) |
const |
|
inline |
Get the call native handle.
- Returns
- Native handle.
◆ GetEntry()
◆ GetResult() [1/2]
| bool nt::RpcCall::GetResult |
( |
std::string * |
result | ) |
|
|
inline |
Get the result (return value).
This function blocks until the result is received.
- Parameters
-
| result | received result (output) |
- Returns
- False on error, true otherwise.
◆ GetResult() [2/2]
| bool nt::RpcCall::GetResult |
( |
std::string * |
result, |
|
|
double |
timeout, |
|
|
bool * |
timed_out |
|
) |
| |
|
inline |
Get the result (return value).
This function blocks until the result is received or it times out.
- Parameters
-
| result | received result (output) |
| timeout | timeout, in seconds |
| timed_out | true if the timeout period elapsed (output) |
- Returns
- False on error or timeout, true otherwise.
◆ operator bool()
| nt::RpcCall::operator bool |
( |
| ) |
const |
|
inlineexplicit |
Determines if the native handle is valid.
- Returns
- True if the native handle is valid, false otherwise.
The documentation for this class was generated from the following files:
- /__w/1/s/ntcore/src/main/native/include/networktables/RpcCall.h
- /__w/1/s/ntcore/src/main/native/include/networktables/RpcCall.inl