Dokumentacja klasy FileTransfer

#include <fileTransfer.h>

Diagram współpracy dla FileTransfer:

[legenda]Lista wszystkich składowych.

Sygnały
void	posOfProgresBarChanged (int perc)
void	transferEnd (bool ok)
Metody publiczne
	FileTransfer ()
	~FileTransfer ()
void	sendFile (const QHostAddress &ip, quint16 port, const QString &path)
void	receiveFile (const QHostAddress &ip, quint16 port, const QString &path, qint64 file_size)
QHostAddress	getIp ()
void	cancelTransfer ()
Sloty prywatne
void	receiveSocketError (QAbstractSocket::SocketError err)
void	receiveFile ()
void	newConnection ()
void	threadTransferProgres (int perc)
void	threadTransferEnd (bool ok)
Atrybuty prywatne
QHostAddress	ip
QTcpServer	receive_file_server
QTcpSocket *	receive_file_socket
SendFileThread *	send_file_thread
qint64	file_size
qint64	transfer_bytes
QFile *	out_file

---

Opis szczegółowy

Klasa przesyłu plików. Odpowiada za przesyłanie plików z/do użytkownika.

Definicja w linii 67 pliku fileTransfer.h.

---

Dokumentacja konstruktora i destruktora

FileTransfer::FileTransfer (   )

Konstruktor, inicjuje niezbędne rzeczy. Definicja w linii 90 pliku fileTransfer.cpp. Odwołuje się do out_file, receive_file_socket i send_file_thread.

FileTransfer::~FileTransfer (   )

Destruktor, zamyka połączenie i usuwa zbędne obiekty. Definicja w linii 97 pliku fileTransfer.cpp. Odwołuje się do SendFileThread::cancelTransfer(), out_file i send_file_thread. Oto graf wywołań dla tej funkcji:

---

Dokumentacja funkcji składowych

void FileTransfer::cancelTransfer (   )

Anuluje transfer. Anuluje wysyłanie/odbieranie pliku. Definicja w linii 150 pliku fileTransfer.cpp. Odwołuje się do SendFileThread::cancelTransfer(), out_file, receive_file_server i send_file_thread. Odwołania w Communication::cancelTranfer(). Oto graf wywołań dla tej funkcji:

QHostAddress FileTransfer::getIp (   )

Zwaraca adres osoby od ktorej/od ktorej transferujemy. Zwraca: adres nadawcy/adresata pliku. Definicja w linii 189 pliku fileTransfer.cpp. Odwołuje się do ip. Odwołania w Communication::bye() i Communication::fileTransferEnd().

void FileTransfer::newConnection (   )  [private, slot]

Slot nowego połączenia. Obługuje przyjście nowego połączenia od użytkownika (gdy serwer nasłuchuje), otwiera plik do zapisu i przygotowuje wszelkie dane do odbioru Definicja w linii 195 pliku fileTransfer.cpp. Odwołuje się do ip, receive_file_server, receive_file_socket, receiveFile(), receiveSocketError() i transfer_bytes.

void FileTransfer::posOfProgresBarChanged (  int  perc  )  [signal]

Sygnal zmiany pozycji paska postepu. Sygnal jest emitowany za kazdym razem, kiedy jest pobrana/wysłana jest nowa czesc pliku. Parametry: perc  ilość procent wysłanego/odebranego pliku Odwołania w receiveFile() i threadTransferProgres().

void FileTransfer::receiveFile (   )  [private, slot]

Slot błędu odbioru pliku. Odczytuje dane ze socketa i dopisuje do pliku wyjściowego. Definicja w linii 109 pliku fileTransfer.cpp. Odwołuje się do file_size, out_file, posOfProgresBarChanged(), receive_file_socket, transfer_bytes i transferEnd(). Odwołania w newConnection().

void FileTransfer::receiveFile (  const QHostAddress &  ip, quint16  port, const QString &  path, qint64  file_size )

Odbiera plik. Nasłuchuje na porcie i czeka na połączenie od użytkownika ip Parametry: ip  adres nadawcy. port  port na którym nasłuchujemy path  ścieżka do pliku wyjściowego file_size  rozmiar pliku do odebrania Wyjątki: Exeptions  nie można nasłuchiwać na porcie Definicja w linii 165 pliku fileTransfer.cpp. Odwołuje się do out_file. Odwołania w Communication::acceptFileRequest().

void FileTransfer::receiveSocketError (  QAbstractSocket::SocketError  err  )  [private, slot]

Slot błędu odebrania pliku. Przechwytuje błąd socketa który odbiera plik, gdy nieprzesłano calego pliku emituje transferEnd(false). Parametry: err  typ błędu socketa Definicja w linii 217 pliku fileTransfer.cpp. Odwołuje się do file_size, receive_file_socket, transfer_bytes i transferEnd(). Odwołania w newConnection().

void FileTransfer::sendFile (  const QHostAddress &  ip, quint16  port, const QString &  path )

Odbiera plik. Odbiera plik od użytkownika Parametry: ip  adres ip adresata port  port na który chcemy wysłać plik path  ścieżka do wysyłanego pliku Definicja w linii 141 pliku fileTransfer.cpp. Odwołuje się do send_file_thread, threadTransferEnd(), threadTransferProgres() i transferEnd().

void FileTransfer::threadTransferEnd (  bool  ok  )  [private, slot]

Slot zakończenia wysyłania. Obsługuje sygnal wysyłany przez wątek wysyłania pliku, informujący o zakończeniu transmisji. Parametry: ok  true - wysłanie zakończone powodzeniem, false - błąd podczas wysyłania Definicja w linii 236 pliku fileTransfer.cpp. Odwołuje się do transferEnd(). Odwołania w sendFile().

void FileTransfer::threadTransferProgres (  int  perc  )  [private, slot]

Slot postępu wysyłania. Obsługuje sygnal wysyłany przez wątek wysyłania pliku, przekazuje ilość wysłanych procent. Parametry: perc  ilość procent wysyłanego pliku Definicja w linii 230 pliku fileTransfer.cpp. Odwołuje się do posOfProgresBarChanged(). Odwołania w sendFile().

void FileTransfer::transferEnd (  bool  ok  )  [signal]

sdfd Sygnal zakończenia transferu. Sygnal jest emitowany gdy transfer pliku się zakończy lub wystąpi błąd. Parametry: ok  true - zakończony powodzeniem, false - wystąpił błąd Odwołania w receiveFile(), receiveSocketError(), sendFile() i threadTransferEnd().

---

Dokumentacja atrybutów składowych

qint64 FileTransfer::file_size [private]

rozmiar pliku przesyłanego pliku Definicja w linii 136 pliku fileTransfer.h. Odwołania w receiveFile() i receiveSocketError().

QHostAddress FileTransfer::ip [private]

ip nadawcy/odbiorcy Definicja w linii 132 pliku fileTransfer.h. Odwołania w getIp() i newConnection().

QFile* FileTransfer::out_file [private]

plik wyjściowy Definicja w linii 138 pliku fileTransfer.h. Odwołania w cancelTransfer(), FileTransfer(), receiveFile() i ~FileTransfer().

QTcpServer FileTransfer::receive_file_server [private]

serwer do nasłuchu pliku wejściowego Definicja w linii 133 pliku fileTransfer.h. Odwołania w cancelTransfer() i newConnection().

QTcpSocket* FileTransfer::receive_file_socket [private]

socket odbierający plik Definicja w linii 134 pliku fileTransfer.h. Odwołania w FileTransfer(), newConnection(), receiveFile() i receiveSocketError().

SendFileThread* FileTransfer::send_file_thread [private]

wątek do odbierania pliku Definicja w linii 135 pliku fileTransfer.h. Odwołania w cancelTransfer(), FileTransfer(), sendFile() i ~FileTransfer().

qint64 FileTransfer::transfer_bytes [private]

ilość wysłanych/odebranych danych (w bajtach) Definicja w linii 137 pliku fileTransfer.h. Odwołania w newConnection(), receiveFile() i receiveSocketError().

---

Dokumentacja dla tej klasy została wygenerowana z plików:

• fileTransfer.h
• fileTransfer.cpp

---