HttpRequest class

A server-side object that contains the content of and information about an HTTP request.

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();
}
Implements:

Constructors

HttpRequest ( )

Instance Properties

contentLength int
read-only
method String
read-only
uri Uri
read-only
requestedUri Uri
read-only
headers HttpHeaders
read-only
cookies List<Cookie>
read-only
persistentConnection bool
read-only
certificate X509Certificate
read-only
session HttpSession
read-only
protocolVersion String
read-only
connectionInfo HttpConnectionInfo
read-only
response HttpResponse
read-only
isEmpty Future<bool> Inherited
read-only
isBroadcast bool Inherited
read-only
first Future<List<int>> Inherited
read-only
last Future<List<int>> Inherited
read-only
single Future<List<int>> Inherited
read-only
length Future<int> Inherited
read-only

Instance Methods

pipe Inherited ( StreamConsumer<List<int>> streamConsumer ) → Future
Pipe the events of this stream into streamConsumer.
take Inherited ( int count ) → Stream<List<int>>
Provides at most the first n values of this stream.
map Inherited ( dynamic convert(T event) ) → Stream
Creates a new stream that converts each element of this stream to a new value using the convert function.
listen Inherited ( void onData(T event), {Function onError, void onDone(), bool cancelOnError} ) → StreamSubscription<List<int>>
Adds a subscription to this stream.
timeout Inherited ( Duration timeLimit, {void onTimeout(EventSink sink)} ) → Stream
Creates a new stream with the same events as this stream.
distinct Inherited ( [bool equals(T previous, T next)] ) → Stream<List<int>>
Skips data events if they are equal to the previous data event.
takeWhile Inherited ( bool test(T element) ) → Stream<List<int>>
Forwards data events while test is successful.
fold Inherited ( initialValue, dynamic combine(previous, T element) ) → Future
Reduces a sequence of values by repeatedly applying combine.
toSet Inherited ( ) → Future<Set<List<int>>>
Collects the data of this stream in a Set.
firstWhere Inherited ( bool test(T element), {Object defaultValue()} ) → Future
Finds the first element of this stream matching test.
forEach Inherited ( void action(T element) ) → Future
Executes action on each data event of the stream.
skipWhile Inherited ( bool test(T element) ) → Stream<List<int>>
Skip data events from this stream while they are matched by test.
join Inherited ( [String separator = ""] ) → Future<String>
Collects string of data events' string representations.
contains Inherited ( Object needle ) → Future<bool>
Checks whether needle occurs in the elements provided by this stream.
asyncExpand Inherited ( Stream convert(T event) ) → Stream
Creates a new stream with the events of a stream per original event.
lastWhere Inherited ( bool test(T element), {Object defaultValue()} ) → Future
Finds the last element in this stream matching test.
singleWhere Inherited ( bool test(T element) ) → Future<List<int>>
Finds the single element in this stream matching test.
drain Inherited ( [futureValue] ) → Future
Discards all data on the stream, but signals when it's done or an error occured.
asyncMap Inherited ( dynamic convert(T event) ) → Stream
Creates a new stream with each data event of this stream asynchronously mapped to a new event.
handleError Inherited ( Function onError, {bool test(error)} ) → Stream<List<int>>
Creates a wrapper Stream that intercepts some errors from this stream.
reduce Inherited ( T combine(T previous, T element) ) → Future<List<int>>
Reduces a sequence of values by repeatedly applying combine.
transform Inherited ( StreamTransformer<List<int>> streamTransformer ) → Stream
Chains this stream as the input of the provided StreamTransformer.
every Inherited ( bool test(T element) ) → Future<bool>
Checks whether test accepts all elements provided by this stream.
any Inherited ( bool test(T element) ) → Future<bool>
Checks whether test accepts any element provided by this stream.
toList Inherited ( ) → Future<List<List<int>>>
Collects the data of this stream in a List.
where Inherited ( bool test(T event) ) → Stream<List<int>>
Creates a new stream from this stream that discards some data events.
asBroadcastStream Inherited ( {void onListen(StreamSubscription<T> subscription), void onCancel(StreamSubscription<T> subscription)} ) → Stream<List<int>>
Returns a multi-subscription stream that produces the same events as this.
skip Inherited ( int count ) → Stream<List<int>>
Skips the first count data events from this stream.
expand Inherited ( Iterable convert(T value) ) → Stream
Creates a new stream from this stream that converts each element into zero or more events.
elementAt Inherited ( int index ) → Future<List<int>>
Returns the value of the indexth data event of this stream.