.. index:: pair: class; EE::Network::Ftp::Response
.. _doxid-class_e_e_1_1_network_1_1_ftp_1_1_response:

class EE::Network::Ftp::Response
================================

.. toctree::
	:hidden:

	enum_EE_Network_Ftp_Response_Status.rst

Overview
~~~~~~~~

Define a FTP response. :ref:`More...<details-class_e_e_1_1_network_1_1_ftp_1_1_response>`


.. ref-code-block:: cpp
	:class: doxyrest-overview-code-block

	#include <ftp.hpp>
	
	class Response {
	public:
		// enums
	
		enum :ref:`Status<doxid-class_e_e_1_1_network_1_1_ftp_1_1_response_1aad73fae85e72336e25c1e317d86b7a0f>`;

		// construction
	
		:ref:`Response<doxid-class_e_e_1_1_network_1_1_ftp_1_1_response_1aa7ac6fccc4ab49231e07c70f99ce77be>`(:ref:`Status<doxid-class_e_e_1_1_network_1_1_ftp_1_1_response_1aad73fae85e72336e25c1e317d86b7a0f>` code = :ref:`InvalidResponse<doxid-class_e_e_1_1_network_1_1_ftp_1_1_response_1aad73fae85e72336e25c1e317d86b7a0fada8a6f5804b70e3e83331f9c22f57278>`, const std::string& message = "");

		// methods
	
		bool :ref:`isOk<doxid-class_e_e_1_1_network_1_1_ftp_1_1_response_1a3e1abe4dfb4acb5ba942d31c4299fe1c>`() const;
		:ref:`Status<doxid-class_e_e_1_1_network_1_1_ftp_1_1_response_1aad73fae85e72336e25c1e317d86b7a0f>` :ref:`getStatus<doxid-class_e_e_1_1_network_1_1_ftp_1_1_response_1a27ab715431a952efc87ea850d772d67d>`() const;
		const std::string& :ref:`getMessage<doxid-class_e_e_1_1_network_1_1_ftp_1_1_response_1a02deb591df1b1aee465c01ebced4079b>`() const;
	};
.. _details-class_e_e_1_1_network_1_1_ftp_1_1_response:

Detailed Documentation
~~~~~~~~~~~~~~~~~~~~~~

Define a FTP response.

Construction
------------

.. index:: pair: function; Response
.. _doxid-class_e_e_1_1_network_1_1_ftp_1_1_response_1aa7ac6fccc4ab49231e07c70f99ce77be:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	Response(:ref:`Status<doxid-class_e_e_1_1_network_1_1_ftp_1_1_response_1aad73fae85e72336e25c1e317d86b7a0f>` code = :ref:`InvalidResponse<doxid-class_e_e_1_1_network_1_1_ftp_1_1_response_1aad73fae85e72336e25c1e317d86b7a0fada8a6f5804b70e3e83331f9c22f57278>`, const std::string& message = "")

Default constructor.

This constructor is used by the FTP client to build the response.



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- code

		- :ref:`Response <doxid-class_e_e_1_1_network_1_1_ftp_1_1_response>` status code

	*
		- message

		- :ref:`Response <doxid-class_e_e_1_1_network_1_1_ftp_1_1_response>` message

Methods
-------

.. index:: pair: function; isOk
.. _doxid-class_e_e_1_1_network_1_1_ftp_1_1_response_1a3e1abe4dfb4acb5ba942d31c4299fe1c:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	bool isOk() const

Check if the status code means a success.

This function is defined for convenience, it is equivalent to testing if the status code is < 400.



.. rubric:: Returns:

True if the status is a success, false if it is a failure

.. index:: pair: function; getStatus
.. _doxid-class_e_e_1_1_network_1_1_ftp_1_1_response_1a27ab715431a952efc87ea850d772d67d:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	:ref:`Status<doxid-class_e_e_1_1_network_1_1_ftp_1_1_response_1aad73fae85e72336e25c1e317d86b7a0f>` getStatus() const

Get the status code of the response.



.. rubric:: Returns:

Status code

.. index:: pair: function; getMessage
.. _doxid-class_e_e_1_1_network_1_1_ftp_1_1_response_1a02deb591df1b1aee465c01ebced4079b:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	const std::string& getMessage() const

Get the full message contained in the response.



.. rubric:: Returns:

The response message