Skip to content

Channel: add resetConnectBackoff method #132

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
pantia wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Channel: add resetConnectBackoff method #132

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion kmp-grpc-core/src/androidJvmCommon/kotlin/io/github/timortel/kmpgrpc/core/Channel.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,6 @@ actual class Channel private constructor(val channel: ManagedChannel) {

actual suspend fun shutdown() {
channel.shutdown()

awaitTermination()
}

Expand All @@ -129,4 +128,8 @@ actual class Channel private constructor(val channel: ManagedChannel) {
}
}
}

actual fun resetConnectBackoff() {
channel.resetConnectBackoff()
}
}
10 changes: 10 additions & 0 deletions kmp-grpc-core/src/commonMain/kotlin/io/github/timortel/kmpgrpc/core/Channel.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,7 @@ expect class Channel {
*/
fun withClientIdentity(certificate: Certificate, key: PrivateKey): Builder


/**
* Construct the channel
*
Expand All @@ -93,6 +94,15 @@ expect class Channel {
*/
suspend fun shutdown()


/**
* For subchannels that are in TRANSIENT_FAILURE state, short-circuit the backoff timer and make them reconnect immediately
*
* This is primarily intended for Android users, where the network may experience frequent temporary drops. Rather than waiting for gRPC's name resolution and reconnect timers to elapse before reconnecting, the app may use this method as a mechanism to notify gRPC that the network is now available and a reconnection attempt may occur immediately.
*
* No-op if not supported by the implementation.
*/
fun resetConnectBackoff()
/**
* Initiates a forceful shutdown of the gRPC channel. After invoking this method, no new calls
* can be started, and ongoing calls are immediately canceled.
Expand Down
2 changes: 2 additions & 0 deletions kmp-grpc-core/src/jsTargetCommon/kotlin/io/github/timortel/kmpgrpc/core/Channel.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,4 +66,6 @@ actual class Channel private constructor(
override fun cleanupResources() {
client.close()
}

actual fun resetConnectBackoff() {}
}
2 changes: 2 additions & 0 deletions kmp-grpc-core/src/nativeMain/kotlin/io/github/timortel/kmpgrpc/core/Channel.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -179,6 +179,8 @@ actual class Channel private constructor(
init(ENABLE_TRACE_LOGGING)
}
}

actual fun resetConnectBackoff() {}

@TimOrtel TimOrtel Mar 15, 2026

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think the function should also work in the native implementation and reset the backoff timer. Is there a reason you did not include it in the implementation?

@pantia pantia Mar 15, 2026

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was thinking the same thing but I don't have experience with Rust and it's more complicated to implement there. I'll still be testing but for some reason tonic works differently and so far I haven't seen any issues with reconnection on iOS

}

private fun installCertificates(
Expand Down