Emai::ImapStatusCallback Class ReferenceWrapper class for EmaiImapStatusCallback.
This class contains the (virtual) functionality, which is supposed to process the progress update reports.
More...
#include <EmaiIMAP.hpp>
List of all members.
|
Public Member Functions |
virtual | ~ImapStatusCallback () |
Static Protected Member Functions |
static EmaiError | StatusCallback (EmaiImapSession inSession, const EmaiImapCallbackData *inData, void *inUserData) |
Private Member Functions |
virtual EmaiError | OnOperation (Emai::ImapSession &inSession, EmaiUint32 inOperationCode)=0 |
| Virtual function.
|
virtual EmaiError | OnDataSent (Emai::ImapSession &inSession, EmaiUint32 inSentSize, EmaiUint32 inTotalSize)=0 |
| Virtual function; will be triggered periodically while sending the data, after a certain amount of data is sent.
|
virtual EmaiError | OnDataReceived (Emai::ImapSession &inSession, EmaiUint32 inReceivedSize, EmaiUint32 inTotalSize)=0 |
| Virtual function; will be triggered periodically while receiving the data, after a certain amount of data is received.
|
virtual EmaiError | OnServerError (Emai::ImapSession &inSession, EmaiConstCharPtr inServerReply, EmaiUint32 inReplyCode)=0 |
| Virtual function; Will be triggered in case if server returns an error.
|
Friends |
class | ImapSession |
Detailed Description
Wrapper class for EmaiImapStatusCallback.
This class contains the (virtual) functionality, which is supposed to process the progress update reports.
- See also:
- EmaiImapStatusCallback
Definition at line 107 of file EmaiIMAP.hpp.
Member Function Documentation
virtual EmaiError Emai::ImapStatusCallback::OnOperation |
( |
Emai::ImapSession & |
inSession, |
|
|
EmaiUint32 |
inOperationCode | |
|
) |
| | [private, pure virtual] |
Virtual function.
- Parameters:
-
| Emai::ImapSession | inSession - session object of the event |
| EmaiUint32 | inOperationCode - operation code |
| EmaiConstCharPtr | inStatusText - status text |
Referenced by StatusCallback().
virtual EmaiError Emai::ImapStatusCallback::OnDataSent |
( |
Emai::ImapSession & |
inSession, |
|
|
EmaiUint32 |
inSentSize, |
|
|
EmaiUint32 |
inTotalSize | |
|
) |
| | [private, pure virtual] |
Virtual function; will be triggered periodically while sending the data, after a certain amount of data is sent.
- Parameters:
-
| Emai::ImapSession | inSession - session object of the event |
| EmaiUint32 | inSentSize - data sent amount, sinse last function call |
| EmaiUint32 | inTotalSize - total data amout to be sent |
Referenced by StatusCallback().
virtual EmaiError Emai::ImapStatusCallback::OnDataReceived |
( |
Emai::ImapSession & |
inSession, |
|
|
EmaiUint32 |
inReceivedSize, |
|
|
EmaiUint32 |
inTotalSize | |
|
) |
| | [private, pure virtual] |
Virtual function; will be triggered periodically while receiving the data, after a certain amount of data is received.
- Parameters:
-
| Emai::ImapSession | inSession - session object of the event |
| EmaiUint32 | inSentSize - data sent amount, sinse last function call |
| EmaiUint32 | inTotalSize - total data amout to be sent |
Referenced by StatusCallback().
Virtual function; Will be triggered in case if server returns an error.
- Parameters:
-
| Emai::ImapSession | inSession - session object of the event |
| EmaiConstCharPtr | inServerReply - error reply string |
| EmaiUint32 | inReplyCode - error reply code |
Referenced by StatusCallback().
The documentation for this class was generated from the following file:
|