HttpRequest class Null safety
A server-side object that contains the content of and information about an HTTP request.
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();
}
Constructors
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
-
The cookies in the request, from the "Cookie" headers.
read-only
-
first
→ Future<
Uint8List> -
The first element of this stream.
read-only, inherited
- hashCode → int
-
The hash code for this object.
read-only, inherited
- headers → HttpHeaders
-
The request headers.
read-only
- 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<
Uint8List> -
The last element of this stream.
read-only, inherited
-
length
→ Future<
int> -
The number of elements in this stream.
read-only, inherited
- 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
- runtimeType → Type
-
A representation of the runtime type of the object.
read-only, inherited
- session → HttpSession
-
The session for the given request.
read-only
-
single
→ Future<
Uint8List> -
The single element of this stream.
read-only, inherited
- uri → Uri
-
The URI for the request.
read-only
Methods
-
any(
bool test(Uint8List element)) → Future< bool> -
Checks whether
test
accepts any element provided by this stream.inherited -
asBroadcastStream(
{void onListen(StreamSubscription< Uint8List> subscription)?, void onCancel(StreamSubscription<Uint8List> subscription)?}) → Stream<Uint8List> -
Returns a multi-subscription stream that produces the same events as this.
inherited
-
asyncExpand<
E> (Stream< E> ? convert(Uint8List event)) → Stream<E> -
Transforms each element into a sequence of asynchronous events.
inherited
-
asyncMap<
E> (FutureOr< E> convert(Uint8List 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(Uint8List previous, Uint8List next)?]) → Stream< Uint8List> -
Skips data events if they are equal to the previous data event.
inherited
-
drain<
E> ([E? futureValue]) → Future< E> -
Discards all data on this stream, but signals when it is done or an error
occurred.
inherited
-
elementAt(
int index) → Future< Uint8List> -
Returns the value of the
index
th data event of this stream.inherited -
every(
bool test(Uint8List element)) → Future< bool> -
Checks whether
test
accepts all elements provided by this stream.inherited -
expand<
S> (Iterable< S> convert(Uint8List element)) → Stream<S> -
Transforms each element of this stream into a sequence of elements.
inherited
-
firstWhere(
bool test(Uint8List element), {Uint8List orElse()?}) → Future< Uint8List> -
Finds the first element of this stream matching
test
.inherited -
fold<
S> (S initialValue, S combine(S previous, Uint8List element)) → Future< S> -
Combines a sequence of values by repeatedly applying
combine
.inherited -
forEach(
void action(Uint8List element)) → Future -
Executes
action
on each element of this stream.inherited -
handleError(
Function onError, {bool test(dynamic error)?}) → Stream< Uint8List> -
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(Uint8List element), {Uint8List orElse()?}) → Future< Uint8List> -
Finds the last element in this stream matching
test
.inherited -
listen(
void onData(Uint8List event)?, {Function? onError, void onDone()?, bool? cancelOnError}) → StreamSubscription< Uint8List> -
Adds a subscription to this stream.
inherited
-
map<
S> (S convert(Uint8List 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< Uint8List> streamConsumer) → Future -
Pipes the events of this stream into
streamConsumer
.inherited -
reduce(
Uint8List combine(Uint8List previous, Uint8List element)) → Future< Uint8List> -
Combines a sequence of values by repeatedly applying
combine
.inherited -
singleWhere(
bool test(Uint8List element), {Uint8List orElse()?}) → Future< Uint8List> -
Finds the single element in this stream matching
test
.inherited -
skip(
int count) → Stream< Uint8List> -
Skips the first
count
data events from this stream.inherited -
skipWhile(
bool test(Uint8List element)) → Stream< Uint8List> -
Skip data events from this stream while they are matched by
test
.inherited -
take(
int count) → Stream< Uint8List> -
Provides at most the first
count
data events of this stream.inherited -
takeWhile(
bool test(Uint8List element)) → Stream< Uint8List> -
Forwards data events while
test
is successful.inherited -
timeout(
Duration timeLimit, {void onTimeout(EventSink< Uint8List> sink)?}) → Stream<Uint8List> -
Creates a new stream with the same events as this stream.
inherited
-
toList(
) → Future< List< Uint8List> > -
Collects all elements of this stream in a
List
.inherited -
toSet(
) → Future< Set< Uint8List> > -
Collects the data of this stream in a
Set
.inherited -
toString(
) → String -
A string representation of this object.
inherited
-
transform<
S> (StreamTransformer< Uint8List, S> streamTransformer) → Stream<S> -
Applies
streamTransformer
to this stream.inherited -
where(
bool test(Uint8List event)) → Stream< Uint8List> -
Creates a new stream from this stream that discards some elements.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited