Zen API

- Home
- Topics
- Types
- Files

All Classes Files Functions Variables Typedefs Friends Macros Modules Pages
kHttpServerRequest.h
Go to the documentation of this file.
1
10 #ifndef K_API_HTTP_SERVER_REQUEST_H
11 #define K_API_HTTP_SERVER_REQUEST_H
12
13 #include <kApi/Io/kNetwork.h>
14 #include <kApi/Io/kHttpServerRequest.x.h>
15
22 //typedef kObject kHttpServerRequest; --forward-declared in kApiDef.x.h
23
31 kFx(const kChar*) kHttpServerRequest_Method(kHttpServerRequest request);
32
43 kFx(const kChar*) kHttpServerRequest_Uri(kHttpServerRequest request);
44
52 kFx(const kChar*) kHttpServerRequest_UriPath(kHttpServerRequest request);
53
61 kFx(kVersion) kHttpServerRequest_Version(kHttpServerRequest request);
62
73 kFx(kSize) kHttpServerRequest_HeaderCount(kHttpServerRequest request);
74
82 kFx(kPointer) kHttpServerRequest_FirstHeader(kHttpServerRequest request);
83
92 kFx(kPointer) kHttpServerRequest_NextHeader(kHttpServerRequest request, kPointer header);
93
105 kFx(const kChar*) kHttpServerRequest_HeaderName(kHttpServerRequest request, kPointer header);
106
115 kFx(const kChar*) kHttpServerRequest_HeaderValue(kHttpServerRequest request, kPointer header);
116
125 kFx(const kChar*) kHttpServerRequest_FindHeaderValue(kHttpServerRequest request, const kChar* name);
126
134 kFx(kBool) kHttpServerRequest_HasBody(kHttpServerRequest request);
135
143 kFx(kBool) kHttpServerRequest_IsChunkCoded(kHttpServerRequest request);
144
152 kFx(kBool) kHttpServerRequest_IsWebSocketUpgrade(kHttpServerRequest request);
153
161 kFx(k64s) kHttpServerRequest_ContentLength(kHttpServerRequest request);
162
180 kFx(kStatus) kHttpServerRequest_BeginRead(kHttpServerRequest request, k64u* length, kStream* stream);
181
182 #endif
kHttpServerRequest::kHttpServerRequest_HeaderName
const kChar * kHttpServerRequest_HeaderName(kHttpServerRequest request, kPointer header)
Gets the field name associated with a header reference.
kHttpServerRequest::kHttpServerRequest_ContentLength
k64s kHttpServerRequest_ContentLength(kHttpServerRequest request)
Reports the total message length for a simple (non-chunk-encoded) message.
kHttpServerRequest::kHttpServerRequest_Version
kVersion kHttpServerRequest_Version(kHttpServerRequest request)
Returns a value representing the HTTP version associated with this request.
k64u
Represents a 64-bit unsigned integer.
kPointer
Represents a void pointer.
kHttpServerRequest::kHttpServerRequest_HeaderCount
kSize kHttpServerRequest_HeaderCount(kHttpServerRequest request)
Returns the total count of headers parsed from this request.
kHttpServerRequest::kHttpServerRequest_BeginRead
kStatus kHttpServerRequest_BeginRead(kHttpServerRequest request, k64u *length, kStream *stream)
Begins reading the message body.
kHttpServerRequest::kHttpServerRequest_Method
const kChar * kHttpServerRequest_Method(kHttpServerRequest request)
Returns a string representing the HTTP request method (e.g.
kHttpServerRequest::kHttpServerRequest_NextHeader
kPointer kHttpServerRequest_NextHeader(kHttpServerRequest request, kPointer header)
Given a header reference, gets a reference to the next header.
kSize
Represents an unsigned integer that can store a pointer address.
kHttpServerRequest::kHttpServerRequest_HasBody
kBool kHttpServerRequest_HasBody(kHttpServerRequest request)
Reports whether the request has an associated message body.
kChar
Represents a single unit (byte) in a UTF-8 character.
kHttpServerRequest::kHttpServerRequest_FindHeaderValue
const kChar * kHttpServerRequest_FindHeaderValue(kHttpServerRequest request, const kChar *name)
Finds the header field value associated with the given header field name, if present.
kHttpServerRequest::kHttpServerRequest_Uri
const kChar * kHttpServerRequest_Uri(kHttpServerRequest request)
Returns a string representing the HTTP request URI (/resources/page.html).
kHttpServerRequest::kHttpServerRequest_IsWebSocketUpgrade
kBool kHttpServerRequest_IsWebSocketUpgrade(kHttpServerRequest request)
Reports whether an upgrade to websocket protocol is requested.
kHttpServerRequest::kHttpServerRequest_IsChunkCoded
kBool kHttpServerRequest_IsChunkCoded(kHttpServerRequest request)
Reports whether the message body is chunk-encoded.
kHttpServerRequest::kHttpServerRequest_UriPath
const kChar * kHttpServerRequest_UriPath(kHttpServerRequest request)
Returns a string representing the HTTP request URI in absolute path form (/resources/page.html).
kStream
Represents an I/O stream.
k64s
Represents a 64-bit signed integer.
kHttpServerRequest::kHttpServerRequest_FirstHeader
kPointer kHttpServerRequest_FirstHeader(kHttpServerRequest request)
Gets a reference to the first header.
kNetwork.h
IP networking definitions.
kVersion
Represents a version number.
kStatus
Represents an error code.
kBool
Represents a boolean value.
kHttpServerRequest::kHttpServerRequest_HeaderValue
const kChar * kHttpServerRequest_HeaderValue(kHttpServerRequest request, kPointer header)
Gets the field value associated with a header reference.
kHttpServerRequest
Supports HTTP server request parsing.