\hypertarget{classFileTransferList}{
\section{FileTransferList Class Reference}
\label{classFileTransferList}\index{FileTransferList@{FileTransferList}}
}


Maintains a global file transfer processing list.  


{\ttfamily \#include $<$filetransferlist.h$>$}\subsection*{Signals}
\begin{DoxyCompactItemize}
\item 
\hypertarget{classFileTransferList_afbdd0388fac6b596890d99ec5f464044}{
void \hyperlink{classFileTransferList_afbdd0388fac6b596890d99ec5f464044}{onUpdateStatus} (QString id)}
\label{classFileTransferList_afbdd0388fac6b596890d99ec5f464044}

\begin{DoxyCompactList}\small\item\em This signal is sent when there is updates in file processing. \item\end{DoxyCompactList}\item 
\hypertarget{classFileTransferList_a17e783d79b2e1da1ddd6b0e9fa96ef3a}{
void \hyperlink{classFileTransferList_a17e783d79b2e1da1ddd6b0e9fa96ef3a}{onAddTransfer} (QString id)}
\label{classFileTransferList_a17e783d79b2e1da1ddd6b0e9fa96ef3a}

\begin{DoxyCompactList}\small\item\em This signal is sent when a file transfer is added to the list. \item\end{DoxyCompactList}\item 
\hypertarget{classFileTransferList_af811955a9169c82feb92cfec90b75b45}{
void \hyperlink{classFileTransferList_af811955a9169c82feb92cfec90b75b45}{onRemoveTransfer} (QString id)}
\label{classFileTransferList_af811955a9169c82feb92cfec90b75b45}

\begin{DoxyCompactList}\small\item\em This signal is sent when a file transfer is removed from the list. \item\end{DoxyCompactList}\end{DoxyCompactItemize}
\subsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
void \hyperlink{classFileTransferList_a92ad0c960ff3a7d3a37a28bcd8dd0bbb}{processTransfers} ()
\begin{DoxyCompactList}\small\item\em Drives the file transfer processing. \item\end{DoxyCompactList}\item 
\hypertarget{classFileTransferList_a13ab77c4af630e6563f0039f2e24a771}{
void \hyperlink{classFileTransferList_a13ab77c4af630e6563f0039f2e24a771}{setProcessingThread} (\hyperlink{classFileTransferProcessingThread}{FileTransferProcessingThread} $\ast$processingThread)}
\label{classFileTransferList_a13ab77c4af630e6563f0039f2e24a771}

\begin{DoxyCompactList}\small\item\em Sets the file processing thread used. \item\end{DoxyCompactList}\item 
\hypertarget{classFileTransferList_a06757dd68340af3857b3d80fbe647266}{
void \hyperlink{classFileTransferList_a06757dd68340af3857b3d80fbe647266}{addTransfer} (\hyperlink{classFileTransfer}{FileTransfer} $\ast$fileTransfer)}
\label{classFileTransferList_a06757dd68340af3857b3d80fbe647266}

\begin{DoxyCompactList}\small\item\em Adds a \hyperlink{classFileTransfer}{FileTransfer} object to the list. \item\end{DoxyCompactList}\item 
\hypertarget{classFileTransferList_ae6d85b1fcf8745ee7845a215c3231bb0}{
void \hyperlink{classFileTransferList_ae6d85b1fcf8745ee7845a215c3231bb0}{removeTransfer} (\hyperlink{classFileTransfer}{FileTransfer} $\ast$fileTransfer)}
\label{classFileTransferList_ae6d85b1fcf8745ee7845a215c3231bb0}

\begin{DoxyCompactList}\small\item\em Remove a \hyperlink{classFileTransfer}{FileTransfer} object from the list. \item\end{DoxyCompactList}\item 
\hyperlink{classFileTransfer}{FileTransfer} $\ast$ \hyperlink{classFileTransferList_a1e3efea6feca070a33cfa06c562db4ee}{getTransfer} (int i)
\begin{DoxyCompactList}\small\item\em Return a \hyperlink{classFileTransfer}{FileTransfer} object from the list. \item\end{DoxyCompactList}\item 
\hypertarget{classFileTransferList_a1ad8accb2800e44c09c16fa99a588e50}{
int \hyperlink{classFileTransferList_a1ad8accb2800e44c09c16fa99a588e50}{getTransferCount} ()}
\label{classFileTransferList_a1ad8accb2800e44c09c16fa99a588e50}

\begin{DoxyCompactList}\small\item\em Returns the size of the transfer list. \item\end{DoxyCompactList}\item 
\hyperlink{classFileTransfer}{FileTransfer} $\ast$ \hyperlink{classFileTransferList_aa05b78a7cd83387e58d08b463268a4bb}{getTransfer} (QString id)
\begin{DoxyCompactList}\small\item\em Return a transfer object with a given id. \item\end{DoxyCompactList}\item 
void \hyperlink{classFileTransferList_a0d72c3c65be6dcbaea683e3019f930e8}{cancelAllTransfers} ()
\begin{DoxyCompactList}\small\item\em Cancels all idle transfers. \item\end{DoxyCompactList}\item 
void \hyperlink{classFileTransferList_a6a920922327d51ffa0bab686ad8bdf70}{updateStatus} (QString id, unsigned long transferred, unsigned long totalSize)
\begin{DoxyCompactList}\small\item\em Updates the file transfer statistics of a \hyperlink{classFileTransfer}{FileTransfer} object. \item\end{DoxyCompactList}\item 
void \hyperlink{classFileTransferList_a38b007b915766aa77e9e29e05ea8bd6a}{pauseProcessing} ()
\begin{DoxyCompactList}\small\item\em Pauses all file transfer processing. \item\end{DoxyCompactList}\item 
void \hyperlink{classFileTransferList_a2651f7a2fffd03a606441118cda14159}{resumeProcessing} ()
\begin{DoxyCompactList}\small\item\em Resumes file transfer processing. \item\end{DoxyCompactList}\end{DoxyCompactItemize}
\subsection*{Static Public Member Functions}
\begin{DoxyCompactItemize}
\item 
\hypertarget{classFileTransferList_a46a19ec5aa8cef69d7fa43de260efe6f}{
static \hyperlink{classFileTransferList}{FileTransferList} $\ast$ \hyperlink{classFileTransferList_a46a19ec5aa8cef69d7fa43de260efe6f}{instance} ()}
\label{classFileTransferList_a46a19ec5aa8cef69d7fa43de260efe6f}

\begin{DoxyCompactList}\small\item\em Returns the global \hyperlink{classFileTransferList}{FileTransferList} instance. \item\end{DoxyCompactList}\item 
\hypertarget{classFileTransferList_a4d134827268a8652edb1272899ed6177}{
static void \hyperlink{classFileTransferList_a4d134827268a8652edb1272899ed6177}{drop} ()}
\label{classFileTransferList_a4d134827268a8652edb1272899ed6177}

\begin{DoxyCompactList}\small\item\em Shuts down the global \hyperlink{classFileTransferList}{FileTransferList} instance. \item\end{DoxyCompactList}\end{DoxyCompactItemize}


\subsection{Detailed Description}
Maintains a global file transfer processing list. 

\subsection{Member Function Documentation}
\hypertarget{classFileTransferList_a0d72c3c65be6dcbaea683e3019f930e8}{
\index{FileTransferList@{FileTransferList}!cancelAllTransfers@{cancelAllTransfers}}
\index{cancelAllTransfers@{cancelAllTransfers}!FileTransferList@{FileTransferList}}
\subsubsection[{cancelAllTransfers}]{\setlength{\rightskip}{0pt plus 5cm}void FileTransferList::cancelAllTransfers ()}}
\label{classFileTransferList_a0d72c3c65be6dcbaea683e3019f930e8}


Cancels all idle transfers. Due to limitiations in the current ARC API active transfers cannot be cancelled. Idle transfers are removed and destroyed from the list. \hypertarget{classFileTransferList_aa05b78a7cd83387e58d08b463268a4bb}{
\index{FileTransferList@{FileTransferList}!getTransfer@{getTransfer}}
\index{getTransfer@{getTransfer}!FileTransferList@{FileTransferList}}
\subsubsection[{getTransfer}]{\setlength{\rightskip}{0pt plus 5cm}{\bf FileTransfer} $\ast$ FileTransferList::getTransfer (QString {\em id})}}
\label{classFileTransferList_aa05b78a7cd83387e58d08b463268a4bb}


Return a transfer object with a given id. 
\begin{DoxyParams}{Parameters}
\item[{\em id}]string representing the \hyperlink{classFileTransfer}{FileTransfer} object. \end{DoxyParams}
\begin{DoxyReturn}{Returns}
a valid FilaTransfer object if the id of the \hyperlink{classFileTransfer}{FileTransfer} object is found, otherwise return a null object. 
\end{DoxyReturn}
\hypertarget{classFileTransferList_a1e3efea6feca070a33cfa06c562db4ee}{
\index{FileTransferList@{FileTransferList}!getTransfer@{getTransfer}}
\index{getTransfer@{getTransfer}!FileTransferList@{FileTransferList}}
\subsubsection[{getTransfer}]{\setlength{\rightskip}{0pt plus 5cm}{\bf FileTransfer} $\ast$ FileTransferList::getTransfer (int {\em i})}}
\label{classFileTransferList_a1e3efea6feca070a33cfa06c562db4ee}


Return a \hyperlink{classFileTransfer}{FileTransfer} object from the list. 
\begin{DoxyParams}{Parameters}
\item[{\em i}]is the position in the list. \end{DoxyParams}
\begin{DoxyReturn}{Returns}
a valid \hyperlink{classFileTransfer}{FileTransfer} object. If i is outside the list a null pointer is returned. 
\end{DoxyReturn}
\hypertarget{classFileTransferList_a38b007b915766aa77e9e29e05ea8bd6a}{
\index{FileTransferList@{FileTransferList}!pauseProcessing@{pauseProcessing}}
\index{pauseProcessing@{pauseProcessing}!FileTransferList@{FileTransferList}}
\subsubsection[{pauseProcessing}]{\setlength{\rightskip}{0pt plus 5cm}void FileTransferList::pauseProcessing ()}}
\label{classFileTransferList_a38b007b915766aa77e9e29e05ea8bd6a}


Pauses all file transfer processing. This method pauses transfer processing by pausing the \hyperlink{classFileTransferProcessingThread}{FileTransferProcessingThread} thread. Active file processing tasks can't be paused. \hypertarget{classFileTransferList_a92ad0c960ff3a7d3a37a28bcd8dd0bbb}{
\index{FileTransferList@{FileTransferList}!processTransfers@{processTransfers}}
\index{processTransfers@{processTransfers}!FileTransferList@{FileTransferList}}
\subsubsection[{processTransfers}]{\setlength{\rightskip}{0pt plus 5cm}void FileTransferList::processTransfers ()}}
\label{classFileTransferList_a92ad0c960ff3a7d3a37a28bcd8dd0bbb}


Drives the file transfer processing. This method checks for idle file transfer objects. If there are slots available, idle tasks are executed. The method is called by the \hyperlink{classFileTransferProcessingThread}{FileTransferProcessingThread}. \hypertarget{classFileTransferList_a2651f7a2fffd03a606441118cda14159}{
\index{FileTransferList@{FileTransferList}!resumeProcessing@{resumeProcessing}}
\index{resumeProcessing@{resumeProcessing}!FileTransferList@{FileTransferList}}
\subsubsection[{resumeProcessing}]{\setlength{\rightskip}{0pt plus 5cm}void FileTransferList::resumeProcessing ()}}
\label{classFileTransferList_a2651f7a2fffd03a606441118cda14159}


Resumes file transfer processing. Resumes file transfer processing by resuming the \hyperlink{classFileTransferProcessingThread}{FileTransferProcessingThread} thread. \hypertarget{classFileTransferList_a6a920922327d51ffa0bab686ad8bdf70}{
\index{FileTransferList@{FileTransferList}!updateStatus@{updateStatus}}
\index{updateStatus@{updateStatus}!FileTransferList@{FileTransferList}}
\subsubsection[{updateStatus}]{\setlength{\rightskip}{0pt plus 5cm}void FileTransferList::updateStatus (QString {\em id}, \/  unsigned long {\em transferred}, \/  unsigned long {\em totalSize})}}
\label{classFileTransferList_a6a920922327d51ffa0bab686ad8bdf70}


Updates the file transfer statistics of a \hyperlink{classFileTransfer}{FileTransfer} object. This method is called from the ARC progress callbacks for updating file transfer status. The method is public to be able to be accessed from a static callback and should not be called directly. 
\begin{DoxyParams}{Parameters}
\item[{\em id}]of \hyperlink{classFileTransfer}{FileTransfer} object. \item[{\em transferred}]currently transferred bytes. \item[{\em totalSize}]total size of transfer. \end{DoxyParams}


The documentation for this class was generated from the following files:\begin{DoxyCompactItemize}
\item 
/home/jonas/Development/arc-\/gui-\/clients/src/arcstorage-\/ui/filetransferlist.h\item 
/home/jonas/Development/arc-\/gui-\/clients/src/arcstorage-\/ui/filetransferlist.cpp\end{DoxyCompactItemize}
