WebSocket++  0.8.0-dev
C++ websocket client/server library
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Pages
request.hpp
1 /*
2  * Copyright (c) 2014, Peter Thorson. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions are met:
6  * * Redistributions of source code must retain the above copyright
7  * notice, this list of conditions and the following disclaimer.
8  * * Redistributions in binary form must reproduce the above copyright
9  * notice, this list of conditions and the following disclaimer in the
10  * documentation and/or other materials provided with the distribution.
11  * * Neither the name of the WebSocket++ Project nor the
12  * names of its contributors may be used to endorse or promote products
13  * derived from this software without specific prior written permission.
14  *
15  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
16  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18  * ARE DISCLAIMED. IN NO EVENT SHALL PETER THORSON BE LIABLE FOR ANY
19  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
20  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
21  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
22  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
24  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25  *
26  */
27 
28 #ifndef HTTP_PARSER_REQUEST_HPP
29 #define HTTP_PARSER_REQUEST_HPP
30 
31 #include <string>
32 
33 #include <websocketpp/common/memory.hpp>
34 #include <websocketpp/http/parser.hpp>
35 
36 namespace websocketpp {
37 namespace http {
38 namespace parser {
39 
40 /// Stores, parses, and manipulates HTTP requests
41 /**
42  * http::request provides the following functionality for working with HTTP
43  * requests.
44  *
45  * - Initialize request via manually setting each element
46  * - Initialize request via reading raw bytes and parsing
47  * - Once initialized, access individual parsed elements
48  * - Once initialized, read entire request as raw bytes
49  */
50 class request : public parser {
51 public:
52  typedef request type;
53  typedef lib::shared_ptr<type> ptr;
54 
55  request()
56  : m_buf(lib::make_shared<std::string>())
57  , m_ready(false) {}
58 
59  /// Process bytes in the input buffer
60  /**
61  * Process up to len bytes from input buffer buf. Returns the number of
62  * bytes processed. Bytes left unprocessed means bytes left over after the
63  * final header delimiters.
64  *
65  * Consume is a streaming processor. It may be called multiple times on one
66  * request and the full headers need not be available before processing can
67  * begin. If the end of the request was reached during this call to consume
68  * the ready flag will be set. Further calls to consume once ready will be
69  * ignored.
70  *
71  * Consume will throw an http::exception in the case of an error. Typical
72  * error reasons include malformed requests, incomplete requests, and max
73  * header size being reached.
74  *
75  * @param buf Pointer to byte buffer
76  * @param len Size of byte buffer
77  * @return Number of bytes processed.
78  */
79  size_t consume(char const * buf, size_t len);
80 
81  /// Returns whether or not the request is ready for reading.
82  bool ready() const {
83  return m_ready;
84  }
85 
86  /// Returns the full raw request (including the body)
87  std::string raw() const;
88 
89  /// Returns the raw request headers only (similar to an HTTP HEAD request)
90  std::string raw_head() const;
91 
92  /// Set the HTTP method. Must be a valid HTTP token
93  void set_method(std::string const & method);
94 
95  /// Return the request method
96  std::string const & get_method() const {
97  return m_method;
98  }
99 
100  /// Set the HTTP uri. Must be a valid HTTP uri
101  void set_uri(std::string const & uri);
102 
103  /// Return the requested URI
104  std::string const & get_uri() const {
105  return m_uri;
106  }
107 
108 private:
109  /// Helper function for message::consume. Process request line
110  void process(std::string::iterator begin, std::string::iterator end);
111 
112  lib::shared_ptr<std::string> m_buf;
113  std::string m_method;
114  std::string m_uri;
115  bool m_ready;
116 };
117 
118 } // namespace parser
119 } // namespace http
120 } // namespace websocketpp
121 
122 #include <websocketpp/http/impl/request.hpp>
123 
124 #endif // HTTP_PARSER_REQUEST_HPP
std::string raw() const
Returns the full raw request (including the body)
Definition: request.hpp:131
std::string raw_head() const
Returns the raw request headers only (similar to an HTTP HEAD request)
Definition: request.hpp:141
std::string const & get_uri() const
Return the requested URI.
Definition: request.hpp:104
HTTP handling support.
Definition: constants.hpp:39
void handle_accept(connection_ptr con, lib::error_code const &ec)
Handler callback for start_accept.
void set_uri(std::string const &uri)
Set the HTTP uri. Must be a valid HTTP uri.
Definition: request.hpp:159
size_t consume(char const *buf, size_t len)
Process bytes in the input buffer.
Definition: request.hpp:41
void set_method(std::string const &method)
Set the HTTP method. Must be a valid HTTP token.
Definition: request.hpp:151
bool ready() const
Returns whether or not the request is ready for reading.
Definition: request.hpp:82
std::string const & get_method() const
Return the request method.
Definition: request.hpp:96