![]() |
Qore Programming Language Reference Manual 2.1.1
|
Socket poll operation object returned by Socket polling methods. More...
#include <QC_SocketPollOperation.dox.h>
Public Member Functions | |
| constructor (Socket socket, string goal, *hash< auto > opts) | |
| Creates the object with the given goal. | |
| *hash< SocketPollInfo > | continuePoll () |
| Returns a socket poll hash if polling should continue or NOTHING if complete. | |
| copy () | |
| Throws an exception; objects of this class cannot be copied. | |
| destructor () | |
| Destroys the object. | |
Public Member Functions inherited from Qore::SocketPollOperationBase | |
| abort () | |
| Aborts any asynchroous operation in progress and closes the connected object. | |
| constructor () | |
| Throws an exception; this class is not usable by Qore classes. | |
| destructor () | |
| Destroys the object. | |
| string | getGoal () |
| Returns the goal. | |
| auto | getOutput () |
| Returns any output generated by any completed poll action. | |
| string | getState () |
| Returns the current state. | |
| bool | goalReached () |
| Returns True when the goal as been reached. | |
Public Member Functions inherited from Qore::AbstractPollOperation | |
| nothing | abort () |
| Aborts any asynchroous operation in progress and closes the connected object. | |
| abstract *hash< SocketPollInfo > | continuePoll () |
| Returns a socket poll hash if polling should continue or NOTHING if complete. | |
| abstract string | getGoal () |
| Returns the goal. | |
| auto | getOutput () |
| Returns any output generated by any completed poll action. | |
| abstract string | getState () |
| Returns the current state. | |
| abstract bool | goalReached () |
| Returns True when the goal as been reached. | |
Socket poll operation object returned by Socket polling methods.
This class implements the polling logic for Sockets and the state machine behind it
private members:
Creates the object with the given goal.
| socket | the Socket object to poll |
| goal | the type of goal; currently one of:
|
| opts | required keys depend on goal
|
| INVALID-GOAL | thrown if the goal is invalid |
| *hash< SocketPollInfo > Qore::SocketPollOperation::continuePoll | ( | ) |
Returns a socket poll hash if polling should continue or NOTHING if complete.
| Qore::SocketPollOperation::copy | ( | ) |
Throws an exception; objects of this class cannot be copied.
| SOCKETPOLLOPERATION-COPY-ERROR | objects of this class cannot be copied |
| Qore::SocketPollOperation::destructor | ( | ) |
Destroys the object.
Destroys the object