summaryrefslogtreecommitdiffstats
path: root/websocketpp/http/request.hpp
diff options
context:
space:
mode:
Diffstat (limited to 'websocketpp/http/request.hpp')
-rw-r--r--websocketpp/http/request.hpp124
1 files changed, 124 insertions, 0 deletions
diff --git a/websocketpp/http/request.hpp b/websocketpp/http/request.hpp
new file mode 100644
index 00000000..3355c99b
--- /dev/null
+++ b/websocketpp/http/request.hpp
@@ -0,0 +1,124 @@
+/*
+ * Copyright (c) 2014, Peter Thorson. All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ * * Redistributions of source code must retain the above copyright
+ * notice, this list of conditions and the following disclaimer.
+ * * Redistributions in binary form must reproduce the above copyright
+ * notice, this list of conditions and the following disclaimer in the
+ * documentation and/or other materials provided with the distribution.
+ * * Neither the name of the WebSocket++ Project nor the
+ * names of its contributors may be used to endorse or promote products
+ * derived from this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL PETER THORSON BE LIABLE FOR ANY
+ * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+ * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+ * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ *
+ */
+
+#ifndef HTTP_PARSER_REQUEST_HPP
+#define HTTP_PARSER_REQUEST_HPP
+
+#include <string>
+
+#include <websocketpp/common/memory.hpp>
+#include <websocketpp/http/parser.hpp>
+
+namespace websocketpp {
+namespace http {
+namespace parser {
+
+/// Stores, parses, and manipulates HTTP requests
+/**
+ * http::request provides the following functionality for working with HTTP
+ * requests.
+ *
+ * - Initialize request via manually setting each element
+ * - Initialize request via reading raw bytes and parsing
+ * - Once initialized, access individual parsed elements
+ * - Once initialized, read entire request as raw bytes
+ */
+class request : public parser {
+public:
+ typedef request type;
+ typedef lib::shared_ptr<type> ptr;
+
+ request()
+ : m_buf(lib::make_shared<std::string>())
+ , m_ready(false) {}
+
+ /// Process bytes in the input buffer
+ /**
+ * Process up to len bytes from input buffer buf. Returns the number of
+ * bytes processed. Bytes left unprocessed means bytes left over after the
+ * final header delimiters.
+ *
+ * Consume is a streaming processor. It may be called multiple times on one
+ * request and the full headers need not be available before processing can
+ * begin. If the end of the request was reached during this call to consume
+ * the ready flag will be set. Further calls to consume once ready will be
+ * ignored.
+ *
+ * Consume will throw an http::exception in the case of an error. Typical
+ * error reasons include malformed requests, incomplete requests, and max
+ * header size being reached.
+ *
+ * @param buf Pointer to byte buffer
+ * @param len Size of byte buffer
+ * @return Number of bytes processed.
+ */
+ size_t consume(char const * buf, size_t len);
+
+ /// Returns whether or not the request is ready for reading.
+ bool ready() const {
+ return m_ready;
+ }
+
+ /// Returns the full raw request (including the body)
+ std::string raw() const;
+
+ /// Returns the raw request headers only (similar to an HTTP HEAD request)
+ std::string raw_head() const;
+
+ /// Set the HTTP method. Must be a valid HTTP token
+ void set_method(std::string const & method);
+
+ /// Return the request method
+ std::string const & get_method() const {
+ return m_method;
+ }
+
+ /// Set the HTTP uri. Must be a valid HTTP uri
+ void set_uri(std::string const & uri);
+
+ /// Return the requested URI
+ std::string const & get_uri() const {
+ return m_uri;
+ }
+
+private:
+ /// Helper function for message::consume. Process request line
+ void process(std::string::iterator begin, std::string::iterator end);
+
+ lib::shared_ptr<std::string> m_buf;
+ std::string m_method;
+ std::string m_uri;
+ bool m_ready;
+};
+
+} // namespace parser
+} // namespace http
+} // namespace websocketpp
+
+#include <websocketpp/http/impl/request.hpp>
+
+#endif // HTTP_PARSER_REQUEST_HPP