\hypertarget{class_qore_1_1_socket_poll_operation_base}{}\doxysection{Qore\+::Socket\+Poll\+Operation\+Base Class Reference}
\label{class_qore_1_1_socket_poll_operation_base}\index{Qore::SocketPollOperationBase@{Qore::SocketPollOperationBase}}


Abstract poll operation object returned by \mbox{\hyperlink{class_qore_1_1_socket}{Socket}} polling methods.  




{\ttfamily \#include $<$QC\+\_\+\+Socket\+Poll\+Operation\+Base.\+dox.\+h$>$}



Inheritance diagram for Qore\+::Socket\+Poll\+Operation\+Base\+:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=248pt]{class_qore_1_1_socket_poll_operation_base__inherit__graph}
\end{center}
\end{figure}
\doxysubsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
\mbox{\hyperlink{class_qore_1_1_socket_poll_operation_base_a2863ddf1388ff75a674996043dbcff95}{constructor}} ()
\begin{DoxyCompactList}\small\item\em Throws an exception; this class is not usable by Qore classes. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{class_qore_1_1_socket_poll_operation_base_a053ae019e8a3c8b9e1da745595d08297}\label{class_qore_1_1_socket_poll_operation_base_a053ae019e8a3c8b9e1da745595d08297}} 
{\bfseries destructor} ()
\begin{DoxyCompactList}\small\item\em Destroys the object. \end{DoxyCompactList}\item 
\mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}} \mbox{\hyperlink{class_qore_1_1_socket_poll_operation_base_a645bae22e4183731d1fabaf85a6ea5ce}{get\+Goal}} ()
\begin{DoxyCompactList}\small\item\em Returns the goal. \end{DoxyCompactList}\item 
auto \mbox{\hyperlink{class_qore_1_1_socket_poll_operation_base_ab758c1aae5660aa47655970716897bc8}{get\+Output}} ()
\begin{DoxyCompactList}\small\item\em Returns any output generated by any completed poll action. \end{DoxyCompactList}\item 
\mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}} \mbox{\hyperlink{class_qore_1_1_socket_poll_operation_base_a9e5f446404014fd691a451747dc492b5}{get\+State}} ()
\begin{DoxyCompactList}\small\item\em Returns the current state. \end{DoxyCompactList}\item 
bool \mbox{\hyperlink{class_qore_1_1_socket_poll_operation_base_a501f69cc3437f52154efd3b4b2a7e483}{goal\+Reached}} ()
\begin{DoxyCompactList}\small\item\em Returns \mbox{\hyperlink{basic_data_types_True}{True}} when the goal as been reached. \end{DoxyCompactList}\end{DoxyCompactItemize}


\doxysubsection{Detailed Description}
Abstract poll operation object returned by \mbox{\hyperlink{class_qore_1_1_socket}{Socket}} polling methods. 

This class implements the polling logic and the state machine behind it

It has two private members\+:
\begin{DoxyItemize}
\item object sock\+: the socket object
\item string goal\+: the polling goal
\end{DoxyItemize}

This class is only usable by internal classes; it is not directly usable by Qore classes.

\begin{DoxySince}{Since}
Qore 1.\+12 
\end{DoxySince}


\doxysubsection{Member Function Documentation}
\mbox{\Hypertarget{class_qore_1_1_socket_poll_operation_base_a2863ddf1388ff75a674996043dbcff95}\label{class_qore_1_1_socket_poll_operation_base_a2863ddf1388ff75a674996043dbcff95}} 
\index{Qore::SocketPollOperationBase@{Qore::SocketPollOperationBase}!constructor@{constructor}}
\index{constructor@{constructor}!Qore::SocketPollOperationBase@{Qore::SocketPollOperationBase}}
\doxysubsubsection{\texorpdfstring{constructor()}{constructor()}}
{\footnotesize\ttfamily Qore\+::\+Socket\+Poll\+Operation\+Base\+::constructor (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})}



Throws an exception; this class is not usable by Qore classes. 


\begin{DoxyExceptions}{Exceptions}
{\em INTERNAL-\/\+ONLY} & this class is not usable by Qore classes \\
\hline
\end{DoxyExceptions}
\mbox{\Hypertarget{class_qore_1_1_socket_poll_operation_base_a645bae22e4183731d1fabaf85a6ea5ce}\label{class_qore_1_1_socket_poll_operation_base_a645bae22e4183731d1fabaf85a6ea5ce}} 
\index{Qore::SocketPollOperationBase@{Qore::SocketPollOperationBase}!getGoal@{getGoal}}
\index{getGoal@{getGoal}!Qore::SocketPollOperationBase@{Qore::SocketPollOperationBase}}
\doxysubsubsection{\texorpdfstring{getGoal()}{getGoal()}}
{\footnotesize\ttfamily \mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}} Qore\+::\+Socket\+Poll\+Operation\+Base\+::get\+Goal (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



Returns the goal. 

\begin{DoxyReturn}{Returns}
the goal set in the constructor 
\end{DoxyReturn}


Implements \mbox{\hyperlink{class_qore_1_1_abstract_poll_operation_a46b995e33768d41251f6d1b753c5099d}{Qore\+::\+Abstract\+Poll\+Operation}}.

\mbox{\Hypertarget{class_qore_1_1_socket_poll_operation_base_ab758c1aae5660aa47655970716897bc8}\label{class_qore_1_1_socket_poll_operation_base_ab758c1aae5660aa47655970716897bc8}} 
\index{Qore::SocketPollOperationBase@{Qore::SocketPollOperationBase}!getOutput@{getOutput}}
\index{getOutput@{getOutput}!Qore::SocketPollOperationBase@{Qore::SocketPollOperationBase}}
\doxysubsubsection{\texorpdfstring{getOutput()}{getOutput()}}
{\footnotesize\ttfamily auto Qore\+::\+Socket\+Poll\+Operation\+Base\+::get\+Output (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})}



Returns any output generated by any completed poll action. 

\begin{DoxyParagraph}{Code Flags\+:}
\mbox{\hyperlink{code_flags_RET_VALUE_ONLY}{RET\+\_\+\+VALUE\+\_\+\+ONLY}}
\end{DoxyParagraph}
\begin{DoxyReturn}{Returns}
any output generated by any completed poll action 
\end{DoxyReturn}
\mbox{\Hypertarget{class_qore_1_1_socket_poll_operation_base_a9e5f446404014fd691a451747dc492b5}\label{class_qore_1_1_socket_poll_operation_base_a9e5f446404014fd691a451747dc492b5}} 
\index{Qore::SocketPollOperationBase@{Qore::SocketPollOperationBase}!getState@{getState}}
\index{getState@{getState}!Qore::SocketPollOperationBase@{Qore::SocketPollOperationBase}}
\doxysubsubsection{\texorpdfstring{getState()}{getState()}}
{\footnotesize\ttfamily \mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}} Qore\+::\+Socket\+Poll\+Operation\+Base\+::get\+State (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



Returns the current state. 

\begin{DoxyParagraph}{Code Flags\+:}
\mbox{\hyperlink{code_flags_RET_VALUE_ONLY}{RET\+\_\+\+VALUE\+\_\+\+ONLY}}
\end{DoxyParagraph}
\begin{DoxyReturn}{Returns}
the current state 
\end{DoxyReturn}


Implements \mbox{\hyperlink{class_qore_1_1_abstract_poll_operation_a0cd79187e58d30ad6f97857f564d5c2a}{Qore\+::\+Abstract\+Poll\+Operation}}.

\mbox{\Hypertarget{class_qore_1_1_socket_poll_operation_base_a501f69cc3437f52154efd3b4b2a7e483}\label{class_qore_1_1_socket_poll_operation_base_a501f69cc3437f52154efd3b4b2a7e483}} 
\index{Qore::SocketPollOperationBase@{Qore::SocketPollOperationBase}!goalReached@{goalReached}}
\index{goalReached@{goalReached}!Qore::SocketPollOperationBase@{Qore::SocketPollOperationBase}}
\doxysubsubsection{\texorpdfstring{goalReached()}{goalReached()}}
{\footnotesize\ttfamily bool Qore\+::\+Socket\+Poll\+Operation\+Base\+::goal\+Reached (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



Returns \mbox{\hyperlink{basic_data_types_True}{True}} when the goal as been reached. 

\begin{DoxyParagraph}{Code Flags\+:}
\mbox{\hyperlink{code_flags_RET_VALUE_ONLY}{RET\+\_\+\+VALUE\+\_\+\+ONLY}}
\end{DoxyParagraph}
\begin{DoxyReturn}{Returns}
\mbox{\hyperlink{basic_data_types_True}{True}} when the goal as been reached 
\end{DoxyReturn}


Implements \mbox{\hyperlink{class_qore_1_1_abstract_poll_operation_a2b0929fc4b93ae1074bcc6673feb8630}{Qore\+::\+Abstract\+Poll\+Operation}}.