From 3b5cedebd1155ae5bbe272d12e89de592184a0cf Mon Sep 17 00:00:00 2001 From: Daniel Bevenius Date: Mon, 20 Jun 2016 21:36:32 +0200 Subject: [PATCH] src: renaming ares_task struct to node_ares_task This commit attempts to fix one of the items in https://github.com/nodejs/node/issues/4641, which was to remove a TODO comment from env.h regarding the naming of the ares_task_t struct. Also, the struct ares_task_list was renamed to node_ares_task_list following the same reasoning that is does not belong to the c-ares API. PR-URL: https://github.com/nodejs/node/pull/7345 Reviewed-By: Brian White Reviewed-By: Colin Ihrig Reviewed-By: Anna Henningsen Reviewed-By: James M Snell Reviewed-By: Ben Noordhuis --- src/cares_wrap.cc | 24 ++++++++++++------------ src/env-inl.h | 2 +- src/env.h | 12 +++++------- 3 files changed, 18 insertions(+), 20 deletions(-) diff --git a/src/cares_wrap.cc b/src/cares_wrap.cc index a7b9132a71e6aa..88ebb9230c7187 100644 --- a/src/cares_wrap.cc +++ b/src/cares_wrap.cc @@ -123,7 +123,7 @@ static void NewQueryReqWrap(const FunctionCallbackInfo& args) { } -static int cmp_ares_tasks(const ares_task_t* a, const ares_task_t* b) { +static int cmp_ares_tasks(const node_ares_task* a, const node_ares_task* b) { if (a->sock < b->sock) return -1; if (a->sock > b->sock) @@ -132,7 +132,7 @@ static int cmp_ares_tasks(const ares_task_t* a, const ares_task_t* b) { } -RB_GENERATE_STATIC(ares_task_list, ares_task_t, node, cmp_ares_tasks) +RB_GENERATE_STATIC(node_ares_task_list, node_ares_task, node, cmp_ares_tasks) @@ -146,7 +146,7 @@ static void ares_timeout(uv_timer_t* handle) { static void ares_poll_cb(uv_poll_t* watcher, int status, int events) { - ares_task_t* task = ContainerOf(&ares_task_t::poll_watcher, watcher); + node_ares_task* task = ContainerOf(&node_ares_task::poll_watcher, watcher); Environment* env = task->env; /* Reset the idle timer */ @@ -167,15 +167,15 @@ static void ares_poll_cb(uv_poll_t* watcher, int status, int events) { static void ares_poll_close_cb(uv_handle_t* watcher) { - ares_task_t* task = ContainerOf(&ares_task_t::poll_watcher, + node_ares_task* task = ContainerOf(&node_ares_task::poll_watcher, reinterpret_cast(watcher)); free(task); } -/* Allocates and returns a new ares_task_t */ -static ares_task_t* ares_task_create(Environment* env, ares_socket_t sock) { - ares_task_t* task = static_cast(malloc(sizeof(*task))); +/* Allocates and returns a new node_ares_task */ +static node_ares_task* ares_task_create(Environment* env, ares_socket_t sock) { + node_ares_task* task = static_cast(malloc(sizeof(*task))); if (task == nullptr) { /* Out of memory. */ @@ -201,11 +201,11 @@ static void ares_sockstate_cb(void* data, int read, int write) { Environment* env = static_cast(data); - ares_task_t* task; + node_ares_task* task; - ares_task_t lookup_task; + node_ares_task lookup_task; lookup_task.sock = sock; - task = RB_FIND(ares_task_list, env->cares_task_list(), &lookup_task); + task = RB_FIND(node_ares_task_list, env->cares_task_list(), &lookup_task); if (read || write) { if (!task) { @@ -226,7 +226,7 @@ static void ares_sockstate_cb(void* data, return; } - RB_INSERT(ares_task_list, env->cares_task_list(), task); + RB_INSERT(node_ares_task_list, env->cares_task_list(), task); } /* This should never fail. If it fails anyway, the query will eventually */ @@ -242,7 +242,7 @@ static void ares_sockstate_cb(void* data, CHECK(task && "When an ares socket is closed we should have a handle for it"); - RB_REMOVE(ares_task_list, env->cares_task_list(), task); + RB_REMOVE(node_ares_task_list, env->cares_task_list(), task); uv_close(reinterpret_cast(&task->poll_watcher), ares_poll_close_cb); diff --git a/src/env-inl.h b/src/env-inl.h index 6f19ff50cb536f..0a4ce55b3bc4ae 100644 --- a/src/env-inl.h +++ b/src/env-inl.h @@ -398,7 +398,7 @@ inline ares_channel* Environment::cares_channel_ptr() { return &cares_channel_; } -inline ares_task_list* Environment::cares_task_list() { +inline node_ares_task_list* Environment::cares_task_list() { return &cares_task_list_; } diff --git a/src/env.h b/src/env.h index 7b6ffc8b87c8ee..67d10b20e41673 100644 --- a/src/env.h +++ b/src/env.h @@ -259,16 +259,14 @@ namespace node { class Environment; -// TODO(bnoordhuis) Rename struct, the ares_ prefix implies it's part -// of the c-ares API while the _t suffix implies it's a typedef. -struct ares_task_t { +struct node_ares_task { Environment* env; ares_socket_t sock; uv_poll_t poll_watcher; - RB_ENTRY(ares_task_t) node; + RB_ENTRY(node_ares_task) node; }; -RB_HEAD(ares_task_list, ares_task_t); +RB_HEAD(node_ares_task_list, node_ares_task); class Environment { public: @@ -440,7 +438,7 @@ class Environment { inline uv_timer_t* cares_timer_handle(); inline ares_channel cares_channel(); inline ares_channel* cares_channel_ptr(); - inline ares_task_list* cares_task_list(); + inline node_ares_task_list* cares_task_list(); inline bool using_domains() const; inline void set_using_domains(bool value); @@ -542,7 +540,7 @@ class Environment { const uint64_t timer_base_; uv_timer_t cares_timer_handle_; ares_channel cares_channel_; - ares_task_list cares_task_list_; + node_ares_task_list cares_task_list_; bool using_domains_; bool printed_error_; bool trace_sync_io_;