HttpRequest abstract 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.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

Stream<List<int>>

Constructors

HttpRequest()

Properties

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

Operators

operator ==(other) → bool inherited: The equality operator.

Methods

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

© 2012 the Dart project authors
Licensed under the Creative Commons Attribution-ShareAlike License v4.0.
https://api.dartlang.org/stable/1.24.3/dart-io/HttpRequest-class.html