← Back to branch summary

~ubuntu-branches/ubuntu/trusty/arc-gui-clients/trusty

« back to all changes in this revision

Viewing changes to docs/doxygen/output/latex/classFileTransferList.tex

  • Committer: Package Import Robot
  • Author(s): Mattias Ellert
  • Date: 2013-05-08 22:45:38 UTC
  • mfrom: (1.1.1)
  • Revision ID: package-import@ubuntu.com-20130508224538-7kfhy97fg7ncfck0
Tags: 0.4.3-1
New release

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/doxygen/output/latex/classFileTransferList.tex
 
1
\hypertarget{classFileTransferList}{
 
2
\section{FileTransferList Class Reference}
 
3
\label{classFileTransferList}\index{FileTransferList@{FileTransferList}}
 
4
}
 
5
 
 
6
 
 
7
Maintains a global file transfer processing list.  
 
8
 
 
9
 
 
10
{\ttfamily \#include $<$filetransferlist.h$>$}\subsection*{Signals}
 
11
\begin{DoxyCompactItemize}
 
12
\item 
 
13
\hypertarget{classFileTransferList_afbdd0388fac6b596890d99ec5f464044}{
 
14
void \hyperlink{classFileTransferList_afbdd0388fac6b596890d99ec5f464044}{onUpdateStatus} (QString id)}
 
15
\label{classFileTransferList_afbdd0388fac6b596890d99ec5f464044}
 
16
 
 
17
\begin{DoxyCompactList}\small\item\em This signal is sent when there is updates in file processing. \item\end{DoxyCompactList}\item 
 
18
\hypertarget{classFileTransferList_a17e783d79b2e1da1ddd6b0e9fa96ef3a}{
 
19
void \hyperlink{classFileTransferList_a17e783d79b2e1da1ddd6b0e9fa96ef3a}{onAddTransfer} (QString id)}
 
20
\label{classFileTransferList_a17e783d79b2e1da1ddd6b0e9fa96ef3a}
 
21
 
 
22
\begin{DoxyCompactList}\small\item\em This signal is sent when a file transfer is added to the list. \item\end{DoxyCompactList}\item 
 
23
\hypertarget{classFileTransferList_af811955a9169c82feb92cfec90b75b45}{
 
24
void \hyperlink{classFileTransferList_af811955a9169c82feb92cfec90b75b45}{onRemoveTransfer} (QString id)}
 
25
\label{classFileTransferList_af811955a9169c82feb92cfec90b75b45}
 
26
 
 
27
\begin{DoxyCompactList}\small\item\em This signal is sent when a file transfer is removed from the list. \item\end{DoxyCompactList}\end{DoxyCompactItemize}
 
28
\subsection*{Public Member Functions}
 
29
\begin{DoxyCompactItemize}
 
30
\item 
 
31
void \hyperlink{classFileTransferList_a92ad0c960ff3a7d3a37a28bcd8dd0bbb}{processTransfers} ()
 
32
\begin{DoxyCompactList}\small\item\em Drives the file transfer processing. \item\end{DoxyCompactList}\item 
 
33
\hypertarget{classFileTransferList_a13ab77c4af630e6563f0039f2e24a771}{
 
34
void \hyperlink{classFileTransferList_a13ab77c4af630e6563f0039f2e24a771}{setProcessingThread} (\hyperlink{classFileTransferProcessingThread}{FileTransferProcessingThread} $\ast$processingThread)}
 
35
\label{classFileTransferList_a13ab77c4af630e6563f0039f2e24a771}
 
36
 
 
37
\begin{DoxyCompactList}\small\item\em Sets the file processing thread used. \item\end{DoxyCompactList}\item 
 
38
\hypertarget{classFileTransferList_a06757dd68340af3857b3d80fbe647266}{
 
39
void \hyperlink{classFileTransferList_a06757dd68340af3857b3d80fbe647266}{addTransfer} (\hyperlink{classFileTransfer}{FileTransfer} $\ast$fileTransfer)}
 
40
\label{classFileTransferList_a06757dd68340af3857b3d80fbe647266}
 
41
 
 
42
\begin{DoxyCompactList}\small\item\em Adds a \hyperlink{classFileTransfer}{FileTransfer} object to the list. \item\end{DoxyCompactList}\item 
 
43
\hypertarget{classFileTransferList_ae6d85b1fcf8745ee7845a215c3231bb0}{
 
44
void \hyperlink{classFileTransferList_ae6d85b1fcf8745ee7845a215c3231bb0}{removeTransfer} (\hyperlink{classFileTransfer}{FileTransfer} $\ast$fileTransfer)}
 
45
\label{classFileTransferList_ae6d85b1fcf8745ee7845a215c3231bb0}
 
46
 
 
47
\begin{DoxyCompactList}\small\item\em Remove a \hyperlink{classFileTransfer}{FileTransfer} object from the list. \item\end{DoxyCompactList}\item 
 
48
\hyperlink{classFileTransfer}{FileTransfer} $\ast$ \hyperlink{classFileTransferList_a1e3efea6feca070a33cfa06c562db4ee}{getTransfer} (int i)
 
49
\begin{DoxyCompactList}\small\item\em Return a \hyperlink{classFileTransfer}{FileTransfer} object from the list. \item\end{DoxyCompactList}\item 
 
50
\hypertarget{classFileTransferList_a1ad8accb2800e44c09c16fa99a588e50}{
 
51
int \hyperlink{classFileTransferList_a1ad8accb2800e44c09c16fa99a588e50}{getTransferCount} ()}
 
52
\label{classFileTransferList_a1ad8accb2800e44c09c16fa99a588e50}
 
53
 
 
54
\begin{DoxyCompactList}\small\item\em Returns the size of the transfer list. \item\end{DoxyCompactList}\item 
 
55
\hyperlink{classFileTransfer}{FileTransfer} $\ast$ \hyperlink{classFileTransferList_aa05b78a7cd83387e58d08b463268a4bb}{getTransfer} (QString id)
 
56
\begin{DoxyCompactList}\small\item\em Return a transfer object with a given id. \item\end{DoxyCompactList}\item 
 
57
void \hyperlink{classFileTransferList_a0d72c3c65be6dcbaea683e3019f930e8}{cancelAllTransfers} ()
 
58
\begin{DoxyCompactList}\small\item\em Cancels all idle transfers. \item\end{DoxyCompactList}\item 
 
59
void \hyperlink{classFileTransferList_a6a920922327d51ffa0bab686ad8bdf70}{updateStatus} (QString id, unsigned long transferred, unsigned long totalSize)
 
60
\begin{DoxyCompactList}\small\item\em Updates the file transfer statistics of a \hyperlink{classFileTransfer}{FileTransfer} object. \item\end{DoxyCompactList}\item 
 
61
void \hyperlink{classFileTransferList_a38b007b915766aa77e9e29e05ea8bd6a}{pauseProcessing} ()
 
62
\begin{DoxyCompactList}\small\item\em Pauses all file transfer processing. \item\end{DoxyCompactList}\item 
 
63
void \hyperlink{classFileTransferList_a2651f7a2fffd03a606441118cda14159}{resumeProcessing} ()
 
64
\begin{DoxyCompactList}\small\item\em Resumes file transfer processing. \item\end{DoxyCompactList}\end{DoxyCompactItemize}
 
65
\subsection*{Static Public Member Functions}
 
66
\begin{DoxyCompactItemize}
 
67
\item 
 
68
\hypertarget{classFileTransferList_a46a19ec5aa8cef69d7fa43de260efe6f}{
 
69
static \hyperlink{classFileTransferList}{FileTransferList} $\ast$ \hyperlink{classFileTransferList_a46a19ec5aa8cef69d7fa43de260efe6f}{instance} ()}
 
70
\label{classFileTransferList_a46a19ec5aa8cef69d7fa43de260efe6f}
 
71
 
 
72
\begin{DoxyCompactList}\small\item\em Returns the global \hyperlink{classFileTransferList}{FileTransferList} instance. \item\end{DoxyCompactList}\item 
 
73
\hypertarget{classFileTransferList_a4d134827268a8652edb1272899ed6177}{
 
74
static void \hyperlink{classFileTransferList_a4d134827268a8652edb1272899ed6177}{drop} ()}
 
75
\label{classFileTransferList_a4d134827268a8652edb1272899ed6177}
 
76
 
 
77
\begin{DoxyCompactList}\small\item\em Shuts down the global \hyperlink{classFileTransferList}{FileTransferList} instance. \item\end{DoxyCompactList}\end{DoxyCompactItemize}
 
78
 
 
79
 
 
80
\subsection{Detailed Description}
 
81
Maintains a global file transfer processing list. 
 
82
 
 
83
\subsection{Member Function Documentation}
 
84
\hypertarget{classFileTransferList_a0d72c3c65be6dcbaea683e3019f930e8}{
 
85
\index{FileTransferList@{FileTransferList}!cancelAllTransfers@{cancelAllTransfers}}
 
86
\index{cancelAllTransfers@{cancelAllTransfers}!FileTransferList@{FileTransferList}}
 
87
\subsubsection[{cancelAllTransfers}]{\setlength{\rightskip}{0pt plus 5cm}void FileTransferList::cancelAllTransfers ()}}
 
88
\label{classFileTransferList_a0d72c3c65be6dcbaea683e3019f930e8}
 
89
 
 
90
 
 
91
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}{
 
92
\index{FileTransferList@{FileTransferList}!getTransfer@{getTransfer}}
 
93
\index{getTransfer@{getTransfer}!FileTransferList@{FileTransferList}}
 
94
\subsubsection[{getTransfer}]{\setlength{\rightskip}{0pt plus 5cm}{\bf FileTransfer} $\ast$ FileTransferList::getTransfer (QString {\em id})}}
 
95
\label{classFileTransferList_aa05b78a7cd83387e58d08b463268a4bb}
 
96
 
 
97
 
 
98
Return a transfer object with a given id. 
 
99
\begin{DoxyParams}{Parameters}
 
100
\item[{\em id}]string representing the \hyperlink{classFileTransfer}{FileTransfer} object. \end{DoxyParams}
 
101
\begin{DoxyReturn}{Returns}
 
102
a valid FilaTransfer object if the id of the \hyperlink{classFileTransfer}{FileTransfer} object is found, otherwise return a null object. 
 
103
\end{DoxyReturn}
 
104
\hypertarget{classFileTransferList_a1e3efea6feca070a33cfa06c562db4ee}{
 
105
\index{FileTransferList@{FileTransferList}!getTransfer@{getTransfer}}
 
106
\index{getTransfer@{getTransfer}!FileTransferList@{FileTransferList}}
 
107
\subsubsection[{getTransfer}]{\setlength{\rightskip}{0pt plus 5cm}{\bf FileTransfer} $\ast$ FileTransferList::getTransfer (int {\em i})}}
 
108
\label{classFileTransferList_a1e3efea6feca070a33cfa06c562db4ee}
 
109
 
 
110
 
 
111
Return a \hyperlink{classFileTransfer}{FileTransfer} object from the list. 
 
112
\begin{DoxyParams}{Parameters}
 
113
\item[{\em i}]is the position in the list. \end{DoxyParams}
 
114
\begin{DoxyReturn}{Returns}
 
115
a valid \hyperlink{classFileTransfer}{FileTransfer} object. If i is outside the list a null pointer is returned. 
 
116
\end{DoxyReturn}
 
117
\hypertarget{classFileTransferList_a38b007b915766aa77e9e29e05ea8bd6a}{
 
118
\index{FileTransferList@{FileTransferList}!pauseProcessing@{pauseProcessing}}
 
119
\index{pauseProcessing@{pauseProcessing}!FileTransferList@{FileTransferList}}
 
120
\subsubsection[{pauseProcessing}]{\setlength{\rightskip}{0pt plus 5cm}void FileTransferList::pauseProcessing ()}}
 
121
\label{classFileTransferList_a38b007b915766aa77e9e29e05ea8bd6a}
 
122
 
 
123
 
 
124
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}{
 
125
\index{FileTransferList@{FileTransferList}!processTransfers@{processTransfers}}
 
126
\index{processTransfers@{processTransfers}!FileTransferList@{FileTransferList}}
 
127
\subsubsection[{processTransfers}]{\setlength{\rightskip}{0pt plus 5cm}void FileTransferList::processTransfers ()}}
 
128
\label{classFileTransferList_a92ad0c960ff3a7d3a37a28bcd8dd0bbb}
 
129
 
 
130
 
 
131
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}{
 
132
\index{FileTransferList@{FileTransferList}!resumeProcessing@{resumeProcessing}}
 
133
\index{resumeProcessing@{resumeProcessing}!FileTransferList@{FileTransferList}}
 
134
\subsubsection[{resumeProcessing}]{\setlength{\rightskip}{0pt plus 5cm}void FileTransferList::resumeProcessing ()}}
 
135
\label{classFileTransferList_a2651f7a2fffd03a606441118cda14159}
 
136
 
 
137
 
 
138
Resumes file transfer processing. Resumes file transfer processing by resuming the \hyperlink{classFileTransferProcessingThread}{FileTransferProcessingThread} thread. \hypertarget{classFileTransferList_a6a920922327d51ffa0bab686ad8bdf70}{
 
139
\index{FileTransferList@{FileTransferList}!updateStatus@{updateStatus}}
 
140
\index{updateStatus@{updateStatus}!FileTransferList@{FileTransferList}}
 
141
\subsubsection[{updateStatus}]{\setlength{\rightskip}{0pt plus 5cm}void FileTransferList::updateStatus (QString {\em id}, \/  unsigned long {\em transferred}, \/  unsigned long {\em totalSize})}}
 
142
\label{classFileTransferList_a6a920922327d51ffa0bab686ad8bdf70}
 
143
 
 
144
 
 
145
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. 
 
146
\begin{DoxyParams}{Parameters}
 
147
\item[{\em id}]of \hyperlink{classFileTransfer}{FileTransfer} object. \item[{\em transferred}]currently transferred bytes. \item[{\em totalSize}]total size of transfer. \end{DoxyParams}
 
148
 
 
149
 
 
150
The documentation for this class was generated from the following files:\begin{DoxyCompactItemize}
 
151
\item 
 
152
/home/jonas/Development/arc-\/gui-\/clients/src/arcstorage-\/ui/filetransferlist.h\item 
 
153
/home/jonas/Development/arc-\/gui-\/clients/src/arcstorage-\/ui/filetransferlist.cpp\end{DoxyCompactItemize}