httparsed 1.2.1
Fast betterC/nogc HTTP request/response parser
To use this package, run the following command in your project's root directory:
Manual usage
Put the following dependency into your project's dependences section:
httparsed
Push parser of HTTP/1.x requests and responses. Other internet message like protocols (ie RTSP) are supported too.
Inspired by picohttpparser.
Features
- doesn't allocate anything on it's own (
nothrow @nogc
) - works with
betterC
- uses compile time introspection to pass parsed message parts to callbacks
- doesn't store any internal state
- handles incomplete messages and can continue parsing from previous buffer index
- no dependencies
- uses SSE4.2 with LDC2 compiler and SSE4.2 enabled target CPU
Usage
// define our message content handler
struct Header
{
const(char)[] name;
const(char)[] value;
}
// Just store slices of parsed message header
struct Msg
{
@safe pure nothrow @nogc:
void onMethod(const(char)[] method) { this.method = method; }
void onUri(const(char)[] uri) { this.uri = uri; }
int onVersion(const(char)[] ver)
{
minorVer = parseHttpVersion(ver);
return minorVer >= 0 ? 0 : minorVer;
}
void onHeader(const(char)[] name, const(char)[] value) {
this.m_headers[m_headersLength].name = name;
this.m_headers[m_headersLength++].value = value;
}
void onStatus(int status) { this.status = status; }
void onStatusMsg(const(char)[] statusMsg) { this.statusMsg = statusMsg; }
const(char)[] method;
const(char)[] uri;
int minorVer;
int status;
const(char)[] statusMsg;
private {
Header[32] m_headers;
size_t m_headersLength;
}
Header[] headers() return { return m_headers[0..m_headersLength]; }
}
// init parser
auto reqParser = initParser!Msg(); // or `MsgParser!MSG reqParser;`
auto resParser = initParser!Msg(); // or `MsgParser!MSG resParser;`
// parse request
string data = "GET /foo HTTP/1.1\r\nHost: 127.0.0.1:8090\r\n\r\n";
// returns parsed message header length when parsed sucessfully, -ParserError on error
int res = reqParser.parseRequest(data);
assert(res == data.length);
assert(reqParser.method == "GET");
assert(reqParser.uri == "/foo");
assert(reqParser.minorVer == 1); // HTTP/1.1
assert(reqParser.headers.length == 1);
assert(reqParser.headers[0].name == "Host");
assert(reqParser.headers[0].value == "127.0.0.1:8090");
// parse response
data = "HTTP/1.0 200 OK\r\n";
uint lastPos; // store last parsed position for next run
res = resParser.parseResponse(data, lastPos);
assert(res == -ParserError.partial); // no complete message header yet
data = "HTTP/1.0 200 OK\r\nContent-Type: text/plain\r\nContent-Length: 3\r\n\r\nfoo";
res = resParser.parseResponse(data, lastPos); // starts parsing from previous position
assert(res == data.length - 3); // whole message header parsed, body left to be handled based on actual header values
assert(resParser.minorVer == 0); // HTTP/1.0
assert(resParser.status == 200);
assert(resParser.statusMsg == "OK");
assert(resParser.headers.length == 2);
assert(resParser.headers[0].name == "Content-Type");
assert(resParser.headers[0].value == "text/plain");
assert(resParser.headers[1].name == "Content-Length");
assert(resParser.headers[1].value == "3");
Adding library to your project
To use this library just add dependency "httparsed" version=">=1.1.0"
to your dub.sdl
project configuration.
Or just copypaste the whole file and use it directly.
SSE4.2
To use SSE4.2 use this in your dub.sdl
:
dflags "-mcpu=native" platform="ldc"
Performance
- Tested on:
AMD Ryzen 7 3700X 8-Core Processor
- Best of 5 runs for each parser
- tested parsers:
- httparsed (noop) - this parser but with a provided message context with no callbacks - it just parses through requests, but doesn't use anything
- httparsed - this parser with a simple msg struct as in example above
- picohttpparser
- http_parser
- llhttp - replacement of http_parser
- vibe-d - stripped down version of HTTP request parser used in vibe-d
- arsd - stripped down HTTP request parser of arsd's
cgi.d
package
- Registered by Tomáš Chaloupka
- 1.2.1 released 3 years ago
- tchaloupka/httparsed
- public domain
- Authors:
- Dependencies:
- none
- Versions:
-
1.2.1 2021-Jul-26 1.2.0 2020-Dec-16 1.1.1 2020-Dec-15 1.1.0 2020-Dec-15 1.0.1 2020-Dec-14 - Download Stats:
-
-
9 downloads today
-
60 downloads this week
-
237 downloads this month
-
45399 downloads total
-
- Score:
- 3.5
- Short URL:
- httparsed.dub.pm