Sophie

Sophie

distrib > Mandriva > 8.2 > i586 > media > contrib > by-pkgid > 070b5c05d42a76a25abd916d2fe11a39 > files > 179

ccscript-1.8.4-2mdk.i586.rpm

\section{Script\-Session  Class Reference}
\label{class_scriptsession}\index{ScriptSession@{Script\-Session}}
This class holds an "active" session handler that has been created by a "slow" module handler. active session base class. 


{\tt \#include $<$script.h$>$}

\subsection*{Public Methods}
\begin{CompactItemize}
\item 
virtual void {\bf wait\-Handler} (void)=0
\begin{CompactList}\small\item\em Used to wait for operation completion.\item\end{CompactList}\end{CompactItemize}
\subsection*{Protected Methods}
\begin{CompactItemize}
\item 
void {\bf step\-Scheduler} (const char $\ast$sighandler=NULL)
\begin{CompactList}\small\item\em Notify interpreter callback that the session is complete and pass an optional signal handler for stepping.\item\end{CompactList}\item 
void {\bf sleep\-Scheduler} (timeout\_\-t delay)
\begin{CompactList}\small\item\em Notify interpreter callback that a timed operation is in progress.\item\end{CompactList}\item 
{\bf Script\-Session} ({\bf Script\-Interp} $\ast$interp)
\begin{CompactList}\small\item\em Base constructor.\item\end{CompactList}\item 
virtual {\bf $\sim$Script\-Session} ()
\end{CompactItemize}
\subsection*{Friends}
\begin{CompactItemize}
\item 
class {\bf Script\-Interp}
\end{CompactItemize}


\subsection{Detailed Description}
This class holds an "active" session handler that has been created by a "slow" module handler. active session base class.

This provides a mechanism for active sessions to impliment thread-based callback and thread based session handlers in a generic fashion.

\begin{Desc}
\item[{\bf Author(s): }]\par
 David Sugar $<${\tt dyfet@ostel.com}$>$ \end{Desc}




\subsection{Constructor \& Destructor Documentation}
\index{ScriptSession@{Script\-Session}!ScriptSession@{ScriptSession}}
\index{ScriptSession@{ScriptSession}!ScriptSession@{Script\-Session}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}Script\-Session::Script\-Session ({\bf Script\-Interp} $\ast$ {\em interp})\hspace{0.3cm}{\tt  [protected]}}\label{class_scriptsession_b2}


Base constructor.

\index{ScriptSession@{Script\-Session}!~ScriptSession@{$\sim$ScriptSession}}
\index{~ScriptSession@{$\sim$ScriptSession}!ScriptSession@{Script\-Session}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}Script\-Session::$\sim$Script\-Session ()\hspace{0.3cm}{\tt  [inline, protected, virtual]}}\label{class_scriptsession_b3}




\subsection{Member Function Documentation}
\index{ScriptSession@{Script\-Session}!sleepScheduler@{sleepScheduler}}
\index{sleepScheduler@{sleepScheduler}!ScriptSession@{Script\-Session}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void Script\-Session::sleep\-Scheduler (timeout\_\-t {\em delay})\hspace{0.3cm}{\tt  [protected]}}\label{class_scriptsession_b1}


Notify interpreter callback that a timed operation is in progress.

\begin{Desc}
\item[{\bf Parameters: }]\par
\begin{description}
\item[
{\em time}] delay of operation. \end{description}
\end{Desc}
\index{ScriptSession@{Script\-Session}!stepScheduler@{stepScheduler}}
\index{stepScheduler@{stepScheduler}!ScriptSession@{Script\-Session}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void Script\-Session::step\-Scheduler (const char $\ast$ {\em sighandler} = NULL)\hspace{0.3cm}{\tt  [protected]}}\label{class_scriptsession_b0}


Notify interpreter callback that the session is complete and pass an optional signal handler for stepping.

\begin{Desc}
\item[{\bf Parameters: }]\par
\begin{description}
\item[
{\em optional}] signal handler. \end{description}
\end{Desc}
\index{ScriptSession@{Script\-Session}!waitHandler@{waitHandler}}
\index{waitHandler@{waitHandler}!ScriptSession@{Script\-Session}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void Script\-Session::wait\-Handler (void)\hspace{0.3cm}{\tt  [pure virtual]}}\label{class_scriptsession_a0}


Used to wait for operation completion.



\subsection{Friends And Related Function Documentation}
\index{ScriptSession@{Script\-Session}!ScriptInterp@{ScriptInterp}}
\index{ScriptInterp@{ScriptInterp}!ScriptSession@{Script\-Session}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}class Script\-Interp\hspace{0.3cm}{\tt  [friend]}}\label{class_scriptsession_l0}




The documentation for this class was generated from the following file:\begin{CompactItemize}
\item 
{\bf script.h}\end{CompactItemize}