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

Constructors

HttpClientResponse()

Properties

certificate → X509Certificate

Returns the certificate of the HTTPS server providing the response. Returns null if the connection is not a secure TLS or SSL connection.

read-only
connectionInfo → HttpConnectionInfo

Gets information about the client connection. Returns null if the socket is not available.

read-only
contentLength → int

Returns the content length of the response body. Returns -1 if the size of the response body is not known in advance.

read-only
cookies → List<Cookie>

Cookies set by the server (from the 'set-cookie' header).

read-only
first → Future<List<int>>

Returns the first element of the stream.

read-only, inherited
hashCode → int

Get a hash code for this object.

read-only, inherited
headers → HttpHeaders

Returns the client response headers.

read-only
isBroadcast → bool

Reports whether this stream is a broadcast stream.

read-only, inherited
isEmpty → Future<bool>

Reports whether this stream contains any elements.

read-only, inherited
isRedirect → bool

Returns whether the status code is one of the normal redirect codes HttpStatus.MOVED_PERMANENTLY, HttpStatus.FOUND, HttpStatus.MOVED_TEMPORARILY, HttpStatus.SEE_OTHER and HttpStatus.TEMPORARY_REDIRECT.

read-only
last → Future<List<int>>

Returns the last element of the stream.

read-only, inherited
length → Future<int>

Counts the elements in the stream.

read-only, inherited
persistentConnection → bool

Gets the persistent connection state returned by the server.

read-only
reasonPhrase → String

Returns the reason phrase associated with the status code.

read-only
redirects → List<RedirectInfo>

Returns 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.

read-only
runtimeType → Type

A representation of the runtime type of the object.

read-only, inherited
single → Future<List<int>>

Returns the single element.

read-only, inherited
statusCode → int

Returns the status code.

read-only

Operators

operator ==(other) → bool

The equality operator.

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(Stream convert(T event)) → Stream

Creates a new stream with the events of a stream per original event.

inherited
asyncMap(dynamic convert(T event)) → Stream

Creates a new stream with each data event of this stream asynchronously mapped to a new event.

inherited
contains(Object needle) → Future<bool>

Checks whether needle occurs in the elements provided by this stream.

inherited
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>>

Skips data events if they are equal to the previous data event.

inherited
drain([futureValue ]) → Future

Discards all data on the stream, but signals when it's done or an error occured.

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(Iterable convert(T value)) → Stream

Creates a new stream from this stream that converts each element into zero or more events.

inherited
firstWhere(bool test(T element), { Object defaultValue() }) → Future

Finds the first element of this stream matching test.

inherited
fold(initialValue, dynamic combine(previous, T element)) → Future

Reduces a sequence of values by repeatedly applying combine.

inherited
forEach(void action(T element)) → Future

Executes action on each data event of the stream.

inherited
handleError(Function onError, { bool test(error) }) → Stream<List<int>>

Creates a wrapper Stream that intercepts some errors from this stream.

inherited
join([String separator = "" ]) → Future<String>

Collects string of data events' string representations.

inherited
lastWhere(bool test(T element), { Object defaultValue() }) → Future

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(dynamic convert(T event)) → Stream

Creates a new stream that converts each element of this stream to a new value using the convert function.

inherited
noSuchMethod(Invocation invocation) → dynamic

Invoked when a non-existent method or property is accessed.

inherited
pipe(StreamConsumer<List<int>> streamConsumer) → Future

Pipe the events of this stream into streamConsumer.

inherited
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 for url 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(List<int> combine(T previous, T element)) → Future<List<int>>

Reduces a sequence of values by repeatedly applying combine.

inherited
singleWhere(bool test(T element)) → 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 n values 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 the data 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(StreamTransformer<List<int>, dynamic> streamTransformer) → Stream

Chains this stream as the input of the provided StreamTransformer.

inherited
where(bool test(T event)) → Stream<List<int>>

Creates a new stream from this stream that discards some data events.

inherited