src: add comments for cares library init refcount

Ref: #14738 PR-URL: #14743 Reviewed-By: Timothy Gu <[email protected]> Reviewed-By: Ben Noordhuis <[email protected]> Reviewed-By: Tobias Nießen <[email protected]> Reviewed-By: Khaidi Chu <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: James M Snell <[email protected]>
nodejs · Aug 12, 2017 · d7d22ea · d7d22ea
1 parent b87fae9
commit d7d22ea
Showing 1 changed file with 5 additions and 1 deletion.
diff --git a/src/cares_wrap.cc b/src/cares_wrap.cc
@@ -489,6 +489,8 @@ void ChannelWrap::Setup() {
 
   int r;
   if (!library_inited_) {
+    // Multiple calls to ares_library_init() increase a reference counter,
+    // so this is a no-op except for the first call to it.
     r = ares_library_init(ARES_LIB_INIT_ALL);
     if (r != ARES_SUCCESS)
       return env()->ThrowError(ToErrorCodeString(r));
@@ -516,8 +518,10 @@ void ChannelWrap::Setup() {
 
 
 ChannelWrap::~ChannelWrap() {
-  if (library_inited_)
+  if (library_inited_) {
+    // This decreases the reference counter increased by ares_library_init().
     ares_library_cleanup();
+  }
 
   ares_destroy(channel_);
   CleanupTimer();