CommandPipe Class Reference
Last updated: 07-Apr-2025
#include <libcom3.h>
Public Member Functions |
|
| CommandPipe () | |
| virtual | ~CommandPipe () |
| enum status::PipeStatus | sendRecv (const vfiipc::JSObject &in, vfiipc::JSObject &out, Milliseconds millis) |
| enum status::PipeStatus | sendRecv (const vfiipc::JSObject &in, vfiipc::JSObject &out, Milliseconds millis, int interruptFD) |
Constructor & Destructor Documentation
◆ CommandPipe()
| CommandPipe | ( | ) |
◆ ~CommandPipe()
|
virtual |
Member Function Documentation
◆ sendRecv() [1/2]
| enum status::PipeStatus sendRecv | ( | const vfiipc::JSObject & | in, |
| vfiipc::JSObject & | out, | ||
| Milliseconds | millis | ||
| ) |
Write a message to the ADKCOM service and receive a response. If the message is interrupted (meaning return code is not OK) the CommandPipe is invalid and should be destroyed.
- Parameters
-
[in] in Command to send (See ADKCOM Programmers Guide) [out] out Response. Will be changed only if return is OK [in] millis Milliseconds to wait for a response
- Returns
- OK in case of success, else failure code
◆ sendRecv() [2/2]
| enum status::PipeStatus sendRecv | ( | const vfiipc::JSObject & | in, |
| vfiipc::JSObject & | out, | ||
| Milliseconds | millis, | ||
| int | interruptFD | ||
| ) |
Write a message to the ADKCOM service and receive a response. If the message is interrupted (meaning return code is not OK) the CommandPipe is invalid and MUST be destroyed.
- Parameters
-
[in] in Command to send (See ADKCOM Programmers Guide) [out] out Response. Will be changed only if return is OK [in] millis Milliseconds to wait for a response [in] interruptFD FD to listen for activity. Once activity is detected the function will return with error code ERR_USER_INTERRUPT.
- Returns
- OK in case of success, else failure code
The documentation for this class was generated from the following file:
- com/src/libcom3.h
Rate this article:
