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

Implemented types

Stream<Uint8List>

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.
first → Future<Uint8List> read-only, inherited: The first element of this stream. [...]
hashCode → int read-only, inherited: The hash code for this object. [...]
headers → HttpHeaders read-only: The request headers. [...]
isBroadcast → bool read-only, inherited: Whether this stream is a broadcast stream.
isEmpty → Future<bool> read-only, inherited: Whether this stream contains any elements. [...]
last → Future<Uint8List> read-only, inherited: The last element of this stream. [...]
length → Future<int> read-only, inherited: The number of elements in this stream. [...]
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. [...]
runtimeType → Type read-only, inherited: A representation of the runtime type of the object.
session → HttpSession read-only: The session for the given request. [...]
single → Future<Uint8List> read-only, inherited: The single element of this stream. [...]
uri → Uri read-only: The URI for the request. [...]

Methods

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

Operators

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

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