CP_InternetProtocolProgress Class Reference

Helper class to send progress information in a CP_Message about the status of operations in internet protocol classes.

List of all members.

Public Types
enum	CP_E_ProtocolProgress {   CP_NetProto_OpeningConnection, CP_NetProto_ConnectionEstablished, CP_NetProto_ConnectionDisconnected, CP_NetProto_BeginAuthentication,   CP_NetProto_AuthenticationComplete, CP_NetProto_OpeningDataConnection, CP_NetProto_DataConnectionEstablished, CP_NetProto_ClosingDataConnection,   CP_NetProto_BeginDataTransfer, CP_NetProto_TransferedMoreBytes, CP_NetProto_EndDataTransfer, CP_NetProto_TransferComplete,   CP_NetProto_TransferItemFail, CP_NetProto_RetrieveItemSuccess, CP_NetProto_RetrieveItemFail }
Public Member Functions
Constructor / Destructor
	CP_InternetProtocolProgress ()
	Constructor.
	CP_InternetProtocolProgress (CP_NetProtoBase *inNetProtoBase, CP_E_ProtocolProgress inProgressMsg)
	CP_InternetProtocolProgress (const CP_InternetProtocolProgress &inAddress)
virtual	~CP_InternetProtocolProgress () throw ()
	Destructor.
operators
CP_InternetProtocolProgress &	operator= (const CP_InternetProtocolProgress &inAddress)
Getters
CP_NetProtoBase *	GetProtocol ()
UInt32	GetProgressMsg ()
UInt32	GetTotalItem ()
UInt32	GetCompletedItems ()
UInt32	GetTotalBytes ()
UInt32	GetCompletedBytes ()
Setters
void	SetProtocol (CP_NetProtoBase *inProtoBase)
void	SetProgressMessage (UInt32 inProgressMsg)
void	SetTotalItem (UInt32 inTotalItems)
void	SetCompletedItems (UInt32 inCompletedItems)
void	SetTotalBytes (UInt32 inTotalBytes)
void	SetCompletedBytes (UInt32 inCompletedBytes)
Protected Attributes
CP_NetProtoBase *	fProtocol
UInt32	fProgressMessage
UInt32	fTotalItems
UInt32	fCompletedItems
UInt32	fTotalBytes
UInt32	fCompletedBytes

---

Member Enumeration Documentation

enum CP_InternetProtocolProgress::CP_E_ProtocolProgress

Enumeration values: CP_NetProto_OpeningConnection  CP_NetProto_ConnectionEstablished  CP_NetProto_ConnectionDisconnected  CP_NetProto_BeginAuthentication  CP_NetProto_AuthenticationComplete  CP_NetProto_OpeningDataConnection  CP_NetProto_DataConnectionEstablished  CP_NetProto_ClosingDataConnection  CP_NetProto_BeginDataTransfer  CP_NetProto_TransferedMoreBytes  CP_NetProto_EndDataTransfer  CP_NetProto_TransferComplete  CP_NetProto_TransferItemFail  CP_NetProto_RetrieveItemSuccess  CP_NetProto_RetrieveItemFail

---

Constructor & Destructor Documentation

CP_InternetProtocolProgress::CP_InternetProtocolProgress (   )

Constructor. Exceptions: none

CP_InternetProtocolProgress::CP_InternetProtocolProgress (  CP_NetProtoBase *  inNetProtoBase, CP_E_ProtocolProgress  inProgressMessage )

Constructor. Parameters: inNetProtoBase  The CP_NetProtoBase object we monitor progress for. inProgressMessage  The message to send. Exceptions: none

CP_InternetProtocolProgress::CP_InternetProtocolProgress (  const CP_InternetProtocolProgress &  inProgress  )

Copy constructor. Parameters: inProgress  Object to copy the data from. Exceptions: none

CP_InternetProtocolProgress::~CP_InternetProtocolProgress (   )  throw () [virtual]

Destructor. Exceptions: none

---

Member Function Documentation

CP_InternetProtocolProgress & CP_InternetProtocolProgress::operator= (  const CP_InternetProtocolProgress &  inProgress  )

Assignment operator. Parameters: inProgress  The object we are going to copy the fields from. Exceptions: none  Returns: CP_InternetProtocolProgress& Returns a reference to ourselves.

CP_NetProtoBase* CP_InternetProtocolProgress::GetProtocol (   )

Returns the internet protocol that this class is used with. Exceptions: none  Returns: CP_NetProtoBase The class that is used with the one.

UInt32 CP_InternetProtocolProgress::GetProgressMsg (   )

Returns the progress message we are sending. Exceptions: none  Returns: UInt32 The progress message being sent.

UInt32 CP_InternetProtocolProgress::GetTotalItem (   )

Returns the total item count. Exceptions: none  Returns: UInt32 The total item count.

UInt32 CP_InternetProtocolProgress::GetCompletedItems (   )

Returns the number of completed items. Exceptions: none  Returns: UInt32 The number of completed items.

UInt32 CP_InternetProtocolProgress::GetTotalBytes (   )

Returns the total size in bytes of the item we are show progress for. Exceptions: none  Returns: UInt32 The total size in bytes of the item.

UInt32 CP_InternetProtocolProgress::GetCompletedBytes (   )

Returns the number of completed bytes. Exceptions: none  Returns: UInt32 The number of completed bytes.

void CP_InternetProtocolProgress::SetProtocol (  CP_NetProtoBase *  inProtoBase  )

Sets the protocol object we are monitoring progress for. Parameters: inProtoBase  The CP_NetProtoBase we are monitoring. Exceptions: none  Returns: void

void CP_InternetProtocolProgress::SetProgressMessage (  UInt32  inProgressMsg  )

Sets the message we will broadcast. Parameters: inProgressMsg  The message to be broadcast. Exceptions: none  Returns: void

void CP_InternetProtocolProgress::SetTotalItem (  UInt32  inTotalItems  )

Sets the total item count. Parameters: inTotalItems  The total item count. Exceptions: none  Returns: void

void CP_InternetProtocolProgress::SetCompletedItems (  UInt32  inCompletedItems  )

Sets the number of completed items so far. Parameters: inCompletedItems  The number of completed items. Exceptions: none  Returns: void

void CP_InternetProtocolProgress::SetTotalBytes (  UInt32  inTotalBytes  )

Sets the total number of bytes. Parameters: inTotalBytes  The total number of bytes. Exceptions: none  Returns: void

void CP_InternetProtocolProgress::SetCompletedBytes (  UInt32  inCompletedBytes  )

Sets the number of completed bytes. Parameters: inCompletedBytes  The number of completed bytes. Exceptions: none  Returns: void

---

Member Data Documentation

CP_NetProtoBase* CP_InternetProtocolProgress::fProtocol [protected]

UInt32 CP_InternetProtocolProgress::fProgressMessage [protected]

Protocol class we are showing progress for.

UInt32 CP_InternetProtocolProgress::fTotalItems [protected]

Message that will be sent.

UInt32 CP_InternetProtocolProgress::fCompletedItems [protected]

Total number of items to show progress for.

UInt32 CP_InternetProtocolProgress::fTotalBytes [protected]

Number of completed items so far.

UInt32 CP_InternetProtocolProgress::fCompletedBytes [protected]

Total number of bytes to show progress for.

---

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

• CP_NetProtoBase.h
• CP_NetProtoBase.cpp

---