icinga2/lib/remote/zone.hpp

// SPDX-FileCopyrightText: 2012 Icinga GmbH <https://icinga.com>
// SPDX-License-Identifier: GPL-2.0-or-later

#ifndef ZONE_H
#define ZONE_H

#include "remote/i2-remote.hpp"
#include "remote/zone-ti.hpp"
#include "remote/endpoint.hpp"

namespace icinga
{

/**
 * @ingroup remote
 */
class Zone final : public ObjectImpl<Zone>
{
public:
	DECLARE_OBJECT(Zone);
	DECLARE_OBJECTNAME(Zone);

	void OnAllConfigLoaded() override;

	Zone::Ptr GetParent() const;
	std::vector<Endpoint::Ptr> GetEndpoints() const;
	std::vector<Zone::Ptr> GetAllParentsRaw() const;
	Array::Ptr GetAllParents() const override;

	bool CanAccessObject(const ConfigObject::Ptr& object);
	bool IsChildOf(const Zone::Ptr& zone);
	bool IsGlobal() const;
	bool IsHACluster() const;

	static Zone::Ptr GetLocalZone();

protected:
	void ValidateEndpointsRaw(const Lazy<Array::Ptr>& lvalue, const ValidationUtils& utils) override;

private:
	Zone::Ptr m_Parent;
	std::vector<Zone::Ptr> m_AllParents;
};

}

#endif /* ZONE_H */
Replace all existing copyright headers with `SPDX` headers I've used the following command to replace the original copyright header lines in a C-style comment block: ``` $ find . \( -type d \( -name '\..' -o -name third-party -o -name scripts -o -name prefix -o -name malloc -o -name server -o -name docker -o -name build -o -name doc \) -prune \) -o -type f -exec perl -pi -e 's{/\[^]\(\sc\s\)\s(\d{4})\sIcinga\s+GmbH[^]\/}{// SPDX-FileCopyrightText: \1 Icinga GmbH <https://icinga.com>\n// SPDX-License-Identifier: GPL-2.0-or-later}gi' {} + ``` For files that use shell-style comments (#) like CMakeLists.txt, I've used this command: ``` $ find . \( -type d \( -name '\..' -o -name third-party -o -name scripts -o -name prefix -o -name malloc -o -name server -o -name docker -o -name build -o -name doc \) -prune \) -o -type f -exec perl -pi -e 's{#.\(\sc\s\)\s(\d{4})\sIcinga\s+GmbH.}{# SPDX-FileCopyrightText: \1 Icinga GmbH <https://icinga.com>\n# SPDX-License-Identifier: GPL-2.0-or-later}gi' {} + ``` And for SQL files: ``` $ find . \( -type d \( -name '\..' -o -name third-party -o -name scripts -o -name prefix -o -name malloc -o -name server -o -name docker -o -name build -o -name doc \) -prune \) -o -type f \( -name '.sql' \) -exec perl -pi -e 's{--.\(c\)\s(\d{4})\sIcinga\sGmbH.}{-- SPDX-FileCopyrightText: \1 Icinga GmbH <https://icinga.com>\n-- SPDX-License-Identifier: GPL-2.0-or-later}gi' {} + $ find . \( -type d \( -name '\..' -o -name third-party -o -name scripts -o -name prefix -o -name malloc -o -name server -o -name docker -o -name build -o -name doc \) -prune \) -o -type f \( -name '.sql' \) -exec perl -pi -e 's{-- Copyright \(c\)\s(\d{4})\sIcinga\s+Development\sTeam.*}{-- SPDX-FileCopyrightText: \1 Icinga GmbH <https://icinga.com>\n-- SPDX-License-Identifier: GPL-2.0-or-later}gi' {} + ``` 2026-01-27 09:06:40 -05:00			`// SPDX-FileCopyrightText: 2012 Icinga GmbH <https://icinga.com>`
			`// SPDX-License-Identifier: GPL-2.0-or-later`
Implement loop detection for cluster links. Refs #5467 2014-04-25 08:33:45 -04:00
Refactor the agent and cluster components. Refs #6107 2014-05-03 14:02:22 -04:00			`#ifndef ZONE_H`
			`#define ZONE_H`
Implement loop detection for cluster links. Refs #5467 2014-04-25 08:33:45 -04:00
Rename C++ header files. Fixes #6291 2014-05-25 10:23:35 -04:00			`#include "remote/i2-remote.hpp"`
Fix compatibility with CMake < 3.1 2018-01-18 07:50:38 -05:00			`#include "remote/zone-ti.hpp"`
Rename C++ header files. Fixes #6291 2014-05-25 10:23:35 -04:00			`#include "remote/endpoint.hpp"`
Implement loop detection for cluster links. Refs #5467 2014-04-25 08:33:45 -04:00
			`namespace icinga`
			`{`

			`/**`
Refactor the agent and cluster components. Refs #6107 2014-05-03 14:02:22 -04:00			`* @ingroup remote`
Implement loop detection for cluster links. Refs #5467 2014-04-25 08:33:45 -04:00			`*/`
Add the final keyword to classes 2018-01-04 00:11:04 -05:00			`class Zone final : public ObjectImpl<Zone>`
Implement loop detection for cluster links. Refs #5467 2014-04-25 08:33:45 -04:00			`{`
Refactor the agent and cluster components. Refs #6107 2014-05-03 14:02:22 -04:00			`public:`
Implement typeof() function 2014-11-02 18:44:04 -05:00			`DECLARE_OBJECT(Zone);`
			`DECLARE_OBJECTNAME(Zone);`
Implement loop detection for cluster links. Refs #5467 2014-04-25 08:33:45 -04:00
Apply clang-tidy fix 'modernize-use-override' 2018-01-03 23:12:56 -05:00			`void OnAllConfigLoaded() override;`
Improve performance for Zone::CanAccessObject fixes #10711 2015-11-24 09:25:55 -05:00
Apply clang-tidy fix 'modernize-redundant-void-arg' 2018-01-03 22:25:35 -05:00			`Zone::Ptr GetParent() const;`
Zone#GetEndpoints(): return endpoints in the specified order, not randomly ApiListener#RelayMessageOne() relays every given message to the first connected endpoint Zone#GetEndpoints() returns. Randomness in combination with bad luck can direct more traffic (from a particular network segment) to one master than the admin wants. This change lets the Zone#endpoints order prefer one endpoint over the other. 2025-03-25 08:04:41 -04:00			`std::vector<Endpoint::Ptr> GetEndpoints() const;`
Rename Zone#GetAllParents() to Zone#GetAllParentsRaw() 2018-08-08 07:59:43 -04:00			`std::vector<Zone::Ptr> GetAllParentsRaw() const;`
Expose Zone#all_parents via API 2018-08-08 08:15:01 -04:00			`Array::Ptr GetAllParents() const override;`
Implement loop detection for cluster links. Refs #5467 2014-04-25 08:33:45 -04:00
Rename DynamicObject/DynamicType to ConfigObject/ConfigType fixes #9914 2015-08-15 14:28:05 -04:00			`bool CanAccessObject(const ConfigObject::Ptr& object);`
Implement the config::Update message. Refs #6191 2014-05-13 09:57:02 -04:00			`bool IsChildOf(const Zone::Ptr& zone);`
Apply clang-tidy fix 'modernize-redundant-void-arg' 2018-01-03 22:25:35 -05:00			`bool IsGlobal() const;`
Fix inverted `IsHACluster` check 2025-04-23 06:06:26 -04:00			`bool IsHACluster() const;`
Implement loop detection for cluster links. Refs #5467 2014-04-25 08:33:45 -04:00
Apply clang-tidy fix 'modernize-redundant-void-arg' 2018-01-03 22:25:35 -05:00			`static Zone::Ptr GetLocalZone();`
Improve performance for Zone::CanAccessObject fixes #10711 2015-11-24 09:25:55 -05:00
Log a warning if there are more than 2 zone endpoint members fixes #12222 2016-07-26 02:10:47 -04:00			`protected:`
Avoid accessing attributes for validators where not necessary 2018-01-11 01:08:09 -05:00			`void ValidateEndpointsRaw(const Lazy<Array::Ptr>& lvalue, const ValidationUtils& utils) override;`
Log a warning if there are more than 2 zone endpoint members fixes #12222 2016-07-26 02:10:47 -04:00
Improve performance for Zone::CanAccessObject fixes #10711 2015-11-24 09:25:55 -05:00			`private:`
			`Zone::Ptr m_Parent;`
Improve the performance for ApiListener::SyncRelayMessage (part 2) refs #11014 2016-01-27 06:18:16 -05:00			`std::vector<Zone::Ptr> m_AllParents;`
Implement loop detection for cluster links. Refs #5467 2014-04-25 08:33:45 -04:00			`};`

			`}`

Refactor the agent and cluster components. Refs #6107 2014-05-03 14:02:22 -04:00			`#endif /* ZONE_H */`