eSCLKt/io.github.chrisimx.esclkt/ESCLRequestClient

ESCLRequestClient

class ESCLRequestClient(val baseUrl: Url, val usedHttpClient: HttpClient = HttpClient { install(HttpTimeout) { requestTimeoutMillis = 100_000 connectTimeoutMillis = 100_000 socketTimeoutMillis = 100_000 } })

A client for the eSCL scanning protocol

Parameters

baseUrl

The base url to make requests to. Has to be a URL which is derived with "http URL to printer" + "rs" txt record acquired from mDNS

usedHttpClient

eSCL is an HTTP-based protocol. This OkHttpClient will be used to execute requests

Constructors

ESCLRequestClient

constructor(baseUrl: Url, usedHttpClient: HttpClient = HttpClient { install(HttpTimeout) { requestTimeoutMillis = 100_000 connectTimeoutMillis = 100_000 socketTimeoutMillis = 100_000 } })

Types

RetrieveScanImageInfoResult

sealed class RetrieveScanImageInfoResult

data class ScannedPage(val contentType: String, val contentLocation: String? = null, val data: ByteArray, val supportRangeHeader: Boolean)

ScannerCapabilitiesResult

sealed class ScannerCapabilitiesResult

ScannerCreateJobResult

sealed class ScannerCreateJobResult

ScannerDeleteJobResult

sealed class ScannerDeleteJobResult

ScannerNextPageResult

sealed class ScannerNextPageResult

ScannerStatusResult

sealed class ScannerStatusResult

Properties

val baseUrl: Url

val esclXml: ESCLXml

val usedHttpClient: HttpClient

Functions

suspend fun createJob(scanSettings: ScanSettings): ESCLRequestClient.ScannerCreateJobResult

Posts a job to the scanner

suspend fun deleteJob(jobUri: String): ESCLRequestClient.ScannerDeleteJobResult

Cancels a job on the scanner

getScannerCapabilities

suspend fun getScannerCapabilities(): ESCLRequestClient.ScannerCapabilitiesResult

Executes a ScannerCapabilities request to receive the characteristics of the scanner.

getScannerStatus

suspend fun getScannerStatus(): ESCLRequestClient.ScannerStatusResult

Executes a ScannerStatus request to receive the current status of the scanner.

retrieveNextPageForJob

suspend fun retrieveNextPageForJob(jobUri: String): ESCLRequestClient.ScannerNextPageResult

Retrieves the next page for a job on the scanner

retrieveScanImageInfoForJob

suspend fun retrieveScanImageInfoForJob(jobUri: String): ESCLRequestClient.RetrieveScanImageInfoResult

Retrieves the scan image info for the last page retrieved for a job on the scanner