CL_DCCDownload Class Reference
[clanNetwork Internet Relay Chat]

IRC DCC download session object. More...

#include <dcc_download.h>

List of all members.

Attributes
enum	DCCStatus { connecting, downloading, connection_lost, finished }
int	get_bytes_transfered ()
	Returns the number of bytes transfered so far.
int	get_total_size ()
	Returns the total size of file.
DCCStatus	get_status ()
	Returns the current status of the download.
CL_Signal_v1< const CL_String & > &	sig_connection_lost ()
	sig_connection_lost(error_message)
CL_Signal_v0 &	sig_download_complete ()
	sig_download_complete()
Public Member Functions
Construction
	CL_DCCDownload ()
	Constructs a new DCC download session.
	CL_DCCDownload (const CL_DCCDownload &copy)
	Constructs a DCCDownload.
	CL_DCCDownload (const CL_String &server, const CL_String &port, const CL_String &filename, int total_size, CL_VirtualDirectory directory=CL_VirtualDirectory())
virtual	~CL_DCCDownload ()
Operations
CL_DCCDownload &	operator= (const CL_DCCDownload &copy)
	Copy assignment operator.
void	reconnect ()
	Attemp to reconnect and resume download.

---

Detailed Description

IRC DCC download session object.

This class connects to an IRC client listening for an incoming DCC connection and then downloads the file offered. Should be used in response to a DCC SEND CTCP command.

---

Member Enumeration Documentation

enum CL_DCCDownload::DCCStatus

Enumerator: connecting  Connecting to DCC server. downloading  Currently downloading. connection_lost  Connection was lost to DCC server. finished  Download was completed.

---

Constructor & Destructor Documentation

CL_DCCDownload::CL_DCCDownload (   )

Constructs a new DCC download session.

CL_DCCDownload::CL_DCCDownload (  const CL_DCCDownload &  copy  )

Constructs a DCCDownload. Parameters: copy  = DCCDownload

CL_DCCDownload::CL_DCCDownload (  const CL_String &  server, const CL_String &  port, const CL_String &  filename, int  total_size, CL_VirtualDirectory  directory = CL_VirtualDirectory() )

virtual CL_DCCDownload::~CL_DCCDownload (   )  [virtual]

---

Member Function Documentation

int CL_DCCDownload::get_bytes_transfered (   )

Returns the number of bytes transfered so far.

DCCStatus CL_DCCDownload::get_status (   )

Returns the current status of the download.

int CL_DCCDownload::get_total_size (   )

Returns the total size of file. If the total size is unknown, it returns 0.

CL_DCCDownload& CL_DCCDownload::operator= (  const CL_DCCDownload &  copy  )

Copy assignment operator.

void CL_DCCDownload::reconnect (   )

Attemp to reconnect and resume download.

CL_Signal_v1<const CL_String &>& CL_DCCDownload::sig_connection_lost (   )

sig_connection_lost(error_message)

CL_Signal_v0& CL_DCCDownload::sig_download_complete (   )

sig_download_complete()

---

The documentation for this class was generated from the following file:

• dcc_download.h

---