icinga2/lib/remoting/responsemessage.h

150 lines
3.8 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 *
2012-05-11 13:33:57 +02:00
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA. *
******************************************************************************/
#ifndef RESPONSEMESSAGE_H
#define RESPONSEMESSAGE_H
2012-04-18 15:22:25 +02:00
2013-03-17 20:19:29 +01:00
#include "remoting/i2-remoting.h"
#include "remoting/messagepart.h"
2012-04-18 15:22:25 +02:00
namespace icinga
{
2012-05-18 22:21:28 +02:00
/**
* A JSON-RPC response message.
*
2012-09-10 14:07:32 +02:00
* @ingroup remoting
2012-05-18 22:21:28 +02:00
*/
2012-09-10 14:07:32 +02:00
class I2_REMOTING_API ResponseMessage : public MessagePart
2012-04-18 15:22:25 +02:00
{
public:
/**
* Constructor for the ResponseMessage class.
*/
ResponseMessage(void) : MessagePart() {
SetVersion("2.0");
}
/**
* Copy-constructor for the ResponseMessage class.
*
* @param message The message that should be copied.
*/
ResponseMessage(const MessagePart& message) : MessagePart(message) { }
2012-04-18 15:22:25 +02:00
/**
* Retrieves the version of the JSON-RPC protocol.
*
* @param[out] value The value.
* @returns true if the value was retrieved, false otherwise.
*/
inline bool GetVersion(String *value) const
2012-04-18 15:22:25 +02:00
{
return Get("jsonrpc", value);
2012-04-18 15:22:25 +02:00
}
/**
* Sets the version of the JSON-RPC protocol that should be used.
*
* @param value The version.
*/
inline void SetVersion(const String& value)
2012-04-18 15:22:25 +02:00
{
Set("jsonrpc", value);
2012-04-18 15:22:25 +02:00
}
/**
* Retrieves the result of the JSON-RPC call.
*
* @param[out] value The result.
* @returns true if the value was retrieved, false otherwise.
*/
bool GetResult(MessagePart *value) const
2012-04-18 15:22:25 +02:00
{
return Get("result", value);
2012-04-18 15:22:25 +02:00
}
/**
* Sets the result for the JSON-RPC call.
*
* @param value The result.
*/
void SetResult(const MessagePart& value)
2012-04-18 15:22:25 +02:00
{
Set("result", value);
2012-04-18 15:22:25 +02:00
}
/**
* Retrieves the error message of the JSON-RPC call.
*
* @param[out] value The error message.
* @returns true if the value was retrieved, false otherwise.
*/
bool GetError(String *value) const
2012-04-18 15:22:25 +02:00
{
return Get("error", value);
2012-04-18 15:22:25 +02:00
}
/**
* Sets the error message for the JSON-RPC call.
*
* @param value The error message.
*/
void SetError(const String& value)
2012-04-18 15:22:25 +02:00
{
Set("error", value);
2012-04-18 15:22:25 +02:00
}
/**
* Retrieves the ID of the JSON-RPC call.
*
* @param[out] value The ID.
* @return true if the value was retrieved, false otherwise.
*/
bool GetID(String *value) const
2012-04-18 15:22:25 +02:00
{
return Get("id", value);
2012-04-18 15:22:25 +02:00
}
/**
* Sets the ID for the JSON-RPC call.
*
* @param value The ID.
*/
void SetID(const String& value)
2012-04-18 15:22:25 +02:00
{
Set("id", value);
2012-04-18 15:22:25 +02:00
}
/**
* Checks whether a message is a response message.
*
* @param message The message.
* @returns true if the message is a response message, false otherwise.
*/
static bool IsResponseMessage(const MessagePart& message)
{
return (message.Contains("result"));
}
2012-04-18 15:22:25 +02:00
};
}
#endif /* RESPONSEMESSAGE_H */