Some spelling corrections (#335)

Author: hks2002

trantor/net/TLSPolicy.h

@@ -67,7 +67,7 @@ struct TRANTOR_EXPORT TLSPolicy final
 
     /**
      * @brief enables the use of the old TLS protocol (old meaning < TLS 1.2).
-     * TLS providres may not support old protocols even if this option is set
+     * TLS providers may not support old protocols even if this option is set
      */
     TLSPolicy &setUseOldTLS(bool useOldTLS)
     {
@@ -79,7 +79,7 @@ struct TRANTOR_EXPORT TLSPolicy final
      * @brief set the list of protocols to be used for ALPN.
      *
      * @note for servers, it selects matching protocol against the client's
-     * list. And the first matching protocol supplide in the parameter will be
+     * list. And the first matching protocol supplied in the parameter will be
      * selected. If no matching protocol is found, the connection will be
      * closed.
      *

trantor/unittests/DateUnittest.cc

@@ -7,20 +7,20 @@ TEST(Date, constructorTest)
 {
     EXPECT_STREQ("1985-01-01 00:00:00",
                  trantor::Date(1985, 1, 1)
-                     .toCustomedFormattedStringLocal("%Y-%m-%d %H:%M:%S")
+                     .toCustomFormattedStringLocal("%Y-%m-%d %H:%M:%S")
                      .c_str());
     EXPECT_STREQ("2004-02-29 00:00:00.000000",
                  trantor::Date(2004, 2, 29)
-                     .toCustomedFormattedStringLocal("%Y-%m-%d %H:%M:%S", true)
+                     .toCustomFormattedStringLocal("%Y-%m-%d %H:%M:%S", true)
                      .c_str());
     EXPECT_STRNE("2001-02-29 00:00:00.000000",
                  trantor::Date(2001, 2, 29)
-                     .toCustomedFormattedStringLocal("%Y-%m-%d %H:%M:%S", true)
+                     .toCustomFormattedStringLocal("%Y-%m-%d %H:%M:%S", true)
                      .c_str());
     EXPECT_STREQ("2018-01-01 00:00:00.000000",
                  trantor::Date(2018, 1, 1, 12, 12, 12, 2321)
                      .roundDay()
-                     .toCustomedFormattedStringLocal("%Y-%m-%d %H:%M:%S", true)
+                     .toCustomFormattedStringLocal("%Y-%m-%d %H:%M:%S", true)
                      .c_str());
 }
 TEST(Date, DatabaseStringTest)

trantor/utils/AsyncFileLogger.cc

@@ -269,7 +269,7 @@ void AsyncFileLogger::LoggerFile::switchLog(bool openNewOne)
         // NOTE: Remember to update initFilenameQueue() if name format changes
         std::string newName =
             filePath_ + fileBaseName_ + "." +
-            creationDate_.toCustomedFormattedString("%y%m%d-%H%M%S") +
+            creationDate_.toCustomFormattedString("%y%m%d-%H%M%S") +
             std::string(seq) + fileExtName_;
 #if !defined(_WIN32) || defined(__MINGW32__)
         rename(fileFullName_.c_str(), newName.c_str());

trantor/utils/Date.cc

@@ -142,8 +142,8 @@ std::string Date::toFormattedString(bool showMicroseconds) const
     }
     return buf;
 }
-std::string Date::toCustomedFormattedString(const std::string &fmtStr,
-                                            bool showMicroseconds) const
+std::string Date::toCustomFormattedString(const std::string &fmtStr,
+                                          bool showMicroseconds) const
 {
     char buf[256] = {0};
     time_t seconds =
@@ -163,9 +163,9 @@ std::string Date::toCustomedFormattedString(const std::string &fmtStr,
     snprintf(decimals, sizeof(decimals), ".%06d", microseconds);
     return std::string(buf) + decimals;
 }
-void Date::toCustomedFormattedString(const std::string &fmtStr,
-                                     char *str,
-                                     size_t len) const
+void Date::toCustomFormattedString(const std::string &fmtStr,
+                                   char *str,
+                                   size_t len) const
 {
     // not safe
     time_t seconds =
@@ -323,8 +323,8 @@ Date Date::fromDbString(const std::string &datetime)
         static_cast<double>(timezoneOffset()));
 }
 
-std::string Date::toCustomedFormattedStringLocal(const std::string &fmtStr,
-                                                 bool showMicroseconds) const
+std::string Date::toCustomFormattedStringLocal(const std::string &fmtStr,
+                                               bool showMicroseconds) const
 {
     char buf[256] = {0};
     time_t seconds =

trantor/utils/Date.h

@@ -202,36 +202,70 @@ class TRANTOR_EXPORT Date
      */
     std::string toFormattedString(bool showMicroseconds) const;
 
+    /* clang-format off */
     /**
-     * @brief Generate a UTC time string formated by the @p fmtStr
+     * @brief Generate a UTC time string formatted by the @p fmtStr
      * @param fmtStr is the format string for the function strftime()
      * @param showMicroseconds whether the microseconds are returned.
      * @note Examples:
      *  - "2018-01-01 10:10:25" if the @p fmtStr is "%Y-%m-%d %H:%M:%S" and the
      *    @p showMicroseconds is false
      *  - "2018-01-01 10:10:25:102414" if the @p fmtStr is "%Y-%m-%d %H:%M:%S"
      *    and the @p showMicroseconds is true
+     * @deprecated Replaced by toCustomFormattedString
      */
+    [[deprecated("Replaced by toCustomFormattedString")]] 
     std::string toCustomedFormattedString(const std::string &fmtStr,
-                                          bool showMicroseconds = false) const;
-
+                                          bool showMicroseconds = false) const
+    {
+        return toCustomFormattedString(fmtStr, showMicroseconds);
+    };
+    /* clang-format on */
+    /**
+     * @brief Generate a UTC time string formatted by the @p fmtStr
+     * @param fmtStr is the format string for the function strftime()
+     * @param showMicroseconds whether the microseconds are returned.
+     * @note Examples:
+     *  - "2018-01-01 10:10:25" if the @p fmtStr is "%Y-%m-%d %H:%M:%S" and the
+     *    @p showMicroseconds is false
+     *  - "2018-01-01 10:10:25:102414" if the @p fmtStr is "%Y-%m-%d %H:%M:%S"
+     *    and the @p showMicroseconds is true
+     */
+    std::string toCustomFormattedString(const std::string &fmtStr,
+                                        bool showMicroseconds = false) const;
     /**
      * @brief Generate a local time zone string, the format of the string is
-     * same as the mothed toFormattedString
+     * same as the method toFormattedString
      *
      * @param showMicroseconds
      * @return std::string
      */
     std::string toFormattedStringLocal(bool showMicroseconds) const;
 
+    /* clang-format off */
     /**
-     * @brief Generate a local time zone string formated by the @p fmtStr
+     * @brief Generate a local time zone string formatted by the @p fmtStr
      *
      * @param fmtStr
      * @param showMicroseconds
      * @return std::string
+     * @deprecated Replaced by toCustomFormattedString
      */
-    std::string toCustomedFormattedStringLocal(
+    [[deprecated("Replaced by toCustomFormattedStringLocal")]]
+    std::string toCustomedFormattedStringLocal(const std::string &fmtStr,
+                                               bool showMicroseconds = false) const
+    {
+        return toCustomFormattedStringLocal(fmtStr, showMicroseconds);
+    }
+    /* clang-format on */
+    /**
+     * @brief Generate a local time zone string formatted by the @p fmtStr
+     *
+     * @param fmtStr
+     * @param showMicroseconds
+     * @return std::string
+     */
+    std::string toCustomFormattedStringLocal(
         const std::string &fmtStr,
         bool showMicroseconds = false) const;
 
@@ -261,16 +295,34 @@ class TRANTOR_EXPORT Date
      */
     static Date fromDbString(const std::string &datetime);
 
+    /* clang-format off */
     /**
      * @brief Generate a UTC time string.
      *
      * @param fmtStr The format string.
      * @param str The string buffer for the generated time string.
      * @param len The length of the string buffer.
+     * @deprecated Replaced by toCustomFormattedString
      */
+    [[deprecated("Replaced by toCustomFormattedString")]]
     void toCustomedFormattedString(const std::string &fmtStr,
                                    char *str,
-                                   size_t len) const;  // UTC
+                                   size_t len) const
+    {
+        toCustomFormattedString(fmtStr, str, len);
+    }
+    /* clang-format on */
+
+    /**
+     * @brief Generate a UTC time string.
+     *
+     * @param fmtStr The format string.
+     * @param str The string buffer for the generated time string.
+     * @param len The length of the string buffer.
+     */
+    void toCustomFormattedString(const std::string &fmtStr,
+                                 char *str,
+                                 size_t len) const;  // UTC
 
     /**
      * @brief Return true if the time point is in a same second as another.

trantor/utils/MsgBuffer.h

@@ -207,7 +207,7 @@ class TRANTOR_EXPORT MsgBuffer
     void appendInt32(const uint32_t i);
 
     /**
-     * @brief Appaend a unsigned int64 value to the end of the buffer.
+     * @brief Append a unsigned int64 value to the end of the buffer.
      *
      * @param l
      */

trantor/utils/SerialTaskQueue.cc

@@ -20,7 +20,7 @@
 namespace trantor
 {
 SerialTaskQueue::SerialTaskQueue(const std::string &name)
-    : queueName_(name.empty() ? "SerailTaskQueue" : name),
+    : queueName_(name.empty() ? "SerialTaskQueue" : name),
       loopThread_(queueName_)
 {
     loopThread_.run();

trantor/utils/SerialTaskQueue.h

@@ -58,21 +58,36 @@ class TRANTOR_EXPORT SerialTaskQueue : public TaskQueue
     SerialTaskQueue() = delete;
 
     /**
-     * @brief Construct a new serail task queue instance.
+     * @brief Construct a new serial task queue instance.
      *
      * @param name
      */
     explicit SerialTaskQueue(const std::string &name);
 
     virtual ~SerialTaskQueue();
 
+    /* clang-format off */
     /**
      * @brief Check whether a task is running in the queue.
      *
      * @return true
      * @return false
+     * @deprecated Use isRunningTask instead
      */
+    [[deprecated("Use isRunningTask instead")]]
     bool isRuningTask()
+    {
+        return isRunningTask();
+    }
+    /* clang-format on */
+
+    /**
+     * @brief Check whether a task is running in the queue.
+     *
+     * @return true
+     * @return false
+     */
+    bool isRunningTask()
     {
         return loopThread_.getLoop()
                    ? loopThread_.getLoop()->isCallingFunctions()

trantor/utils/TaskQueue.h

@@ -36,7 +36,7 @@ class TaskQueue : public NonCopyable
     };
 
     /**
-     * @brief Run a task in the queue sychronously. This means that the task is
+     * @brief Run a task in the queue synchronously. This means that the task is
      * executed before the method returns.
      *
      * @param task

trantor/utils/Utilities.h

@@ -172,7 +172,7 @@ inline std::string fromNativePath(const std::wstring &strPath)
 }
 
 /**
- * @brief Check if the name supplied by the SSL Cert matchs a FQDN
+ * @brief Check if the name supplied by the SSL Cert matches a FQDN
  * @param certName The name supplied by the SSL Cert
  * @param hostName The FQDN to match
  *
@@ -243,7 +243,7 @@ inline Hash256 sha3(const std::string &str)
 /**
  * @brief Compute the BLAKE2b hash of the given data
  * @note When in doubt, use SHA3 or BLAKE2b. Both are safe and SHA3 is faster if
- * you are using OpenSSL and it has SHA3 in hardware mode. Owtherwise BLAKE2b is
+ * you are using OpenSSL and it has SHA3 in hardware mode. Otherwise BLAKE2b is
  * faster in software.
  */
 TRANTOR_EXPORT Hash256 blake2b(const void *data, size_t len);
@@ -255,7 +255,7 @@ inline Hash256 blake2b(const std::string &str)
 /**
  * @brief hex encode the given data
  * @note When in doubt, use SHA3 or BLAKE2b. Both are safe and SHA3 is faster if
- * you are using OpenSSL and it has SHA3 in hardware mode. Owtherwise BLAKE2b is
+ * you are using OpenSSL and it has SHA3 in hardware mode. Otherwise BLAKE2b is
  * faster in software.
  */
 TRANTOR_EXPORT std::string toHexString(const void *data, size_t len);
@@ -280,7 +280,7 @@ inline std::string toHexString(const Hash256 &hash)
  * @param size Size of the buffer
  * @return true if successful, false otherwise
  *
- * @note This function really sholdn't fail, but it's possible that
+ * @note This function really shouldn't fail, but it's possible that
  *
  *   - OpenSSL can't access /dev/urandom
  *   - Compiled with glibc that supports getentropy() but the kernel doesn't