Skip to content
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.

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

Clarify ingress expiry semantics #5080

Open
wants to merge 5 commits into
base: master
Choose a base branch
from

Conversation

yvonneanne
Copy link
Contributor

@yvonneanne yvonneanne commented Feb 11, 2025

A request's ingress_expiry keeps raising questions.
This PR adds clarifications to the different semantics for call and read_state.

@github-actions github-actions bot added the interface-spec Changes to the IC Interface Specification label Feb 11, 2025
Copy link

github-actions bot commented Feb 11, 2025

🤖 Here's your preview: https://hhcgk-raaaa-aaaam-abahq-cai.icp0.io

@yvonneanne yvonneanne marked this pull request as ready for review February 12, 2025 10:29
@yvonneanne yvonneanne requested a review from a team as a code owner February 12, 2025 10:29

The synchronous call endpoint is useful for users as it removes the networking overhead of polling the IC to determine the status of their call.
The synchronous call endpoint is useful for users as it removes the networking overhead of polling the IC to determine the status of their call if a terminal state is reached quickly.
Copy link
Contributor

Choose a reason for hiding this comment

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

I'm not sure how to best improve it but "reached quickly" is vague, right?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I agree, but imo it is simply incorrect without it...

An alternative could be the following, wdyt?

Suggested change
The synchronous call endpoint is useful for users as it removes the networking overhead of polling the IC to determine the status of their call if a terminal state is reached quickly.
The synchronous call endpoint is useful for users as it reduces the networking overhead of polling the IC to determine the status of their call.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
interface-spec Changes to the IC Interface Specification
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants