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

Rename inappropriate member functions in ReliableMessageManager #4322

Merged
merged 1 commit into from
Jan 12, 2021
Merged

Rename inappropriate member functions in ReliableMessageManager #4322

merged 1 commit into from
Jan 12, 2021

Conversation

yufengwangca
Copy link
Contributor

Problem

This is the follow-up of the review comments in #4048

Summary of Changes

  1. Rename PauseRetransTable to PauseRetransmision since it is operating on entry instead of table
  2. Rename ResumeRetransTable to ResumeRetransmision since it is operating on entry instead of table
  3. Rename ClearRetransmitTable/ClearRetransmitTable/FailRetransmitTableEntries to ClearRetransTable/ClearRetransTable/FailRetransTableEntries to align the naming convention used in CRMP

Fixes #4206

@kghost kghost self-requested a review January 12, 2021 04:26
void ClearRetransmitTable(ReliableMessageContext * rc);
void ClearRetransmitTable(RetransTableEntry & rEntry);
void FailRetransmitTableEntries(ReliableMessageContext * rc, CHIP_ERROR err);
void ClearRetransTable(ReliableMessageContext * rc);
Copy link
Contributor

Choose a reason for hiding this comment

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

Would there be any value to use full Retransmit/Retransmission instead of 'Retrans' here and on the data member name?

I also wonder if the name 'RetransTable' is an internal implementation detail and if the public API should should maybe not use 'Table' at all. Like

Some comments may also help: reading CheckAndRemRetransTable ... what does it check? Why Rem instead of Remove (assume rem stands for remove).

Likely for future PRs though. LGTM for this particular PR as being an improvement over the previous code.

@rwalker-apple
Copy link
Contributor

@rwalker-apple
Copy link
Contributor

@yufengwangca conflicts?

@rwalker-apple rwalker-apple merged commit 6c94941 into project-chip:master Jan 12, 2021
@yufengwangca yufengwangca deleted the pr/crmp/functions branch January 13, 2021 00:19
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

Successfully merging this pull request may close these issues.

Comeup with better name for some functions in ReliableMessageManager
6 participants