first revision of new manager webapp

2007-09-11 15:22:02 +00:00
parent f0c156fbc9
commit 965e99b5bf
36 changed files with 3517 additions and 0 deletions
@@ -0,0 +1,93 @@
+/**
+ * @file manager.h
+ * 
+ * @brief Interface of manager_t.
+ * 
+ */
+
+/*
+ * Copyright (C) 2007 Martin Willi
+ * Hochschule fuer Technik Rapperswil
+ *
+ * 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.  See <http://www.fsf.org/copyleft/gpl.txt>.
+ *
+ * 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.
+ */
+
+#ifndef MANAGER_H_
+#define MANAGER_H_
+
+#include "database.h"
+#include "gateway.h"
+
+#include <context.h>
+
+#include <utils/iterator.h>
+
+typedef struct manager_t manager_t;
+
+/**
+ * @brief The manager, manages multiple gateways.
+ */
+struct manager_t {
+
+	/**
+	 * implements context_t interface
+	 */
+	context_t context;
+	
+	/**
+	 * @brief Create an iterator over all configured gateways.
+	 *
+	 * enumerate() arguments: int id, char *name, int port, char *address
+	 * If port is 0, address is a Unix socket address.
+	 *
+	 * @return			enumerator
+	 */
+	enumerator_t* (*create_gateway_enumerator)(manager_t *this);
+	
+	/**
+	 * @brief Select a gateway.
+	 *
+	 * If id is 0, the previously selected gateway is returned. If none has
+	 * been selected yet, NULL is returned.
+	 *
+	 * @param id		id of the gateway (from enumerate), or 0
+	 * @return			selected gateway, or NULL
+	 */
+	gateway_t* (*select_gateway)(manager_t *this, int id);
+	
+	/**
+	 * @brief Try to log in.
+	 *
+	 * @param username	username
+	 * @param password	cleartext password
+	 * @return			TRUE if login successful
+	 */
+	bool (*login)(manager_t *this, char *username, char *password);
+	
+	/**
+	 * @brief Check if user logged in.
+	 *
+	 * @return			TRUE if logged in
+	 */
+	bool (*logged_in)(manager_t *this);
+	
+	/**
+	 * @brief Log out.
+	 */
+	void (*logout)(manager_t *this);
+};
+
+/**
+ * @brief Create a manager instance.
+ */
+manager_t *manager_create(database_t *database);
+
+#endif /* MANAGER_H_ */