ACE_INet  6.1.0
Public Types | Public Member Functions | Static Public Member Functions | Private Member Functions | Private Attributes | Static Private Attributes
ACE::FTP::Response Class Reference

#include <FTP_Response.h>

Inheritance diagram for ACE::FTP::Response:
Inheritance graph
[legend]
Collaboration diagram for ACE::FTP::Response:
Collaboration graph
[legend]

List of all members.

Public Types

enum  StatusType {
  NOSTATE = -1, NORESPONSE = 0, PRELIM_OK = 1, COMPLETED_OK = 2,
  INTERMEDIATE_OK = 3, TRANSIENT_FAIL = 4, PERMANENT_FAIL = 5
}
 response types More...
enum  StatusSubtype {
  NOSUBTYPE = -1, SYNTAX = 0, INFORMATION = 1, CONNECTION = 2,
  AUTHENTICATION = 3, NONE = 4, FILESYSTEM = 5
}
 response subtypes More...

Public Member Functions

 Response ()
virtual ~Response ()
void reset ()
 resets the FTP response
Responseoperator() (int status)
int status () const
 returns the current response status
void status (int status)
 sets the current response status
const ACE_Array< ACE_CString > & response () const
 retrieves the current response line(s)
Responseoperator<< (const ACE_CString &line)
 adds a response line
void write (std::ostream &str) const
 Writes the FTP response to the given stream.
bool read (std::istream &str)
StatusType status_type () const
 returns the current response type
bool is_preliminary_ok () const
 returns true if the current response type is PRELIM_OK
bool is_completed_ok () const
 returns true if the current response type is COMPLETED_OK
bool is_intermediate_ok () const
 returns true if the current response type is INTERMEDIATE_OK
bool is_transient_fail () const
 returns true if the current response type is TRANSIENT_FAIL
bool is_permanent_fail () const
 returns true if the current response type is PERMANENT_FAIL
StatusSubtype status_sub_type () const
 returns the current response sub type

Static Public Member Functions

static StatusType status_type (int status)

Private Member Functions

int read_line (std::istream &is, std::ostream &os)

Private Attributes

int status_
ACE_Array< ACE_CStringresponse_

Static Private Attributes

static const int eof_ = std::char_traits<char>::eof ()

Member Enumeration Documentation

response subtypes

Enumerator:
NOSUBTYPE 
SYNTAX 
INFORMATION 
CONNECTION 
AUTHENTICATION 
NONE 
FILESYSTEM 

response types

Enumerator:
NOSTATE 
NORESPONSE 
PRELIM_OK 
COMPLETED_OK 
INTERMEDIATE_OK 
TRANSIENT_FAIL 
PERMANENT_FAIL 

Constructor & Destructor Documentation

ACE::FTP::Response::Response ( )

Reimplemented from ACE::INet::Response.

ACE::FTP::Response::~Response ( ) [virtual]

Reimplemented from ACE::INet::Response.


Member Function Documentation

bool ACE::FTP::Response::is_completed_ok ( ) const [inline]

returns true if the current response type is COMPLETED_OK

bool ACE::FTP::Response::is_intermediate_ok ( ) const [inline]

returns true if the current response type is INTERMEDIATE_OK

bool ACE::FTP::Response::is_permanent_fail ( ) const [inline]

returns true if the current response type is PERMANENT_FAIL

bool ACE::FTP::Response::is_preliminary_ok ( ) const [inline]

returns true if the current response type is PRELIM_OK

bool ACE::FTP::Response::is_transient_fail ( ) const [inline]

returns true if the current response type is TRANSIENT_FAIL

Response & ACE::FTP::Response::operator() ( int  status) [inline]

resets the FTP response and sets the response status

Response & ACE::FTP::Response::operator<< ( const ACE_CString line) [inline]

adds a response line

bool ACE::FTP::Response::read ( std::istream &  str)

Reads the FTP response from the given stream.

int ACE::FTP::Response::read_line ( std::istream &  is,
std::ostream &  os 
) [inline, private]
void ACE::FTP::Response::reset ( ) [inline]

resets the FTP response

const ACE_Array< ACE_CString > & ACE::FTP::Response::response ( ) const [inline]

retrieves the current response line(s)

int ACE::FTP::Response::status ( ) const [inline]

returns the current response status

void ACE::FTP::Response::status ( int  status) [inline]

sets the current response status

Response::StatusSubtype ACE::FTP::Response::status_sub_type ( ) const [inline]

returns the current response sub type

Response::StatusType ACE::FTP::Response::status_type ( ) const [inline]

returns the current response type

Response::StatusType ACE::FTP::Response::status_type ( int  status) [inline, static]
void ACE::FTP::Response::write ( std::ostream &  str) const

Writes the FTP response to the given stream.


Member Data Documentation

const int ACE::FTP::Response::eof_ = std::char_traits<char>::eof () [static, private]

The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines