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

Improve address naming in aether/lock #3

Open
ecpeterson opened this issue Nov 12, 2020 · 0 comments
Open

Improve address naming in aether/lock #3

ecpeterson opened this issue Nov 12, 2020 · 0 comments

Comments

@ecpeterson
Copy link
Contributor

@karalekas is not thrilled with the [upward|downward]-[rx|tx]-latch(es)? names used in aether/lock. Consider improving these.

Here's a longer-form comment he left elsewhere:

I find this upward/downward rx/tx language kinda confusing -- definitely took me a while to grok. Once I drew a picture I understood why you chose that language, but I think there might be a better choice. I haven't zeroed in on something that I love, but it's clear to me that the downward-tx and upward-rx channels are really about the unlocking part. Here is my explanation of what each does:

downward-rx: the channels that a lock requester listens on for updates from its lock targets
downward-tx: the channels that a lock requester should send unlocks to when we're done with the critical section
upward-rx: the channel that a lock target listens on for an unlock notification
upward-tx: the channel for a lock target to send updates to its lock requester

There's nothing explicitly wrong about the current naming convention (obviously), but maybe requester/target is clearer than upward/downward. We also dont really use RX/TX that much in the application source -- we often use more verbose descriptions like "reply" or "listen". Finally, the word latch is fun and colorful but maybe it would just be better to be super plain, unless we invest in more documentation and visualization to accompany the language.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant