Dokumentacja klasy LanPacket

#include <communication.h>

Lista wszystkich składowych.

Typy publiczne
enum	PacketType {   Invalid = 0, Welcome, Hi, Bye, Ping, Pong, SysPing, SysPong, Bmsg, BmsgOk, Pmsg, PmsgOk,   FileReq, FileOk, FileRefuse }
Metody publiczne
	LanPacket ()
	LanPacket (const QByteArray &data)
	LanPacket (const enum PacketType packet_type)
	LanPacket (const enum PacketType packet_type, const QString &str_data, quint32 file_size=0, quint16 port=0)
bool	isValid () const
QByteArray	constData ()
PacketType	getType () const
quint16	getSize () const
QString	getString () const
quint32	getFileSize () const
quint16	getPort () const
Metody prywatne
QByteArray	packInt (quint32 num, bool bit32=false)
void	clearData ()
bool	validate ()
Atrybuty prywatne
bool	is_valid
QByteArray	packet_data
LanPacket::PacketType	packet_type
quint16	data_size
QString	str_data
quint32	file_size
quint16	port

---

Opis szczegółowy

Klasa pakietu. Odpowiada za za dekodowanie i tworzenie pakietów.

Definicja w linii 24 pliku communication.h.

---

Dokumentacja składowych wyliczanych

enum LanPacket::PacketType

Typy pakietów Wartości wyliczeń: Invalid  Welcome  Hi  Bye  Ping  Pong  SysPing  SysPong  Bmsg  BmsgOk  Pmsg  PmsgOk  FileReq  FileOk  FileRefuse  Definicja w linii 32 pliku communication.h.

---

Dokumentacja konstruktora i destruktora

LanPacket::LanPacket (   )

konstruktor bez parametrów, czyśli tylko pola pakietu Definicja w linii 28 pliku communication.cpp. Odwołuje się do clearData(). Oto graf wywołań dla tej funkcji:

LanPacket::LanPacket (  const QByteArray &  data  )

dekoduje pakiet z odebranych dany i wypełnia odpowiednie wewnętrzne pola. Parametry: data  dane pakietu Definicja w linii 33 pliku communication.cpp. Odwołuje się do clearData(), FileRefuse i Invalid. Oto graf wywołań dla tej funkcji:

LanPacket::LanPacket (  const enum PacketType  packet_type  )

tworzy pakiet typu packet_type Parametry: packet_type  typ pakietu Definicja w linii 162 pliku communication.cpp. Odwołuje się do clearData() i validate(). Oto graf wywołań dla tej funkcji:

LanPacket::LanPacket (  const enum PacketType  packet_type, const QString &  str_data, quint32  file_size = 0, quint16  port = 0 )

tworzy pakiet typu packet_type z dodatkowymi danymi. Parametry: packet_type  typ pakietu str_data  ciąg znaków np. nick, wiadomość, nazwa pliku, suma md5 file_size  rozmiar przesyłanego pliku (tylko FileReq) port  port do odbioru pliku (tylko FileOk) Definicja w linii 169 pliku communication.cpp. Odwołuje się do clearData() i validate(). Oto graf wywołań dla tej funkcji:

---

Dokumentacja funkcji składowych

void LanPacket::clearData (   )  [private]

czyści pola pakietu. Definicja w linii 271 pliku communication.cpp. Odwołuje się do data_size, file_size, Invalid, packet_data, packet_type, port i str_data. Odwołania w LanPacket().

QByteArray LanPacket::constData (   )

zwraca pakiet w formie binarnej (gotowej do przesłania). Zwraca: dane binarne gotowe do wysłania Definicja w linii 184 pliku communication.cpp. Odwołuje się do Bmsg, BmsgOk, data_size, file_size, FileOk, FileRefuse, FileReq, Hi, packet_data, packet_type, packInt(), Pmsg, PmsgOk, port, str_data i Welcome. Oto graf wywołań dla tej funkcji:

quint32 LanPacket::getFileSize (   )  const

zwraca rozmiar pliku który chcemy przesłać (tylko FileReq). Zwraca: rozmiar pliku który chcemy przesłać Definicja w linii 248 pliku communication.cpp. Odwołuje się do file_size. Odwołania w Communication::servicePacket().

quint16 LanPacket::getPort (   )  const

zwraca numer portu na którym nasłuchuje użytkownik (tylko FileOk). Zwraca: port na którym nasłuchuje użytkownik Definicja w linii 253 pliku communication.cpp. Odwołuje się do port.

quint16 LanPacket::getSize (   )  const

zwraca rozmiar pakietu (nie liczy się nagłówek). Zwraca: rozmiar pakietu bez nagłówka Definicja w linii 238 pliku communication.cpp. Odwołuje się do data_size.

QString LanPacket::getString (   )  const

zwraca ciąg znaków np nick, wiadomość, nazwa pliku itd. Zwraca: ciąg znaków w zależności od typu pakietu Definicja w linii 243 pliku communication.cpp. Odwołuje się do str_data. Odwołania w Communication::servicePacket().

LanPacket::PacketType LanPacket::getType (   )  const

zwraca typ pakietu. Zwraca: typ pakietu Definicja w linii 233 pliku communication.cpp. Odwołuje się do packet_type. Odwołania w Communication::servicePacket().

bool LanPacket::isValid (   )  const

sprawdza czy pakiet jest prawidłowy. Zwraca: true jeśli pakiet jest prawidłowy, false w przeciwnym wypadku Definicja w linii 179 pliku communication.cpp. Odwołania w Communication::sendPacket().

QByteArray LanPacket::packInt (  quint32  num, bool  bit32 = false )  [private]

zamienia liczbę całkowitą na tablicę bajtów. Parametry: num  liczba do zamiany bit32  czy liczba 32 bitowa, jeśli nie to 16 bitowa Zwraca: liczba zamieniona na ciąg bajtów Definicja w linii 258 pliku communication.cpp. Odwołania w constData().

bool LanPacket::validate (   )  [private]

sprawdza czy pakiet jest prawidłowy. Definicja w linii 280 pliku communication.cpp. Odwołuje się do Bmsg, BmsgOk, file_size, FileOk, FileRefuse, FileReq, Hi, Invalid, packet_type, Pmsg, PmsgOk, port, str_data i Welcome. Odwołania w LanPacket().

---

Dokumentacja atrybutów składowych

quint16 LanPacket::data_size [private]

rozmiar pakietu (bez nagłówka) Definicja w linii 134 pliku communication.h. Odwołania w clearData(), constData() i getSize().

quint32 LanPacket::file_size [private]

rozmiar pliku do przesłania (tylko FileReq) Definicja w linii 136 pliku communication.h. Odwołania w clearData(), constData(), getFileSize() i validate().

bool LanPacket::is_valid [private]

flaga czy pakiet jest prawidłowy Definicja w linii 131 pliku communication.h.

QByteArray LanPacket::packet_data [private]

binarne dane pakietu Definicja w linii 132 pliku communication.h. Odwołania w clearData() i constData().

LanPacket::PacketType LanPacket::packet_type [private]

typ pakietu Definicja w linii 133 pliku communication.h. Odwołania w clearData(), constData(), getType() i validate().

quint16 LanPacket::port [private]

numer portu na którym nasłuchuje użytkownik (tylko FileOk) Definicja w linii 137 pliku communication.h. Odwołania w clearData(), constData(), getPort() i validate().

QString LanPacket::str_data [private]

ciąg znaków: nick, wiadomość itp Definicja w linii 135 pliku communication.h. Odwołania w clearData(), constData(), getString() i validate().

---

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

• communication.h
• communication.cpp

---