RWPop3DataReply Class Reference

Encapsulates an RWSocketPortal that receives the data portion of a message. More...

#include <rw/pop3/RWPop3DataReply.h>

Inheritance diagram for RWPop3DataReply:

Public Member Functions
	RWPop3DataReply (void)
RWSocketPortal	getPortal (void) const
RWCString	getText (void) const
Public Member Functions inherited from RWPop3Reply
	RWPop3Reply (void)
RWCString	getData (void) const
bool	isErr (void) const
bool	isOk (void) const
Public Member Functions inherited from RWReply
	RWReply (void)
virtual	~RWReply (void)
virtual void	clearAndDestroy (void)
virtual bool	isComplete (void) const
virtual bool	isValid (void) const

Private Member Functions
virtual void	parse (void)

Related Symbols
(Note that these are not member symbols.)
std::ostream &	operator<< (std::ostream &str, const RWPop3DataReply &r)

Additional Inherited Members
Protected Types inherited from RWPop3Reply
enum	resultCode { CODE_UNKNOWN , CODE_OK , CODE_ERR }
Protected Member Functions inherited from RWPop3Reply
void	readFromPortal (const RWPortal &portal)
Protected Attributes inherited from RWPop3Reply
RWCString	data_
Protected Attributes inherited from RWReply
bool	complete_
bool	valid_

Detailed Description

RWPop3DataReply is derived from RWPop3Reply. RWPop3DataReply includes an RWSocketPortal that receives the data portion of the message. You should not close this socket portal. Take care to read data only up to the end of the message marker <period><cr><lf> contained on a line by itself.

Constructor & Destructor Documentation

RWPop3DataReply()

RWPop3DataReply::RWPop3DataReply

(

void

)

Uses the assignment operator to initialize the default RWPop3DataReply object.

Member Function Documentation

getPortal()

RWSocketPortal RWPop3DataReply::getPortal

(

void

)

const

Returns the connected data portal to read data from the underlying socket.

getText()

RWCString RWPop3DataReply::getText

(

void

)

const

Returns additional information available on the POP3 reply line. If no additional data is available following either +OK or -ERR, then the method returns a null string. The RWCString should contain 7-bit US-ASCII data.

parse()

virtual void RWPop3DataReply::parse ( void )

privatevirtual

Performs an extended parse to obtain the additional text that follows either +OK or -ERR on the reply line.

Reimplemented from RWPop3Reply.

Friends And Related Symbol Documentation

operator<<

std::ostream & operator<< ( std::ostream & str, const RWPop3DataReply & r )

friend

Outputs an RWPop3DataReply object to an std::ostream.

Note

RWPop3DataReply does not have an extraction (>>) operator.