ACE::FTP::Response Class Reference

#include <FTP_Response.h>

Inheritance diagram for ACE::FTP::Response:

Collaboration diagram for ACE::FTP::Response:

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 , SUBTYPE_NONE = 4 , FILESYSTEM = 5 }
	response subtypes More...

Public Member Functions
	Response ()
virtual	~Response ()
void	reset ()
	resets the FTP response
Response &	operator() (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)
Response &	operator<< (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
Public Member Functions inherited from ACE::INet::Response
	Response ()

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_CString >	response_

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

Member Enumeration Documentation

StatusSubtype

enum ACE::FTP::Response::StatusSubtype

response subtypes

Enumerator
NOSUBTYPE
SYNTAX
INFORMATION
CONNECTION
AUTHENTICATION
SUBTYPE_NONE
FILESYSTEM

StatusType

enum ACE::FTP::Response::StatusType

response types

Enumerator
NOSTATE
NORESPONSE
PRELIM_OK
COMPLETED_OK
INTERMEDIATE_OK
TRANSIENT_FAIL
PERMANENT_FAIL

Constructor & Destructor Documentation

Response()

ACE::FTP::Response::Response

(

)

~Response()

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

virtual

Reimplemented from ACE::INet::Response.

Member Function Documentation

is_completed_ok()

bool ACE::FTP::Response::is_completed_ok ( ) const

inline

returns true if the current response type is COMPLETED_OK

is_intermediate_ok()

bool ACE::FTP::Response::is_intermediate_ok ( ) const

inline

returns true if the current response type is INTERMEDIATE_OK

is_permanent_fail()

bool ACE::FTP::Response::is_permanent_fail ( ) const

inline

returns true if the current response type is PERMANENT_FAIL

is_preliminary_ok()

bool ACE::FTP::Response::is_preliminary_ok ( ) const

inline

returns true if the current response type is PRELIM_OK

is_transient_fail()

bool ACE::FTP::Response::is_transient_fail ( ) const

inline

returns true if the current response type is TRANSIENT_FAIL

operator()()

Response & ACE::FTP::Response::operator() ( int  status )

inline

resets the FTP response and sets the response status

operator<<()

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

inline

adds a response line

read()

bool ACE::FTP::Response::read

(

std::istream &

str

)

Reads the FTP response from the given stream.

read_line()

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

inlineprivate

reset()

void ACE::FTP::Response::reset ( )

inline

resets the FTP response

response()

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

inline

retrieves the current response line(s)

status() [1/2]

int ACE::FTP::Response::status ( ) const

inline

returns the current response status

status() [2/2]

void ACE::FTP::Response::status ( int  status )

inline

sets the current response status

status_sub_type()

Response::StatusSubtype ACE::FTP::Response::status_sub_type ( ) const

inline

returns the current response sub type

status_type() [1/2]

Response::StatusType ACE::FTP::Response::status_type ( ) const

inline

returns the current response type

status_type() [2/2]

Response::StatusType ACE::FTP::Response::status_type ( int  status )

inlinestatic

write()

void ACE::FTP::Response::write

(

std::ostream &

str

)

const

Writes the FTP response to the given stream.

Member Data Documentation

eof_

const int ACE::FTP::Response::eof_ = std::char_traits<char>::eof ()

staticprivate

response_

ACE_Array<ACE_CString> ACE::FTP::Response::response_

private

status_

int ACE::FTP::Response::status_

private

---

The documentation for this class was generated from the following files:

• FTP_Response.h
• FTP_Response.cpp
• FTP_Response.inl