/******************************************************************
 *  $Id: nanohttp-admin.h,v 1.8 2007/11/04 06:57:32 m0gg Exp $
 *
 * CSOAP Project:  A SOAP client/server library in C
 * Copyright (C) 2003  Ferhat Ayaz
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Library General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library 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
 * Library General Public License for more details.
 *
 * You should have received a copy of the GNU Library General Public
 * License along with this library; if not, write to the
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 * Boston, MA  02111-1307, USA.
 * 
 * Email: ferhatayaz@yahoo.com
 ******************************************************************/
#ifndef __nanohttp_admin_h
#define __nanohttp_admin_h

/** @file nanohttp-admin.h Administrator application
 *
 * @defgroup NANOHTTP_ADMIN Administrator application
 * @ingroup NANOHTTP_SERVER
 */
/**@{*/

/** @defgroup NANOHTTP_ADMIN_CMDLINE_FLAGS Command line flags
 */
/**@{*/
/** Commandline argument to enabled the nanoHTTP admin interface.
 * This service will be reachable via the NHTTPD_ADMIN_CONTEXT.
 *
 * @see NHTTPD_ADMIN_CONTEXT
 */
#define NHTTPD_ARG_ENABLE_ADMIN			"-NHTTPDadmin"

/**@}*/

/** Context of the nanoHTTP admin interface.
 *
 * Example query:
 @verbatim
   GET http://localhost:10000/nhttp
 @endverbatim
 *
 * @see httpd_register
 */
#define NHTTPD_ADMIN_CONTEXT			"/nhttp"

/** Query parameter for services.
 *
 * Example query:
 @verbatim
   GET http://localhost:10000/nhttp?services=list
 @endverbatim
 */
#define NHTTPD_ADMIN_QUERY_SERVICES		"services"

/** Parameter to query service statistics.
 *
 * Example query:
 @verbatim
   GET http://localhost:10000/nhttp?statistics=SERVICE_CONTEXT
 @endverbatim
 */
#define NHTTPD_ADMIN_QUERY_STATISTICS		"statistics"


/** Parameter to enable a server.
 *
 * Example query:
 @verbatim
   GET http://localhost:10000/nhttp?activate=SERVICE_CONTEXT
 @endverbatim
 */
#define NHTTPD_ADMIN_QUERY_ACTIVATE_SERVICE	"activate"

/** Parameter to disable a service.
 *
 * Example query:
 @verbatim
   GET http://localhost:10000/nhttp?passivate=SERVICE_CONTEXT
 @endverbatim
 */
#define NHTTPD_ADMIN_QUERY_PASSIVATE_SERVICE	"passivate"

/** Parameter to switch loglevels.
 *
 * Example query:
 @verbatim
   GET http://localhost:10000/nhttp?loglevel=OFF
 @endverbatim
 */
#define NHTTPD_ADMIN_QUERY_SET_LOGLEVEL         "loglevel"

#ifdef __cplusplus
extern "C" {
#endif

/** This function initializes the nanoHTTP admin interface with
 * commandline arguments, if NHTTPD_ARG_ENABLED_ADMIN was specified
 * on the commandline. This service will be reachable via the
 * NHTTP_ADMIN_CONTEXT of the nanohttp server.
 *
 * @param argc commandline arg count
 * @param argv commandline arg vector
 *
 * @returns H_OK on success
 *
 * @see NHTTPD_ADMIN_CONTEXT
 * @see NHTTPD_ARG_ENABLE_ADMIN
 */
extern herror_t httpd_admin_init_args(int argc, char **argv);

#ifdef __cplusplus
}
#endif

/**@}*/

#endif