Skip to content
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.

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

[config] API change for ecal_config.h #1854

Merged
merged 2 commits into from
Dec 12, 2024

Conversation

Peguen
Copy link
Contributor

@Peguen Peguen commented Dec 11, 2024

Description

Removed the experimental namespace out of ecal_config.h.
Moved some config Get functions to internal space.

@Peguen Peguen added the cherry-pick-to-NONE Don't cherry-pick these changes label Dec 11, 2024
Copy link
Contributor

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

clang-tidy made some suggestions

#pragma once

#include <cstddef>
#include <ecal/ecal_log_level.h>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

warning: included header cstddef is not used directly [misc-include-cleaner]

Suggested change
#include <ecal/ecal_log_level.h>
#include <ecal/ecal_log_level.h>


#include <cstddef>
#include <ecal/ecal_log_level.h>
#include <ecal/ecal_os.h>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

warning: included header ecal_log_level.h is not used directly [misc-include-cleaner]

Suggested change
#include <ecal/ecal_os.h>
#include <ecal/ecal_os.h>

#include <ecal/ecal_log_level.h>
#include <ecal/ecal_os.h>
#include <ecal/ecal_tlayer.h>
#include "ecal/config/configuration.h"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

warning: included header ecal_tlayer.h is not used directly [misc-include-cleaner]

Suggested change
#include "ecal/config/configuration.h"
#include "ecal/config/configuration.h"

#include <ecal/ecal_os.h>
#include <ecal/ecal_tlayer.h>
#include "ecal/config/configuration.h"

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

warning: included header configuration.h is not used directly [misc-include-cleaner]

Suggested change

#include "ecal/config/configuration.h"

#include <string>

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

warning: included header string is not used directly [misc-include-cleaner]

Suggested change

{
ECAL_API TransportLayer::Configuration& GetTransportLayerConfiguration ();
ECAL_API Registration::Configuration& GetRegistrationConfiguration ();
ECAL_API Monitoring::Configuration& GetMonitoringConfiguration ();
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

warning: no header providing "eCAL::Monitoring::Configuration" is directly included [misc-include-cleaner]

ecal/core/src/ecal_config_internal.h:26:

+ #include "ecal/config/monitoring.h"

ECAL_API TransportLayer::Configuration& GetTransportLayerConfiguration ();
ECAL_API Registration::Configuration& GetRegistrationConfiguration ();
ECAL_API Monitoring::Configuration& GetMonitoringConfiguration ();
ECAL_API Logging::Configuration& GetLoggingConfiguration ();
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

warning: no header providing "eCAL::Logging::Configuration" is directly included [misc-include-cleaner]

ecal/core/src/ecal_config_internal.h:26:

+ #include "ecal/config/logging.h"

ECAL_API Registration::Configuration& GetRegistrationConfiguration ();
ECAL_API Monitoring::Configuration& GetMonitoringConfiguration ();
ECAL_API Logging::Configuration& GetLoggingConfiguration ();
ECAL_API Time::Configuration& GetTimesyncConfiguration ();
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

warning: no header providing "eCAL::Time::Configuration" is directly included [misc-include-cleaner]

ecal/core/src/ecal_config_internal.h:26:

+ #include "ecal/config/time.h"

ECAL_API Monitoring::Configuration& GetMonitoringConfiguration ();
ECAL_API Logging::Configuration& GetLoggingConfiguration ();
ECAL_API Time::Configuration& GetTimesyncConfiguration ();
ECAL_API Application::Configuration& GetApplicationConfiguration ();
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

warning: no header providing "eCAL::Application::Configuration" is directly included [misc-include-cleaner]

ecal/core/src/ecal_config_internal.h:25:

- #include "ecal/config/configuration.h"
+ #include "ecal/config/application.h"
+ #include "ecal/config/configuration.h"

@@ -208,7 +208,7 @@ namespace eCAL
#if ECAL_CORE_SUBSCRIBER
sstream << "------------------------- SUBSCRIPTION LAYER DEFAULTS ------------" << '\n';
sstream << "Layer Mode UDP MC : " << LayerMode(Config::IsUdpMulticastRecEnabled()) << '\n';
sstream << "Drop out-of-order msgs : " << (Config::Experimental::GetDropOutOfOrderMessages() ? "on" : "off") << '\n';
sstream << "Drop out-of-order msgs : " << (Config::GetDropOutOfOrderMessages() ? "on" : "off") << '\n';
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

warning: no header providing "eCAL::Config::GetDropOutOfOrderMessages" is directly included [misc-include-cleaner]

      sstream << "Drop out-of-order msgs   : " << (Config::GetDropOutOfOrderMessages() ? "on" : "off") << '\n';
                                                           ^

Copy link
Contributor

@rex-schilasky rex-schilasky left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

all config functions except GetConfiguration, GetPublisherConfiguration and GetSubscriberConfiguration need to be moved to ecal_config_internal.h as well

@Peguen Peguen merged commit 8551151 into master Dec 12, 2024
20 checks passed
@Peguen Peguen deleted the feature/ecal_api_ecal_configuration_h branch December 12, 2024 09:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cherry-pick-to-NONE Don't cherry-pick these changes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants