connectivity-core/dev.jordond.connectivity

Package-level declarations

Types

interface Connectivity

The Connectivity interface provides a way to monitor the network connectivity status.

ConnectivityOptions

open class ConnectivityOptions(val autoStart: Boolean = DEFAULT_AUTO_START)

The ConnectivityOptions class provides configuration options for the Connectivity instance.

ConnectivityProvider

interface ConnectivityProvider

The ConnectivityProvider interface provides a way to monitor the network connectivity status.

InternalConnectivityApi

@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.PROPERTY, AnnotationTarget.FUNCTION, AnnotationTarget.TYPEALIAS])

annotation class InternalConnectivityApi

Marks the annotated element as internal to the connectivity module.

Functions

fun Flow<Connectivity.Status>.asProvider(): ConnectivityProvider

Converts a Flow of Connectivity.Status to a ConnectivityProvider.

fun Connectivity(provider: ConnectivityProvider, options: ConnectivityOptions = ConnectivityOptions(), scope: CoroutineScope = CoroutineScope(Dispatchers.Default)): Connectivity

Creates a Connectivity instance.

fun Connectivity(provider: ConnectivityProvider, scope: CoroutineScope = CoroutineScope(Dispatchers.Default), options: ConnectivityOptions.Builder.() -> Unit): Connectivity

Creates a Connectivity instance with a builder for the ConnectivityOptions.

ConnectivityProvider

fun ConnectivityProvider(flow: Flow<Connectivity.Status>): ConnectivityProvider

Creates a ConnectivityProvider instance.