A server-side object that contains the content of and information about an HTTP request.
Note: Check out the http_server package, which makes working with the low-level dart:io HTTP server subsystem easier.
HttpRequest
objects are generated by an HttpServer,
which listens for HTTP requests on a specific host and port.
For each request received, the HttpServer, which is a Stream,
generates an HttpRequest
object and adds it to the stream.
An HttpRequest
object delivers the body content of the request
as a stream of byte lists.
The object also contains information about the request,
such as the method, URI, and headers.
In the following code, an HttpServer listens
for HTTP requests. When the server receives a request,
it uses the HttpRequest object's method
property to dispatch requests.
final HOST = InternetAddress.LOOPBACK_IP_V4;
final PORT = 80;
HttpServer.bind(HOST, PORT).then((_server) {
_server.listen((HttpRequest request) {
switch (request.method) {
case 'GET':
handleGetRequest(request);
break;
case 'POST':
...
}
},
onError: handleError); // listen() failed.
}).catchError(handleError);
An HttpRequest object provides access to the associated HttpResponse object through the response property. The server writes its response to the body of the HttpResponse object. For example, here's a function that responds to a request:
void handleGetRequest(HttpRequest req) {
HttpResponse res = req.response;
res.write('Received request ${req.method}: ${req.uri.path}');
res.close();
}
Properties
- X509Certificate certificate
-
read-onlyThe client certificate of the client making the request.
- HttpConnectionInfo connectionInfo
-
read-onlyInformation about the client connection.
- int contentLength
-
read-onlyThe content length of the request body.
-
read-onlyThe cookies in the request, from the Cookie headers.
- Future<List<int>> first
-
read-only, inheritedReturns the first element of the stream.
- HttpHeaders headers
-
read-onlyThe request headers.
- bool isBroadcast
-
read-only, inheritedReports whether this stream is a broadcast stream.
- Future<bool> isEmpty
-
read-only, inheritedReports whether this stream contains any elements.
- Future<List<int>> last
-
read-only, inheritedReturns the last element of the stream.
- Future<int> length
-
read-only, inheritedCounts the elements in the stream.
- String method
-
read-onlyThe method, such as 'GET' or 'POST', for the request.
- bool persistentConnection
-
read-onlyThe persistent connection state signaled by the client.
- String protocolVersion
-
read-onlyThe HTTP protocol version used in the request, either "1.0" or "1.1".
- Uri requestedUri
-
read-onlyThe requested URI for the request.
- HttpResponse response
-
read-onlyThe
HttpResponse
object, used for sending back the response to the client. - HttpSession session
-
read-onlyThe session for the given request.
- Future<List<int>> single
-
read-only, inheritedReturns the single element.
- Uri uri
-
read-onlyThe URI for the request.
Constructors
Methods
-
any(
bool test(T element)) → Future<bool> -
inheritedChecks whether
test
accepts any element provided by this stream. -
asBroadcastStream(
{void onListen(StreamSubscription<T> subscription), void onCancel(StreamSubscription<T> subscription)}) → Stream<List<int>> -
inheritedReturns a multi-subscription stream that produces the same events as this.
-
asyncExpand(
Stream convert(T event)) → Stream -
inheritedCreates a new stream with the events of a stream per original event.
-
asyncMap(
dynamic convert(T event)) → Stream -
inheritedCreates a new stream with each data event of this stream asynchronously mapped to a new event.
-
contains(
Object needle) → Future<bool> -
inheritedChecks whether
needle
occurs in the elements provided by this stream. -
distinct(
[bool equals(T previous, T next)]) → Stream<List<int>> -
inheritedSkips data events if they are equal to the previous data event.
-
drain(
[futureValue]) → Future -
inheritedDiscards all data on the stream, but signals when it's done or an error occured.
-
elementAt(
int index) → Future<List<int>> -
inheritedReturns the value of the
index
th data event of this stream. -
every(
bool test(T element)) → Future<bool> -
inheritedChecks whether
test
accepts all elements provided by this stream. -
expand(
Iterable convert(T value)) → Stream -
inheritedCreates a new stream from this stream that converts each element into zero or more events.
-
firstWhere(
bool test(T element), {Object defaultValue()}) → Future -
inheritedFinds the first element of this stream matching
test
. -
fold(
initialValue, dynamic combine(previous, T element)) → Future -
inheritedReduces a sequence of values by repeatedly applying
combine
. -
forEach(
void action(T element)) → Future -
inheritedExecutes
action
on each data event of the stream. -
handleError(
Function onError, {bool test(error)}) → Stream<List<int>> -
inheritedCreates a wrapper Stream that intercepts some errors from this stream.
-
join(
[String separator = ""]) → Future<String> -
inheritedCollects string of data events' string representations.
-
lastWhere(
bool test(T element), {Object defaultValue()}) → Future -
inheritedFinds the last element in this stream matching
test
. -
listen(
void onData(T event), {Function onError, void onDone(), bool cancelOnError}) → StreamSubscription<List<int>> -
inheritedAdds a subscription to this stream.
-
map(
dynamic convert(T event)) → Stream -
inheritedCreates a new stream that converts each element of this stream to a new value using the
convert
function. -
pipe(
StreamConsumer<List<int>> streamConsumer) → Future -
inheritedPipe the events of this stream into
streamConsumer
. -
reduce(
T combine(T previous, T element)) → Future<List<int>> -
inheritedReduces a sequence of values by repeatedly applying
combine
. -
singleWhere(
bool test(T element)) → Future<List<int>> -
inheritedFinds the single element in this stream matching
test
. -
skip(
int count) → Stream<List<int>> -
inheritedSkips the first
count
data events from this stream. -
skipWhile(
bool test(T element)) → Stream<List<int>> -
inheritedSkip data events from this stream while they are matched by
test
. -
take(
int count) → Stream<List<int>> -
inheritedProvides at most the first
n
values of this stream. -
takeWhile(
bool test(T element)) → Stream<List<int>> -
inheritedForwards data events while
test
is successful. -
timeout(
Duration timeLimit, {void onTimeout(EventSink sink)}) → Stream -
inheritedCreates a new stream with the same events as this stream.
-
toList(
) → Future<List<List<int>>> -
inheritedCollects the data of this stream in a List.
-
toSet(
) → Future<Set<List<int>>> -
inheritedCollects the data of this stream in a Set.
-
transform(
StreamTransformer<List<int>> streamTransformer) → Stream -
inheritedChains this stream as the input of the provided StreamTransformer.
-
where(
bool test(T event)) → Stream<List<int>> -
inheritedCreates a new stream from this stream that discards some data events.