Skip to content

src: refactor TimerWrap class #34252

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

Closed
addaleax wants to merge 2 commits into from
Closed

src: refactor TimerWrap class #34252

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a4cfde0
src: remove user_data from TimerWrap
addaleax Jul 7, 2020
76c6697
src: refactor TimerWrap lifetime management
addaleax Jul 8, 2020
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
Prev Previous commit
src: refactor TimerWrap lifetime management 
Split `Stop(true)` and `Stop(false)` into separate methods since the
actions performed by these are fully distinct.
  • Loading branch information
@addaleax
addaleax committed Jul 8, 2020
commit 76c6697e66ca439c246d5a06486055f0c99e8176
4 changes: 2 additions & 2 deletions src/quic/node_quic_session-inl.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -511,11 +511,11 @@ void QuicSession::set_remote_transport_params() {
}

void QuicSession::StopIdleTimer() {
idle_.Stop();
idle_.Close();
}

void QuicSession::StopRetransmitTimer() {
retransmit_.Stop();
retransmit_.Close();
}

// Called by the OnVersionNegotiation callback when a version
Expand Down
30 changes: 16 additions & 14 deletions src/timer_wrap.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,14 @@ TimerWrap::TimerWrap(Environment* env, const TimerCb& fn)
timer_.data = this;
}

void TimerWrap::Stop(bool close) {
void TimerWrap::Stop() {
if (timer_.data == nullptr) return;
uv_timer_stop(&timer_);
if (LIKELY(close)) {
timer_.data = nullptr;
env_->CloseHandle(reinterpret_cast<uv_handle_t*>(&timer_), TimerClosedCb);
}
}

void TimerWrap::Close() {
timer_.data = nullptr;
env_->CloseHandle(reinterpret_cast<uv_handle_t*>(&timer_), TimerClosedCb);
}

void TimerWrap::TimerClosedCb(uv_handle_t* handle) {
Expand Down Expand Up @@ -54,13 +55,14 @@ TimerWrapHandle::TimerWrapHandle(
env->AddCleanupHook(CleanupHook, this);
}

void TimerWrapHandle::Stop(bool close) {
if (UNLIKELY(!close))
return timer_->Stop(close);
void TimerWrapHandle::Stop() {
return timer_->Stop();
}

void TimerWrapHandle::Close() {
if (timer_ != nullptr) {
timer_->env()->RemoveCleanupHook(CleanupHook, this);
timer_->Stop();
timer_->Close();
}
timer_ = nullptr;
}
Expand All @@ -80,13 +82,13 @@ void TimerWrapHandle::Update(uint64_t interval, uint64_t repeat) {
timer_->Update(interval, repeat);
}

void TimerWrapHandle::CleanupHook(void* data) {
static_cast<TimerWrapHandle*>(data)->Stop();
}

void TimerWrapHandle::MemoryInfo(node::MemoryTracker* tracker) const {
void TimerWrapHandle::MemoryInfo(MemoryTracker* tracker) const {
if (timer_ != nullptr)
tracker->TrackField("timer", *timer_);
}

void TimerWrapHandle::CleanupHook(void* data) {
static_cast<TimerWrapHandle*>(data)->Close();
}

} // namespace node
14 changes: 8 additions & 6 deletions src/timer_wrap.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,14 +21,15 @@ class TimerWrap final : public MemoryRetainer {

inline Environment* env() const { return env_; }

// Completely stops the timer, making it no longer usable.
void Stop(bool close = true);
// Stop calling the timer callback.
void Stop();
// Render the timer unusable and delete this object.
void Close();

// Starts / Restarts the Timer
void Update(uint64_t interval, uint64_t repeat = 0);

void Ref();

void Unref();

SET_NO_MEMORY_INFO();
Expand All @@ -55,15 +56,15 @@ class TimerWrapHandle : public MemoryRetainer {

TimerWrapHandle(const TimerWrapHandle&) = delete;

~TimerWrapHandle() { Stop(); }
~TimerWrapHandle() { Close(); }

void Update(uint64_t interval, uint64_t repeat = 0);

void Ref();

void Unref();

void Stop(bool close = true);
void Stop();
void Close();

void MemoryInfo(node::MemoryTracker* tracker) const override;

Expand All @@ -72,6 +73,7 @@ class TimerWrapHandle : public MemoryRetainer {

private:
static void CleanupHook(void* data);

TimerWrap* timer_;
};

Expand Down