HttpRequest class

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.loopbackIPv4;
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()

Properties

certificate X509Certificate
The client certificate of the client making the request. [...]
read-only
connectionInfo HttpConnectionInfo
Information about the client connection. [...]
read-only
contentLength int
The content length of the request body. [...]
read-only
cookies List<Cookie>
The cookies in the request, from the Cookie headers.
read-only
headers HttpHeaders
The request headers. [...]
read-only
method String
The method, such as 'GET' or 'POST', for the request.
read-only
persistentConnection bool
The persistent connection state signaled by the client.
read-only
protocolVersion String
The HTTP protocol version used in the request, either "1.0" or "1.1".
read-only
requestedUri Uri
The requested URI for the request. [...]
read-only
response HttpResponse
The HttpResponse object, used for sending back the response to the client. [...]
read-only
session HttpSession
The session for the given request. [...]
read-only
uri Uri
The URI for the request. [...]
read-only
first Future<List<int>>
The first element of the stream. [...]
read-only, inherited
hashCode int
The hash code for this object. [...]
read-only, inherited
isBroadcast bool
Whether this stream is a broadcast stream.
read-only, inherited
isEmpty Future<bool>
Whether this stream contains any elements. [...]
read-only, inherited
last Future<List<int>>
The last element of this stream. [...]
read-only, inherited
length Future<int>
The number of elements in this stream. [...]
read-only, inherited
runtimeType Type
A representation of the runtime type of the object.
read-only, inherited
single Future<List<int>>
The single element of this stream. [...]
read-only, inherited

Methods

any(bool test(T element)) Future<bool>
Checks whether test accepts any element provided by this stream. [...]
inherited
asBroadcastStream({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. [...]
inherited
asyncExpand<E>(Stream<E> convert(T event)) Stream<E>
Transforms each element into a sequence of asynchronous events. [...]
inherited
asyncMap<E>(FutureOr<E> convert(T event)) Stream<E>
Creates a new stream with each data event of this stream asynchronously mapped to a new event. [...]
inherited
cast<R>() Stream<R>
Adapt this stream to be a Stream<R>. [...]
inherited
contains(Object needle) Future<bool>
Returns whether needle occurs in the elements provided by this stream. [...]
inherited
distinct([bool equals(T previous, T next) ]) Stream<List<int>>
Skips data events if they are equal to the previous data event. [...]
inherited
drain<E>([E futureValue ]) Future<E>
Discards all data on the stream, but signals when it's done or an error occurred. [...]
inherited
elementAt(int index) Future<List<int>>
Returns the value of the indexth data event of this stream. [...]
inherited
every(bool test(T element)) Future<bool>
Checks whether test accepts all elements provided by this stream. [...]
inherited
expand<S>(Iterable<S> convert(T element)) Stream<S>
Transforms each element of this stream into a sequence of elements. [...]
inherited
firstWhere(bool test(T element), { List<int> orElse() }) Future<List<int>>
Finds the first element of this stream matching test. [...]
inherited
fold<S>(S initialValue, S combine(S previous, T element)) Future<S>
Combines a sequence of values by repeatedly applying combine. [...]
inherited
forEach(void action(T element)) Future
Executes action on each element of the stream. [...]
inherited
handleError(Function onError, { bool test(dynamic error) }) Stream<List<int>>
Creates a wrapper Stream that intercepts some errors from this stream. [...]
inherited
join([String separator = "" ]) Future<String>
Combines the string representation of elements into a single string. [...]
inherited
lastWhere(bool test(T element), { List<int> orElse() }) Future<List<int>>
Finds the last element in this stream matching test. [...]
inherited
listen(void onData(T event), { Function onError, void onDone(), bool cancelOnError }) StreamSubscription<List<int>>
Adds a subscription to this stream. [...]
inherited
map<S>(S convert(T event)) Stream<S>
Transforms each element of this stream into a new stream event. [...]
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a non-existent method or property is accessed. [...]
inherited
pipe(StreamConsumer<List<int>> streamConsumer) Future
Pipes the events of this stream into streamConsumer. [...]
inherited
reduce(List<int> combine(T previous, T element)) Future<List<int>>
Combines a sequence of values by repeatedly applying combine. [...]
inherited
singleWhere(bool test(T element), { List<int> orElse() }) Future<List<int>>
Finds the single element in this stream matching test. [...]
inherited
skip(int count) Stream<List<int>>
Skips the first count data events from this stream. [...]
inherited
skipWhile(bool test(T element)) Stream<List<int>>
Skip data events from this stream while they are matched by test. [...]
inherited
take(int count) Stream<List<int>>
Provides at most the first count data events of this stream. [...]
inherited
takeWhile(bool test(T element)) Stream<List<int>>
Forwards data events while test is successful. [...]
inherited
timeout(Duration timeLimit, { void onTimeout(EventSink<T> sink) }) Stream<List<int>>
Creates a new stream with the same events as this stream. [...]
inherited
toList() Future<List<List<int>>>
Collects all elements of this stream in a List. [...]
inherited
toSet() Future<Set<List<int>>>
Collects the data of this stream in a Set. [...]
inherited
toString() String
Returns a string representation of this object.
inherited
transform<S>(StreamTransformer<List<int>, S> streamTransformer) Stream<S>
Applies a StreamTransformer to the current stream. [...]
inherited
where(bool test(T event)) Stream<List<int>>
Creates a new stream from this stream that discards some elements. [...]
inherited

Operators

operator ==(dynamic other) bool
The equality operator. [...]
inherited