icinga2/lib/icinga/service.h

146 lines
4.5 KiB
C
Raw Normal View History

/******************************************************************************
* Icinga 2 *
* Copyright (C) 2012 Icinga Development Team (http://www.icinga.org/) *
* *
* This program is free software; you can redistribute it and/or *
* modify it under the terms of the GNU General Public License *
* as published by the Free Software Foundation; either version 2 *
* of the License, or (at your option) any later version. *
* *
* This program is distributed in the hope that it will be useful, *
* but WITHOUT ANY WARRANTY; without even the implied warranty of *
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
* GNU General Public License for more details. *
* *
* You should have received a copy of the GNU General Public License *
* along with this program; if not, write to the Free Software Foundation *
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA. *
******************************************************************************/
#ifndef SERVICE_H
#define SERVICE_H
namespace icinga
{
2012-09-17 13:35:55 +02:00
/**
* The state of a service.
*
* @ingroup icinga
*/
2012-06-25 15:42:46 +02:00
enum ServiceState
{
StateOK,
StateWarning,
StateCritical,
2012-06-27 18:43:34 +02:00
StateUnknown,
2012-06-25 15:42:46 +02:00
StateUncheckable,
};
2012-09-17 13:35:55 +02:00
/**
* The state type of a service.
*
* @ingroup icinga
*/
2012-06-25 15:42:46 +02:00
enum ServiceStateType
{
2012-06-27 18:43:34 +02:00
StateTypeSoft,
StateTypeHard
2012-06-25 15:42:46 +02:00
};
class CheckResultMessage;
2012-07-03 14:18:46 +02:00
class ServiceStatusMessage;
2012-09-17 13:35:55 +02:00
/**
* An Icinga service.
*
* @ingroup icinga
*/
2012-09-10 14:07:32 +02:00
class I2_ICINGA_API Service : public DynamicObject
{
public:
typedef shared_ptr<Service> Ptr;
typedef weak_ptr<Service> WeakPtr;
Service(const Dictionary::Ptr& properties);
static bool Exists(const String& name);
static Service::Ptr GetByName(const String& name);
2012-06-27 18:43:34 +02:00
2012-09-05 10:13:24 +02:00
static const int DefaultMaxCheckAttempts;
static const int DefaultCheckInterval;
static const int MinCheckInterval;
static const int CheckIntervalDivisor;
String GetAlias(void) const;
Host::Ptr GetHost(void) const;
Dictionary::Ptr GetMacros(void) const;
String GetCheckCommand(void) const;
long GetMaxCheckAttempts(void) const;
long GetCheckInterval(void) const;
long GetRetryInterval(void) const;
2012-06-27 18:43:34 +02:00
Dictionary::Ptr GetDependencies(void) const;
2012-07-09 10:09:53 +02:00
void GetDependenciesRecursive(const Dictionary::Ptr& result) const;
2012-06-30 13:39:55 +02:00
Dictionary::Ptr GetGroups(void) const;
2012-07-02 16:19:43 +02:00
Dictionary::Ptr GetCheckers(void) const;
2012-07-03 15:11:11 +02:00
bool IsReachable(void) const;
2012-07-03 14:18:46 +02:00
long GetSchedulingOffset(void);
void SetSchedulingOffset(long offset);
void SetNextCheck(double nextCheck);
double GetNextCheck(void);
2012-06-27 18:43:34 +02:00
void UpdateNextCheck(void);
2012-06-25 15:42:46 +02:00
void SetChecker(const String& checker);
String GetChecker(void) const;
bool IsAllowedChecker(const String& checker) const;
2012-06-27 18:43:34 +02:00
2012-06-25 15:42:46 +02:00
void SetCurrentCheckAttempt(long attempt);
long GetCurrentCheckAttempt(void) const;
void SetState(ServiceState state);
ServiceState GetState(void) const;
void SetStateType(ServiceStateType type);
ServiceStateType GetStateType(void) const;
void SetLastCheckResult(const Dictionary::Ptr& result);
Dictionary::Ptr GetLastCheckResult(void) const;
2012-06-27 18:43:34 +02:00
void SetLastStateChange(double ts);
double GetLastStateChange(void) const;
2012-06-27 18:43:34 +02:00
void SetLastHardStateChange(double ts);
double GetLastHardStateChange(void) const;
2012-06-27 18:43:34 +02:00
void ApplyCheckResult(const Dictionary::Ptr& cr);
2012-06-27 18:43:34 +02:00
void BeginExecuteCheck(const function<void (void)>& callback);
void ProcessCheckResult(const Dictionary::Ptr& cr);
static ServiceState StateFromString(const String& state);
static String StateToString(ServiceState state);
2012-06-27 18:43:34 +02:00
static ServiceStateType StateTypeFromString(const String& state);
static String StateTypeToString(ServiceStateType state);
2012-07-03 14:18:46 +02:00
static Dictionary::Ptr ResolveDependencies(const Host::Ptr& host, const Dictionary::Ptr& dependencies);
static boost::signal<void (const Service::Ptr& service, const CheckResultMessage&)> OnCheckResultReceived;
static boost::signal<void (const Service::Ptr&, const String&)> OnCheckerChanged;
protected:
virtual void OnAttributeChanged(const String& name, const Value& oldValue);
private:
void CheckCompletedHandler(const Dictionary::Ptr& scheduleInfo,
const ScriptTask::Ptr& task, const function<void (void)>& callback);
};
}
#endif /* SERVICE_H */