Network

Protocol for sending network requests and handling responses.

The configuration that is used by the NetworkClient to customize it’s behavior.

You almost never need to change this as most of the Networking should happen via the shared NetworkingClient instance. If you need to add new interceptors you can do that directly on the NetworkClient.

In case you really want to create a new client, start off from the NetworkConfiguration.defaultand edit it. Make sure to use a URLSessionConfiguration without cache and make sure to have at least the default interceptors.

An error reported by the NetworkClient.

A helper class that provides convenient methods for common network operations.

Protocol defining methods for common network operations.

A successful response returned by the NetworkClient

A successful Result with a NetworkResponse or a failed Result with NetworkError, returned by the NetworkClient

A manager that handles system connectivity monitor and empirical connectivity monitor to establish when connectivity is actually available or not on the device.

The default behavior would be to always assume that connectivity is available until system monitor or empirical connectivity result unavailable or unknown.

Protocol for managing network connectivity state and monitoring.

An HTTP client that sends URLRequests via a URLSession.

URLRequests are sent as is and are retried according to the RequestInterceptors logic when necessary. RequestInterceptors are also notified of other events concerning the request lifecycle. Some of these events are related to the HTTPClient logic and some are just URLSessionDelegate events being forwarded.

You should almost never create a new instance of this class but rather use the shared instance, as it’s configured with sensible defaults and using one URLSession comes with a series of optimizations. If you need to create a new instance make sure to start from a default configuration and only add new interceptors to the default ones.

An interceptor that retries all retriable errors

A class that handles some messages from the URLSession. It forwards them to the interceptors along with some other internal network client messages.

Protocol for managing request interceptors and handling network results.

Protocol for intercepting and handling network requests and responses.

Parameters for configuring a resource refresher.

An object that refreshes a single resource at regular intervals.

Refresh is requested by the user of ths class, but it’s ignored unless the required intervals have passed. The resource is cached locally and it’s re-read only on initialization or when subscribing onResourceLoaded.

You can listen to resource updates by using the onResourceLoaded observable. This will first push an event with a resource read from disk, if present, and then all refreshes from remote.

A storage to persist a resource and it’s etag, when available.

Resource is stored in the DataStore at the provided fileName, while the etag will be stored at \(fileName)_etag

The policy, returned by a RequestInterceptor that the NetworkClient should apply on a given NetworkResponse.

A protocol used to receive requests with String/URL/URLComponents intercheangebly

An object that increases a cooldown for every error event, and resets the cooldown to 0 when a non-error event happens.

A response containing a decoded object and the HTTP response.

A result type for object responses.