diff --git a/lib/core/include/irods/dns_cache.hpp b/lib/core/include/irods/dns_cache.hpp index a2be32067c..dcb88f447b 100644 --- a/lib/core/include/irods/dns_cache.hpp +++ b/lib/core/include/irods/dns_cache.hpp @@ -44,7 +44,9 @@ namespace irods::experimental::net::dns_cache /// \since 5.0.0 auto init_no_create(const std::string_view _shm_name) -> void; - /// TODO + /// Returns the name of the shared memory segment used by the cache. + /// + /// This function allows other components and processes to use an existing cache. /// /// \since 5.0.0 auto shared_memory_name() -> std::string_view; diff --git a/lib/core/include/irods/hostname_cache.hpp b/lib/core/include/irods/hostname_cache.hpp index 953069bdc5..82bff78075 100644 --- a/lib/core/include/irods/hostname_cache.hpp +++ b/lib/core/include/irods/hostname_cache.hpp @@ -28,7 +28,7 @@ namespace irods::experimental::net::hostname_cache /// \since 4.2.9 auto deinit() noexcept -> void; - /// Initializes the dns cache from an existing shared memory object. + /// Initializes the hostname cache from an existing shared memory object. /// /// This function should only be called on startup of the server. /// @@ -37,7 +37,9 @@ namespace irods::experimental::net::hostname_cache /// \since 5.0.0 auto init_no_create(const std::string_view _shm_name) -> void; - /// TODO + /// Returns the name of the shared memory segment used by the cache. + /// + /// This function allows other components and processes to use an existing cache. /// /// \since 5.0.0 auto shared_memory_name() -> std::string_view; diff --git a/lib/core/src/irods_server_properties.cpp b/lib/core/src/irods_server_properties.cpp index f16e4dc1ff..dbdbbd09c6 100644 --- a/lib/core/src/irods_server_properties.cpp +++ b/lib/core/src/irods_server_properties.cpp @@ -233,7 +233,7 @@ namespace irods } config_props_ = json::parse(in); - } // capture + } // init void server_properties::set_configuration(nlohmann::json _config) { diff --git a/server/main_server/src/agent_main.cpp b/server/main_server/src/agent_main.cpp index a90d34f0fa..8ce08dd102 100644 --- a/server/main_server/src/agent_main.cpp +++ b/server/main_server/src/agent_main.cpp @@ -196,7 +196,7 @@ auto main(int _argc, char* _argv[]) -> int path.copy(g_proc_directory.data(), g_proc_directory.size()); } - // Capture the gracefule shutdown timeout value for agent cleanup. + // Capture the graceful shutdown timeout value for agent cleanup. // This is required so that the signal handler for reaping agents remains async-signal-safe. { const auto config_handle{irods::server_properties::instance().map()}; @@ -363,7 +363,7 @@ auto main(int _argc, char* _argv[]) -> int } if (g_terminate_graceful) { - log_af::info("{}: Received shutdown instruction. Exiting agent factory main loop.", __func__); + log_af::info("{}: Received graceful shutdown instruction. Exiting agent factory main loop.", __func__); break; } @@ -388,7 +388,7 @@ auto main(int _argc, char* _argv[]) -> int return handle_client_request(newSock, std::time(nullptr)); } catch (const std::exception& e) { - log_agent::critical("{}: Exception caught in outer most scope of request handler: {}", __func__, e.what()); + log_agent::critical("{}: Exception caught in outermost scope of request handler: {}", __func__, e.what()); return 1; } } @@ -1176,13 +1176,12 @@ namespace irods::experimental::api::plugin_lifetime_manager::destroy(); - // determine if we even need to connect, break the - // infinite reconnect loop. + // Determine if we even need to connect, break the infinite reconnect loop. if (!resc_mgr.need_maintenance_operations()) { return status; } - // find the icat host + // Find the catalog provider host. rodsServerHost_t* rodsServerHost = 0; status = getRcatHost(PRIMARY_RCAT, 0, &rodsServerHost); if (status < 0) { @@ -1190,17 +1189,15 @@ namespace return status; } - // connect to the icat host + // Connect to the catalog provider host. status = svrToSvrConnect(&_comm, rodsServerHost); if ( status < 0 ) { log_agent::error(ERROR(status, "svrToSvrConnect failed.").result()); return status; } - // call post disconnect maintenance operations before exit - status = resc_mgr.call_maintenance_operations(rodsServerHost->conn); - - return status; + // Call post disconnect maintenance operations before exit. + return resc_mgr.call_maintenance_operations(rodsServerHost->conn); } // agentMain auto create_agent_pid_file_for_ips(const RsComm& _comm, std::time_t _created_at) -> void