IOClient class

A dart:io-based HTTP Client.

If there is a socket-level failure when communicating with the server (for example, if the server could not be reached), IOClient will emit a ClientException that also implements SocketException. This allows callers to get more detailed exception information for socket-level failures, if desired.

For example:

final client = http.Client();
late String data;
try {
  data = await client.read(Uri.https('example.com', ''));
} on SocketException catch (e) {
  // Exception is transport-related, check `e.osError` for more details.
} on http.ClientException catch (e) {
  // Exception is HTTP-related (e.g. the server returned a 404 status code).
  // If the handler for `SocketException` were removed then all exceptions
  // would be caught by this handler.
}
Inheritance

Constructors

IOClient([HttpClient? inner])
Create a new dart:io-based HTTP Client.

Properties

hashCode → int
The hash code for this object.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

close() → void
Closes the client.
override
delete(Uri url, {Map<String, String>? headers, Object? body, Encoding? encoding}) → Future<Response>
Sends an HTTP DELETE request with the given headers to the given URL.
inherited
get(Uri url, {Map<String, String>? headers}) → Future<Response>
Sends an HTTP GET request with the given headers to the given URL.
inherited
Sends an HTTP HEAD request with the given headers to the given URL.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
patch(Uri url, {Map<String, String>? headers, Object? body, Encoding? encoding}) → Future<Response>
Sends an HTTP PATCH request with the given headers and body to the given URL.
inherited
post(Uri url, {Map<String, String>? headers, Object? body, Encoding? encoding}) → Future<Response>
Sends an HTTP POST request with the given headers and body to the given URL.
inherited
put(Uri url, {Map<String, String>? headers, Object? body, Encoding? encoding}) → Future<Response>
Sends an HTTP PUT request with the given headers and body to the given URL.
inherited
read(Uri url, {Map<String, String>? headers}) → Future<String>
Sends an HTTP GET request with the given headers to the given URL and returns a Future that completes to the body of the response as a String.
inherited
readBytes(Uri url, {Map<String, String>? headers}) → Future<Uint8List>
Sends an HTTP GET request with the given headers to the given URL and returns a Future that completes to the body of the response as a list of bytes.
inherited
send(BaseRequest request) → Future<IOStreamedResponse>
Sends an HTTP request and asynchronously returns the response.
override
toString() → String
A string representation of this object.
inherited

Operators

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