topical media & game development

topical media & game development

[] readme course(s) preface I 1 2 II 3 4 III 5 6 7 IV 8 9 10 V 11 12 afterthought(s) appendix reference(s) example(s) resource(s) _

lib-of-vs-libs-Poco-include-Poco-Net-HTTPResponse.h / h


  //
  // HTTPResponse.h
  //
  //  $Id: //poco/1.3/Net/include/Poco/Net/HTTPResponse.h#2$ 
  //
  // Library: Net
  // Package: HTTP
  // Module:  HTTPResponse
  //
  // Definition of the HTTPResponse class.
  //
  // Copyright (c) 2005-2006, Applied Informatics Software Engineering GmbH.
  // and Contributors.
  //
  // Permission is hereby granted, free of charge, to any person or organization
  // obtaining a copy of the software and accompanying documentation covered by
  // this license (the "Software") to use, reproduce, display, distribute,
  // execute, and transmit the Software, and to prepare derivative works of the
  // Software, and to permit third-parties to whom the Software is furnished to
  // do so, all subject to the following:
  // 
  // The copyright notices in the Software and this entire statement, including
  // the above license grant, this restriction and the following disclaimer,
  // must be included in all copies of the Software, in whole or in part, and
  // all derivative works of the Software, unless such copies or derivative
  // works are solely in the form of machine-executable object code generated by
  // a source language processor.
  // 
  // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  // FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT
  // SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE
  // FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE,
  // ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
  // DEALINGS IN THE SOFTWARE.
  //
  
  ifndef Net_HTTPResponse_INCLUDED
  define Net_HTTPResponse_INCLUDED
  
  include "Poco/Net/Net.h"
  include "Poco/Net/HTTPMessage.h"
  include "Poco/Net/HTTPCookie.h"
  include "Poco/Timestamp.h"
  include <vector>
  
  namespace Poco {
  namespace Net {
  
  class HTTPCookie;
  
  class Net_API HTTPResponse: public HTTPMessage

This class encapsulates an HTTP response message. In addition to the properties common to all HTTP messages, a HTTP response has status code and a reason phrase. { public: enum HTTPStatus { HTTP_CONTINUE = 100, HTTP_SWITCHING_PROTOCOLS = 101, HTTP_OK = 200, HTTP_CREATED = 201, HTTP_ACCEPTED = 202, HTTP_NONAUTHORITATIVE = 203, HTTP_NO_CONTENT = 204, HTTP_RESET_CONTENT = 205, HTTP_PARTIAL_CONTENT = 206, HTTP_MULTIPLE_CHOICES = 300, HTTP_MOVED_PERMANENTLY = 301, HTTP_FOUND = 302, HTTP_SEE_OTHER = 303, HTTP_NOT_MODIFIED = 304, HTTP_USEPROXY = 305, // UNUSED: 306 HTTP_TEMPORARY_REDIRECT = 307, HTTP_BAD_REQUEST = 400, HTTP_UNAUTHORIZED = 401, HTTP_PAYMENT_REQUIRED = 402, HTTP_FORBIDDEN = 403, HTTP_NOT_FOUND = 404, HTTP_METHOD_NOT_ALLOWED = 405, HTTP_NOT_ACCEPTABLE = 406, HTTP_PROXY_AUTHENTICATION_REQUIRED = 407, HTTP_REQUEST_TIMEOUT = 408, HTTP_CONFLICT = 409, HTTP_GONE = 410, HTTP_LENGTH_REQUIRED = 411, HTTP_PRECONDITION_FAILED = 412, HTTP_REQUESTENTITYTOOLARGE = 413, HTTP_REQUESTURITOOLONG = 414, HTTP_UNSUPPORTEDMEDIATYPE = 415, HTTP_REQUESTED_RANGE_NOT_SATISFIABLE = 416, HTTP_EXPECTATION_FAILED = 417, HTTP_INTERNAL_SERVER_ERROR = 500, HTTP_NOT_IMPLEMENTED = 501, HTTP_BAD_GATEWAY = 502, HTTP_SERVICE_UNAVAILABLE = 503, HTTP_GATEWAY_TIMEOUT = 504, HTTP_VERSION_NOT_SUPPORTED = 505 };


          HTTPResponse();

Creates the HTTPResponse with OK status. HTTPResponse(HTTPStatus status, const std::string& reason); Creates the HTTPResponse with the given status and reason phrase.


          HTTPResponse(const std::string& version, HTTPStatus status, const std::string& reason);

Creates the HTTPResponse with the given version, status and reason phrase. HTTPResponse(HTTPStatus status); Creates the HTTPResponse with the given status an an appropriate reason phrase.


          HTTPResponse(const std::string& version, HTTPStatus status);

Creates the HTTPResponse with the given version, status an an appropriate reason phrase.


          virtual ~HTTPResponse();

Destroys the HTTPResponse.


          void setStatus(HTTPStatus status);

Sets the HTTP status code. Does not change the reason phrase. HTTPStatus getStatus() const; Returns the HTTP status code. void setStatus(const std::string& status); Sets the HTTP status code. The string must contain a valid HTTP numerical status code. void setReason(const std::string& reason); Sets the HTTP reason phrase. const std::string& getReason() const; Returns the HTTP reason phrase.


          void setStatusAndReason(HTTPStatus status, const std::string& reason);

Sets the HTTP status code and reason phrase. void setStatusAndReason(HTTPStatus status); Sets the HTTP status code and reason phrase. The reason phrase is set according to the status code.


          void setDate(const Poco::Timestamp& dateTime);

Sets the Date header to the given date/time value. Poco::Timestamp getDate() const; Returns the value of the Date header.


          void addCookie(const HTTPCookie& cookie);

Adds the cookie to the response by adding a Set-Cookie header.


          void getCookies(std::vector<HTTPCookie>& cookies) const;

Returns a vector with all the cookies set in the response header. May throw an exception in case of a malformed Set-Cookie header.


          void write(std::ostream& ostr) const;

Writes the HTTP response to the given output stream.


          void read(std::istream& istr);

Reads the HTTP response from the given input stream. 100 Continue responses are ignored. static const std::string& getReasonForStatus(HTTPStatus status); Returns an appropriate reason phrase for the given status code.


          static const std::string HTTP_REASON_CONTINUE;
          static const std::string HTTP_REASON_SWITCHING_PROTOCOLS;
          static const std::string HTTP_REASON_OK;
          static const std::string HTTP_REASON_CREATED;
          static const std::string HTTP_REASON_ACCEPTED;
          static const std::string HTTP_REASON_NONAUTHORITATIVE;
          static const std::string HTTP_REASON_NO_CONTENT;
          static const std::string HTTP_REASON_RESET_CONTENT;
          static const std::string HTTP_REASON_PARTIAL_CONTENT;
          static const std::string HTTP_REASON_MULTIPLE_CHOICES;
          static const std::string HTTP_REASON_MOVED_PERMANENTLY;
          static const std::string HTTP_REASON_FOUND;
          static const std::string HTTP_REASON_SEE_OTHER;
          static const std::string HTTP_REASON_NOT_MODIFIED;
          static const std::string HTTP_REASON_USEPROXY;
          static const std::string HTTP_REASON_TEMPORARY_REDIRECT;
          static const std::string HTTP_REASON_BAD_REQUEST;
          static const std::string HTTP_REASON_UNAUTHORIZED;
          static const std::string HTTP_REASON_PAYMENT_REQUIRED;
          static const std::string HTTP_REASON_FORBIDDEN;
          static const std::string HTTP_REASON_NOT_FOUND;
          static const std::string HTTP_REASON_METHOD_NOT_ALLOWED;
          static const std::string HTTP_REASON_NOT_ACCEPTABLE;
          static const std::string HTTP_REASON_PROXY_AUTHENTICATION_REQUIRED;
          static const std::string HTTP_REASON_REQUEST_TIMEOUT;
          static const std::string HTTP_REASON_CONFLICT;
          static const std::string HTTP_REASON_GONE;
          static const std::string HTTP_REASON_LENGTH_REQUIRED;
          static const std::string HTTP_REASON_PRECONDITION_FAILED;
          static const std::string HTTP_REASON_REQUESTENTITYTOOLARGE;
          static const std::string HTTP_REASON_REQUESTURITOOLONG;
          static const std::string HTTP_REASON_UNSUPPORTEDMEDIATYPE;
          static const std::string HTTP_REASON_REQUESTED_RANGE_NOT_SATISFIABLE;
          static const std::string HTTP_REASON_EXPECTATION_FAILED;
          static const std::string HTTP_REASON_INTERNAL_SERVER_ERROR;
          static const std::string HTTP_REASON_NOT_IMPLEMENTED;
          static const std::string HTTP_REASON_BAD_GATEWAY;
          static const std::string HTTP_REASON_SERVICE_UNAVAILABLE;
          static const std::string HTTP_REASON_GATEWAY_TIMEOUT;
          static const std::string HTTP_REASON_VERSION_NOT_SUPPORTED;
          static const std::string HTTP_REASON_UNKNOWN;
          
          static const std::string DATE;
          static const std::string SET_COOKIE;
  
  private:
          enum Limits
          {
                  MAX_VERSION_LENGTH = 8,
                  MAX_STATUS_LENGTH  = 3,
                  MAX_REASON_LENGTH  = 512
          };
          
          HTTPStatus  _status;
          std::string _reason;
          
          HTTPResponse(const HTTPResponse&);
          HTTPResponse& operator = (const HTTPResponse&);
  };
  
  //
  // inlines
  //
  inline HTTPResponse::HTTPStatus HTTPResponse::getStatus() const
  {
          return _status;
  }
  
  inline const std::string& HTTPResponse::getReason() const
  {
          return _reason;
  }
  
  } } // namespace Poco::Net
  
  endif // Net_HTTPResponse_INCLUDED

[] readme course(s) preface I 1 2 II 3 4 III 5 6 7 IV 8 9 10 V 11 12 afterthought(s) appendix reference(s) example(s) resource(s) _

You may not copy or print any of this material without explicit permission of the author or the publisher. In case of other copyright issues, contact the author.