HTTP response for a client connection.
The body of a HttpClientResponse object is a Stream of data from the server. Listen to the body to handle the data and be notified when the entire body is received.
new HttpClient().get('localhost', 80, '/file.txt')
.then((HttpClientRequest request) => request.close())
.then((HttpClientResponse response) {
response.transform(UTF8.decoder).listen((contents) {
// handle data
});
});
Properties
- X509Certificate certificate
-
read-onlyReturns the certificate of the HTTPS server providing the response. Returns null if the connection is not a secure TLS or SSL connection.
- HttpConnectionInfo connectionInfo
-
read-onlyGets information about the client connection. Returns
null
if the socket is not available. - int contentLength
-
read-onlyReturns the content length of the response body. Returns -1 if the size of the response body is not known in advance.
-
read-onlyCookies set by the server (from the 'set-cookie' header).
- Future<List<int>> first
-
read-only, inheritedReturns the first element of the stream.
- HttpHeaders headers
-
read-onlyReturns the client response headers.
- bool isBroadcast
-
read-only, inheritedReports whether this stream is a broadcast stream.
- Future<bool> isEmpty
-
read-only, inheritedReports whether this stream contains any elements.
- bool isRedirect
-
read-onlyReturns whether the status code is one of the normal redirect codes
HttpStatus.MOVED_PERMANENTLY
,HttpStatus.FOUND
,HttpStatus.MOVED_TEMPORARILY
,HttpStatus.SEE_OTHER
andHttpStatus.TEMPORARY_REDIRECT
. - Future<List<int>> last
-
read-only, inheritedReturns the last element of the stream.
- Future<int> length
-
read-only, inheritedCounts the elements in the stream.
- bool persistentConnection
-
read-onlyGets the persistent connection state returned by the server.
- String reasonPhrase
-
read-onlyReturns the reason phrase associated with the status code.
- List<RedirectInfo> redirects
-
read-onlyReturns the series of redirects this connection has been through. The list will be empty if no redirects were followed.
redirects
will be updated both in the case of an automatic and a manual redirect. - Future<List<int>> single
-
read-only, inheritedReturns the single element.
- int statusCode
-
read-onlyReturns the status code.
Constructors
Methods
-
any(
bool test(T element)) → Future<bool> -
inheritedChecks whether
test
accepts any element provided by this stream. -
asBroadcastStream(
{void onListen(StreamSubscription<T> subscription), void onCancel(StreamSubscription<T> subscription)}) → Stream<List<int>> -
inheritedReturns a multi-subscription stream that produces the same events as this.
-
asyncExpand(
Stream convert(T event)) → Stream -
inheritedCreates a new stream with the events of a stream per original event.
-
asyncMap(
dynamic convert(T event)) → Stream -
inheritedCreates a new stream with each data event of this stream asynchronously mapped to a new event.
-
contains(
Object needle) → Future<bool> -
inheritedChecks whether
needle
occurs in the elements provided by this stream. -
detachSocket(
) → Future<Socket> - Detach the underlying socket from the HTTP client. When the socket is detached the HTTP client will no longer perform any operations on it.
-
distinct(
[bool equals(T previous, T next)]) → Stream<List<int>> -
inheritedSkips data events if they are equal to the previous data event.
-
drain(
[futureValue]) → Future -
inheritedDiscards all data on the stream, but signals when it's done or an error occured.
-
elementAt(
int index) → Future<List<int>> -
inheritedReturns the value of the
index
th data event of this stream. -
every(
bool test(T element)) → Future<bool> -
inheritedChecks whether
test
accepts all elements provided by this stream. -
expand(
Iterable convert(T value)) → Stream -
inheritedCreates a new stream from this stream that converts each element into zero or more events.
-
firstWhere(
bool test(T element), {Object defaultValue()}) → Future -
inheritedFinds the first element of this stream matching
test
. -
fold(
initialValue, dynamic combine(previous, T element)) → Future -
inheritedReduces a sequence of values by repeatedly applying
combine
. -
forEach(
void action(T element)) → Future -
inheritedExecutes
action
on each data event of the stream. -
handleError(
Function onError, {bool test(error)}) → Stream<List<int>> -
inheritedCreates a wrapper Stream that intercepts some errors from this stream.
-
join(
[String separator = ""]) → Future<String> -
inheritedCollects string of data events' string representations.
-
lastWhere(
bool test(T element), {Object defaultValue()}) → Future -
inheritedFinds the last element in this stream matching
test
. -
listen(
void onData(T event), {Function onError, void onDone(), bool cancelOnError}) → StreamSubscription<List<int>> -
inheritedAdds a subscription to this stream.
-
map(
dynamic convert(T event)) → Stream -
inheritedCreates a new stream that converts each element of this stream to a new value using the
convert
function. -
pipe(
StreamConsumer<List<int>> streamConsumer) → Future -
inheritedPipe the events of this stream into
streamConsumer
. -
redirect(
[String method, Uri url, bool followLoops]) → Future<HttpClientResponse> -
Redirects this connection to a new URL. The default value for
method
is the method for the current request. The default value forurl
is the value of the HttpHeaders.LOCATION header of the current response. All body data must have been read from the current response before calling redirect. -
reduce(
T combine(T previous, T element)) → Future<List<int>> -
inheritedReduces a sequence of values by repeatedly applying
combine
. -
singleWhere(
bool test(T element)) → Future<List<int>> -
inheritedFinds the single element in this stream matching
test
. -
skip(
int count) → Stream<List<int>> -
inheritedSkips the first
count
data events from this stream. -
skipWhile(
bool test(T element)) → Stream<List<int>> -
inheritedSkip data events from this stream while they are matched by
test
. -
take(
int count) → Stream<List<int>> -
inheritedProvides at most the first
n
values of this stream. -
takeWhile(
bool test(T element)) → Stream<List<int>> -
inheritedForwards data events while
test
is successful. -
timeout(
Duration timeLimit, {void onTimeout(EventSink sink)}) → Stream -
inheritedCreates a new stream with the same events as this stream.
-
toList(
) → Future<List<List<int>>> -
inheritedCollects the data of this stream in a List.
-
toSet(
) → Future<Set<List<int>>> -
inheritedCollects the data of this stream in a Set.
-
transform(
StreamTransformer<List<int>> streamTransformer) → Stream -
inheritedChains this stream as the input of the provided StreamTransformer.
-
where(
bool test(T event)) → Stream<List<int>> -
inheritedCreates a new stream from this stream that discards some data events.