summaryrefslogtreecommitdiffstats
path: root/nanohttp/nanohttp-admin.h
blob: bbbc0e2c287d1473316f7287f76e1f4b07d2df0a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
/******************************************************************
 *  $Id: nanohttp-admin.h,v 1.6 2006/12/19 08:55:17 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

/**
 *
 * 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:
 *
 * @code
 *   http://localhost:10000/nhttp
 * @endcode
 *
 * @see httpd_register
 *
 */
#define NHTTPD_ADMIN_CONTEXT			"/nhttp"

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

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


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

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

#ifdef __cplusplus
extern "C" {
#endif

/**
 *
 * Initializes the nanoHTTP admin interface with commandline arguments, if
 * NHTTPD_ARG_ENABLED_ADMIN was specified in the commandline arguments. 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