SourcePro C++ 12.0 |
SourcePro® C++ API Reference Guide |
SourcePro C++ Documentation Home |
Encapsulates a single numerical protocol reply as defined by the FTP and SMTP protocols. More...
#include <rw/internet/RWNumReplyLine.h>
Public Member Functions | |
RWNumReplyLine (void) | |
RWNumReplyLine (const RWCString &s) | |
bool | operator== (const RWNumReplyLine &other) const |
bool | operator< (const RWNumReplyLine &other) const |
void | set (const RWCString &data) |
void | reset (void) |
unsigned int | getStatusCode (void) const |
RWCString | codeAsString (void) const |
bool | is1XX (void) const |
bool | is2XX (void) const |
bool | is3XX (void) const |
bool | is4XX (void) const |
bool | is5XX (void) const |
RWCString | getText (void) const |
RWCString | getData (void) const |
bool | isContinued (void) const |
bool | isValid (void) const |
Friends | |
std::ostream & | operator<< (std::ostream &str, const RWNumReplyLine &rl) |
RWNumReplyLine encapsulates a single numerical protocol reply as defined by the FTP and SMTP protocols. An example reply line is 200
Command
Ok
. If the 4th character of a reply line is the character -
(dash) instead of <space>
, the reply consists of multiple lines, with -
as the continuation marker. The continuation marker is used by RWNumReply to build a complete reply that encapsulates an entire server response.
RWNumReplyLine::RWNumReplyLine | ( | void | ) |
Constructs a default RWNumReplyLine object. You need to use the set
method to initialize it.
RWNumReplyLine::RWNumReplyLine | ( | const RWCString & | s | ) |
Constructs an RWNumReplyLine object using the input s. The RWCString should contain 7-bit US-ASCII data.
RWCString RWNumReplyLine::codeAsString | ( | void | ) | const |
RW_DISABLE_DEPRECATED
.Returns the reply code as an RWCString.
RWCString RWNumReplyLine::getData | ( | void | ) | const |
Returns the raw text line that was parsed. The RWCString should contain 7-bit US-ASCII data.
unsigned int RWNumReplyLine::getStatusCode | ( | void | ) | const |
Returns the 3-digit reply code.
RWCString RWNumReplyLine::getText | ( | void | ) | const |
Returns the text portion of the reply line. The RWCString should contain 7-bit US-ASCII data.
bool RWNumReplyLine::is1XX | ( | void | ) | const |
Returns true
if self
is in the reply family. For more information about reply families, see RFC 959.
bool RWNumReplyLine::is2XX | ( | void | ) | const |
Returns true
if self
is in the reply family. For more information about reply families, see RFC 959.
bool RWNumReplyLine::is3XX | ( | void | ) | const |
Returns true
if self
is in the reply family. For more information about reply families, see RFC 959.
bool RWNumReplyLine::is4XX | ( | void | ) | const |
Returns true
if self
is in the reply family. For more information about reply families, see RFC 959.
bool RWNumReplyLine::is5XX | ( | void | ) | const |
Returns true
if self
is in the reply family. For more information about reply families, see RFC 959.
bool RWNumReplyLine::isContinued | ( | void | ) | const |
Returns true
if additional reply lines follow self
in a whole reply.
bool RWNumReplyLine::isValid | ( | void | ) | const |
Returns true
if the reply line is valid.
bool RWNumReplyLine::operator< | ( | const RWNumReplyLine & | other | ) | const |
Returns true
if other is less than self
.
bool RWNumReplyLine::operator== | ( | const RWNumReplyLine & | other | ) | const |
Returns true
if self
is equal to other.
void RWNumReplyLine::reset | ( | void | ) |
Resets self
back to the default state. The data
member function will still return the original reply line from the constructor or from the set
member function.
void RWNumReplyLine::set | ( | const RWCString & | data | ) |
Reads the reply line into self
from data. The RWCString should contain 7-bit US-ASCII data.
std::ostream& operator<< | ( | std::ostream & | str, | |
const RWNumReplyLine & | rl | |||
) | [friend] |
Outputs an RWNumReplyLine object to an std::ostream
.
© 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.