summaryrefslogtreecommitdiffstats
path: root/inc/reporter.h
diff options
context:
space:
mode:
Diffstat (limited to 'inc/reporter.h')
-rw-r--r--inc/reporter.h47
1 files changed, 47 insertions, 0 deletions
diff --git a/inc/reporter.h b/inc/reporter.h
new file mode 100644
index 00000000..12f1b0b9
--- /dev/null
+++ b/inc/reporter.h
@@ -0,0 +1,47 @@
+/*
+ Reporter.h - header file for reporter plugin
+
+ Copyright (C) 2009 Zdenek Prikryl (zprikryl@redhat.com)
+ Copyright (C) 2009 RedHat inc.
+
+ 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 Street, Fifth Floor, Boston, MA 02110-1301 USA.
+*/
+#ifndef REPORTER_H_
+#define REPORTER_H_
+
+#include <string>
+#include "plugin.h"
+#include "crash_types.h"
+
+/**
+ * An abstract class. The class defines a reporter plugin interface.
+ */
+class CReporter : public CPlugin
+{
+ public:
+ /**
+ * A method, which reports a crash report to particular receiver.
+ * The plugin can takes arguments, but the plugin has to parse them
+ * by itself.
+ * @param pCrashData A crash report.
+ * @param pArgs Plugin's arguments.
+ * @retun A message which can be displayed after a report is created.
+ */
+ virtual std::string Report(const map_crash_data_t& pCrashData,
+ const map_plugin_settings_t& pSettings,
+ const char *pArgs) = 0;
+};
+
+#endif /* REPORTER_H_ */