MSN::FileTransferConnection Class Reference

#include <filetransfer.h>

Inheritance diagram for MSN::FileTransferConnection:

List of all members.

---

Detailed Description

Represents a connection to another users computer for the purpose of transferring a file.

Todo:

Finish refactoring to store progress explicitly rather than in a complex combination of member variables.

Public Types
enum	Direction { MSNFTP_SEND, MSNFTP_RECV }
	Are we sending or receiving the file? More...
enum	Perspective { MSNFTP_SERVER, MSNFTP_CLIENT }
	Are we being connected to or connecting to them? More...
enum	Progress { WAITING_FOR_CONNECTION, NEGOTIATING, TRANSFERRING }
	How far through the process are we? More...
Public Member Functions
	FileTransferConnection (AuthData &auth_)
virtual	~FileTransferConnection ()
virtual void	connect (const std::string &hostname, unsigned int port)
virtual void	disconnect ()
virtual void	dispatchCommand (std::vector< std::string > &args)
	Dispatch a command to its appropriate handler routines based on args.
virtual void	socketIsWritable ()
virtual void	socketConnectionCompleted ()
	The connection has been established.
virtual void	dataArrivedOnSocket ()
	New data is available on the connection.
virtual NotificationServerConnection *	myNotificationServer ()
Public Attributes
FileTransferConnection::AuthData	auth
Protected Member Functions
virtual void	handleIncomingData ()
Classes
class	AuthData
	AuthData contains authentication information relating to a FileTransferConnection. More...

---

Member Enumeration Documentation

enum MSN::FileTransferConnection::Direction

Are we sending or receiving the file? Enumeration values: MSNFTP_SEND  MSNFTP_RECV

enum MSN::FileTransferConnection::Perspective

Are we being connected to or connecting to them? Enumeration values: MSNFTP_SERVER  MSNFTP_CLIENT

enum MSN::FileTransferConnection::Progress

How far through the process are we? Enumeration values: WAITING_FOR_CONNECTION  NEGOTIATING  TRANSFERRING

---

Constructor & Destructor Documentation

MSN::FileTransferConnection::FileTransferConnection (  AuthData &  auth_  )  [inline]

MSN::FileTransferConnection::~FileTransferConnection (   )  [virtual]

---

Member Function Documentation

virtual void MSN::FileTransferConnection::connect (  const std::string &  hostname, unsigned int  port )  [inline, virtual]

Todo: Should this really be an empty function? Implements MSN::Connection.

void MSN::FileTransferConnection::dataArrivedOnSocket (   )  [virtual]

New data is available on the connection. Reimplemented from MSN::Connection.

void MSN::FileTransferConnection::disconnect (   )  [virtual]

Implements MSN::Connection.

virtual void MSN::FileTransferConnection::dispatchCommand (  std::vector< std::string > &  args  )  [inline, virtual]

Dispatch a command to its appropriate handler routines based on args. Parameters: args  A vector of strings containing arguments, returned from readLine. Implements MSN::Connection.

void MSN::FileTransferConnection::handleIncomingData (   )  [protected, virtual]

Implements MSN::Connection.

virtual NotificationServerConnection* MSN::FileTransferConnection::myNotificationServer (   )  [inline, virtual]

Implements MSN::Connection.

void MSN::FileTransferConnection::socketConnectionCompleted (   )  [virtual]

The connection has been established. Reimplemented from MSN::Connection.

void MSN::FileTransferConnection::socketIsWritable (   )  [virtual]

Reimplemented from MSN::Connection.

---

Member Data Documentation

FileTransferConnection::AuthData MSN::FileTransferConnection::auth

---

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

• filetransfer.h
• filetransfer.cpp

---