SourcePro C++ 12.0 |
SourcePro® C++ API Reference Guide |
SourcePro C++ Documentation Home |
Encapsulates a general POP3 protocol reply and is the base class for specific POP3 replies. More...
#include <rw/pop3/RWPop3Reply.h>
Public Member Functions | |
RWPop3Reply (void) | |
bool | isOk (void) const |
bool | isErr (void) const |
RWCString | getData (void) const |
Protected Types | |
enum | resultCode { CODE_UNKNOWN, CODE_OK, CODE_ERR } |
Protected Member Functions | |
void | readFromPortal (const RWPortal &portal) |
virtual void | parse (void) |
Protected Attributes | |
RWCString | data_ |
Related Functions | |
(Note that these are not member functions.) | |
std::ostream & | operator<< (std::ostream &str, const RWPop3Reply &r) |
RWPop3Reply encapsulates a general POP3 protocol reply. It is the base class for more specific POP3 replies. Specific subclasses of RWPop3Reply -- RWPop3ConnReply, RWPop3DataReply, and RWPop3StatReply -- return additional information specific to those types of POP3 protocol replies.
The following are examples of POP3 server command replies:
+OK scan listing follows -ERR no such message
enum RWPop3Reply::resultCode [protected] |
RWPop3Reply::RWPop3Reply | ( | void | ) |
Constructs a default invalid RWPop3Reply. You need to use the assignment operator to initialize the default RWPop3Reply object.
RWCString RWPop3Reply::getData | ( | void | ) | const |
Returns the raw text used to construct the reply object. This can be useful when communicating with non-standard servers. The RWCString should contain 7-bit US-ASCII data.
bool RWPop3Reply::isErr | ( | void | ) | const |
Returns true
if the reply is negative (-ERR
).
bool RWPop3Reply::isOk | ( | void | ) | const |
Returns true
if the reply is positive (+OK
).
virtual void RWPop3Reply::parse | ( | void | ) | [protected, virtual] |
Provides an empty parsing mechanism. Derived classes can override the virtual function to get extra meaning in a specific reply.
Reimplemented in RWPop3ConnReply, RWPop3DataReply, and RWPop3StatReply.
void RWPop3Reply::readFromPortal | ( | const RWPortal & | portal | ) | [protected, virtual] |
Reads data from the portal to construct the RWPop3Reply object.
Implements RWReply.
std::ostream& operator<< | ( | std::ostream & | str, | |
const RWPop3Reply & | r | |||
) | [friend] |
Outputs an RWPop3Reply object to an std::ostream.
RWCString RWPop3Reply::data_ [protected] |
Contains the raw data line. The RWCString should contain 7-bit US-ASCII data.
© Copyright Rogue Wave Software, Inc. All Rights Reserved.
Rogue Wave and SourcePro are registered trademarks of Rogue Wave Software, Inc. in the United States and other countries. All other trademarks are the property of their respective owners.
Contact Rogue Wave about documentation or support issues.