HTTPResponse.h

Go to the documentation of this file.

/*
 * Copyright 2006-2009 Savarese Software Research Corporation
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     https://www.savarese.com/software/ApacheLicense-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#ifndef __SSRC_WSPR_FCGI_HTTP_RESPONSE_H
#define __SSRC_WSPR_FCGI_HTTP_RESPONSE_H

#include <string>
#include <boost/filesystem/path.hpp>

#include <ssrc/wispers-packages.h>

__BEGIN_NS_SSRC_WSPR_FCGI

using std::string;

enum HTTPStatusCode {
  StatusOK                   = 200,
  StatusFound                = 302,
  StatusBadRequest           = 400,
  StatusUnauthorized         = 401,
  StatusPaymentRequired      = 402,
  StatusForbidden            = 403,
  StatusNotFound             = 404,
  StatusMethodNotAllowed     = 405,
  StatusNotAcceptable        = 406,
  StatusProxyAuthenticationRequired = 407,
  StatusRequestTimeout       = 408,
  StatusConflict             = 409,
  StatusGone                 = 410,
  StatusLengthRequired       = 411,
  StatusPreconditionFailed   = 412,
  StatusRequestEntityTooLarge = 413,
  StatusRequestURITooLong    = 414,
  StatusInternalServerError  = 500,
  StatusMethodNotImplemented = 501,
  StatusBadGateway           = 502,
  StatusServiceUnavailable   = 503,
  StatusGatewayTimeout       = 504
};

const bool CacheDisable = true;
const bool CacheEnable  = false;

struct HTTPResponse {

  virtual ~HTTPResponse() { }

  virtual void complete(const char *content = 0,
                        const unsigned int content_length = 0,
                        bool cache_disable = CacheEnable) = 0;

  virtual bool completed() const = 0;

  virtual void suspend() = 0;

  virtual void resume() = 0;

  virtual bool suspended() const = 0;

  virtual void send_error(const HTTPStatusCode status) = 0;

  virtual void send_redirect(const string & redirect) = 0;

  virtual void set_content_type(const string & type) = 0;

  virtual const string & content_type() const = 0;

  virtual void set_status(const HTTPStatusCode status) = 0;

  virtual HTTPStatusCode status() const = 0;

  /*
  typedef HTTPRequest::parameter_map header_map;
  virtual void set_header(const header_map::value_type & header_value) = 0;
  virtual void add_header(const header_map::value_type & header_value) = 0;
  */

  // TODO: Add domain support.
  virtual void set_session_id(const string & session_id,
                              const unsigned int max_age = 1,
                              const bool secure = false) = 0;

  virtual void clear_session_id() = 0;

  virtual const string & session_id() const = 0;
};


__END_NS_SSRC_WSPR_FCGI

#endif