---
title: "ProgressSink"
sidebar_label: "ProgressSink"
description: "Kotlin binding reference: ProgressSink."
---

<!-- Generated by tools/api_reference/generate_api_docs.py. Do not edit. -->

//[clika-runtime](../../../index.md)/[io.clika.runtime](../index.md)/[ProgressSink](index.md)

# ProgressSink

[common]\
fun interface [ProgressSink](index.md)

A progress callback of a transfer; return false to cancel it.

## Functions

| Name | Summary |
|---|---|
| [run](run.md) | [common]<br>abstract fun [run](run.md)(done: [Long](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-long/index.html), total: [Long](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-long/index.html)): [Boolean](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html)<br>[done](run.md) bytes so far of [total](run.md), which is 0 when the server reports no length. |