pupnp (libupnp) snapshot from SourceForge: git clone git://pupnp.git.sourceforge...
[igd2-for-linux:pandonghui1211s-igd2-for-linux.git] / pupnp_branch-1.6.x / build / inc / config.h
1 ///////////////////////////////////////////////////////////////////////////
2 //
3 // Copyright (c) 2000-2003 Intel Corporation 
4 // All rights reserved. 
5 //
6 // Redistribution and use in source and binary forms, with or without 
7 // modification, are permitted provided that the following conditions are met: 
8 //
9 // * Redistributions of source code must retain the above copyright notice, 
10 // this list of conditions and the following disclaimer. 
11 // * Redistributions in binary form must reproduce the above copyright notice, 
12 // this list of conditions and the following disclaimer in the documentation 
13 // and/or other materials provided with the distribution. 
14 // * Neither name of Intel Corporation nor the names of its contributors 
15 // may be used to endorse or promote products derived from this software 
16 // without specific prior written permission.
17 // 
18 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 
19 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 
20 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 
21 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL INTEL OR 
22 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, 
23 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, 
24 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR 
25 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY 
26 // OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
27 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS 
28 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29 //
30 ///////////////////////////////////////////////////////////////////////////
31
32 #ifndef INTERNAL_CONFIG_H
33 #define INTERNAL_CONFIG_H 
34
35 #include "autoconfig.h"
36
37
38 /** @name Compile time configuration options
39  *  The Linux SDK for UPnP Devices contains some compile-time parameters 
40  *  that effect the behavior of the SDK.  All configuration options are 
41  *  located in {\tt src/inc/config.h}.
42  */
43  
44 //@{
45
46 /** @name THREAD_IDLE_TIME
47  *  The {\tt THREAD_IDLE_TIME} constant determines when a thread will be
48  *  removed from the thread pool and returned to the operating system. When 
49  *  a thread in the thread pool has been idle for this number of milliseconds
50  *  the thread will be released from the thread pool.  The default value is
51  *  5000 milliseconds (5 seconds).
52  */
53
54 //@{
55 #define THREAD_IDLE_TIME 5000
56 //@}
57
58 /** @name JOBS_PER_THREAD
59  *  The {\tt JOBS_PER_THREAD} constant determines when a new thread will be
60  *  allocated to the thread pool inside the  SDK. The thread pool will
61  *  try and maintain this jobs/thread ratio. When the jobs/thread ratio 
62  *  becomes greater than this, then a new thread (up to the max) will be 
63  *  allocated to the thread pool.  The default ratio is 10 jobs/thread.
64  */
65
66 //@{
67 #define JOBS_PER_THREAD 10
68 //@}
69
70 /** @name MIN_THREADS
71  *  The {\tt MIN_THREADS} constant defines the minimum number of threads the
72  *  thread pool inside the SDK will create.  The thread pool will
73  *  always have this number of threads. These threads are used
74  *  for both callbacks into applications built on top of the SDK and also
75  *  for making connections to other control points and devices. This number
76  *  includes persistent threads.  The default value is two threads.
77  */
78
79 //@{
80 #define MIN_THREADS 2 
81 //@}
82
83 /** @name MAX_THREADS
84  *  The {\tt MAX_THREADS} constant defines the maximum number of threads the
85  *  thread pool inside the SDK will create.  These threads are used
86  *  for both callbacks into applications built on top of the library and also 
87  *  for making connections to other control points and devices.  It is not 
88  *  recommended that this value be below 10, since the threads are 
89  *  necessary for correct operation.  This value can be increased for greater
90  *  performance in operation at the expense of greater memory overhead.  The 
91  *  default value is 12.
92  */
93
94 //@{
95 #define MAX_THREADS 12 
96 //@}
97
98 /** @name MAX_JOBS_TOTAL
99  *  The {\tt MAX_JOBS_TOTAL} constant determines the maximum number of jobs
100  *  that can be queued. If this limit is reached further jobs will be thrown
101  *  to avoid memory exhaustion. The default value 100.
102  *  (Added by Axis.)
103  */
104
105 //@{
106 #define MAX_JOBS_TOTAL 100
107 //@}
108
109 /** @name DEFAULT_SOAP_CONTENT_LENGTH
110  * SOAP messages will read at most {\tt DEFAULT_SOAP_CONTENT_LENGTH} bytes.  
111  * This prevents devices that have a misbehaving web server to send 
112  * a large amount of data to the control point causing it to crash.  
113  * This can be adjusted dynamically with {\tt UpnpSetMaxContentLength}.
114  */
115 //@{
116 #define DEFAULT_SOAP_CONTENT_LENGTH 16000
117 //@}
118
119 /** @name NUM_SSDP_COPY
120  * This configuration parameter determines how many copies of each SSDP 
121  * advertisement and search packets will be sent. By default it will send two 
122  * copies of every packet.  
123  */
124 //@{
125 #define NUM_SSDP_COPY  2
126 //@}
127
128 /** @name SSDP_PAUSE
129  * This configuration parameter determines the pause between identical SSDP 
130  * advertisement and search packets. The pause is measured in milliseconds
131  * and defaults to 100.
132  */
133 //@{
134 #define SSDP_PAUSE  100
135 //@}
136
137 /** @name WEB_SERVER_BUF_SIZE 
138  * This configuration parameter sets the maximum buffer size for the 
139  * webserver.  The default value is 1MB.
140  */
141 //@{
142 #define WEB_SERVER_BUF_SIZE  (1024*1024)
143 //@}
144
145 /** @name AUTO_RENEW_TIME
146  * The {\tt AUTO_RENEW_TIME} is the time, in seconds, before a subscription
147  * expires that the SDK automatically resubscribes.  The default 
148  * value is 10 seconds.  Setting this value too low can result in the 
149  * subscription renewal not making it to the device in time, causing the 
150  * subscription to timeout. In order to avoid continually resubscribing
151  * the minimum subscription time is five seconds more than the auto renew
152  * time.
153  */
154
155 //@{
156 #define AUTO_RENEW_TIME 10
157 //@}
158
159 /** @name CP_MINIMUM_SUBSCRIPTION_TIME 
160  * The {\tt CP_MINIMUM_SUBSCRIPTION_TIME} is the minimum subscription time
161  * allowed for a control point using the SDK. Subscribing for less than
162  * this time automatically results in a subscription for this amount.  The 
163  * default value is 5 seconds more than the {\tt AUTO_RENEW_TIME}, or 15
164  * seconds.
165  */
166
167 //@{
168 #define CP_MINIMUM_SUBSCRIPTION_TIME (AUTO_RENEW_TIME + 5)
169 //@}
170
171 /** @name MAX_SEARCH_TIME 
172  * The {\tt MAX_SEARCH_TIME} is the maximum time
173  * allowed for an SSDP search by a control point. Searching for greater than
174  * this time automatically results in a search for this amount.  The default 
175  * value is 80 seconds.
176  */
177
178 //@{
179 #define MAX_SEARCH_TIME 80
180 //@}
181
182 /** @name MIN_SEARCH_TIME 
183  * The {\tt MIN_SEARCH_TIME} is the minimumm time
184  * allowed for an SSDP search by a control point. Searching for less than
185  * this time automatically results in a search for this amount.  The default 
186  * value is 2 seconds.
187  */
188
189 //@{
190 #define MIN_SEARCH_TIME 2
191 //@}
192
193
194 /** @name AUTO_ADVERTISEMENT_TIME
195  *  The {\tt AUTO_ADVERTISEMENT_TIME} is the time, in seconds, before an
196  *  device advertisements expires before a renewed advertisement is sent.
197  *  The default time is 30 seconds.
198  */
199
200 //@{
201 #define AUTO_ADVERTISEMENT_TIME 30
202 //@}
203
204 /** @name SSDP_PACKET_DISTRIBUTE
205  *  The {\tt SSDP_PACKET_DISTRIBUTE} enables the SSDP packets to be sent
206  *  at an interval equal to half of the expiration time of SSDP packets
207  *  minus the AUTO_ADVERTISEMENT_TIME. This is used to increase
208  *  the probability of SSDP packets reaching to control points.
209  *  It is recommended that this flag be turned on for embedded wireless 
210  *  devices.
211  */
212
213 //@{
214 #define SSDP_PACKET_DISTRIBUTE 1
215 //@}
216
217 /** @name Module Exclusion
218  *  Depending on the requirements, the user can selectively discard any of 
219  *  the major modules like SOAP, GENA, SSDP or the Internal web server. By 
220  *  default everything is included inside the SDK.  By setting any of
221  *  the values below to 0, that component will not be included in the final
222  *  SDK.
223  *  \begin{itemize}
224  *    \item {\tt EXCLUDE_SOAP[0,1]}
225  *    \item {\tt EXCLUDE_GENA[0,1]}
226  *    \item {\tt EXCLUDE_SSDP[0,1]}
227  *    \item {\tt EXCLUDE_DOM [0,1]}
228  *    \item {\tt EXCLUDE_MINISERVER[0,1]}
229  *    \item {\tt EXCLUDE_WEB_SERVER[0,1]}
230  *    \item {\tt EXCLUDE_JNI[0,1]}
231  *  \end{itemize}
232  *
233  */
234
235 //@{
236 #define EXCLUDE_SSDP 0
237 #define EXCLUDE_SOAP 0
238 #define EXCLUDE_GENA 0
239 #define EXCLUDE_DOM  0
240 #define EXCLUDE_MINISERVER 0
241 #define EXCLUDE_WEB_SERVER 0
242 #ifdef USE_JNI
243 #       define EXCLUDE_JNI 0
244 #else
245 #       define EXCLUDE_JNI 1
246 #endif
247 //@}
248
249     
250 /** @name DEBUG_TARGET
251  *  The user has the option to redirect the library output debug messages 
252  *  to either the screen or to a log file.  All the output messages with 
253  *  debug level 0 will go to {\tt upnp.err} and messages with debug level 
254  *  greater than zero will be redirected to {\tt upnp.out}.
255  */
256
257 //@{
258 #define DEBUG_TARGET            1   
259 //@}
260
261
262 /** @name Other debugging features
263           The UPnP SDK contains other features to aid in debugging:
264           see <upnp/inc/upnpdebug.h>
265  */
266
267 #define DEBUG_ALL               1
268 #define DEBUG_SSDP              0
269 #define DEBUG_SOAP              0
270 #define DEBUG_GENA              0
271 #define DEBUG_TPOOL             0
272 #define DEBUG_MSERV             0
273 #define DEBUG_DOM               0
274 #define DEBUG_HTTP              0
275 #define DEBUG_API               0
276
277 //@} // Compile time configuration options
278
279
280 /***************************************************************************
281  * Do not change, Internal purpose only!!! 
282  ***************************************************************************/ 
283
284 //@{
285
286 /*
287  * Set additional defines based on requested configuration 
288  */
289
290 // configure --enable-client
291 #if UPNP_HAVE_CLIENT
292 #       define INCLUDE_CLIENT_APIS      1
293 #endif
294
295 // configure --enable-device
296 #if UPNP_HAVE_DEVICE
297 #       define INCLUDE_DEVICE_APIS      1
298 #endif
299
300 // configure --enable-webserver --enable-device
301 #if UPNP_HAVE_WEBSERVER
302 #       define INTERNAL_WEB_SERVER      1
303 #endif
304
305
306
307 #undef  EXCLUDE_WEB_SERVER 
308 #undef  EXCLUDE_MINISERVER 
309 #ifdef  INTERNAL_WEB_SERVER
310 #       define EXCLUDE_WEB_SERVER 0
311 #       define EXCLUDE_MINISERVER 0
312 #else
313 #       define EXCLUDE_WEB_SERVER 1
314 #       define EXCLUDE_MINISERVER 1
315 #endif
316
317 #if EXCLUDE_GENA == 1 && EXCLUDE_SOAP == 1 && EXCLUDE_WEB_SERVER == 1
318 #       undef  EXCLUDE_MINISERVER 
319 #       define EXCLUDE_MINISERVER 1
320 #       if INTERNAL_WEB_SERVER
321 #               error "conflicting settings: use configure --disable-webserver"
322 #       endif
323 #endif
324
325 #if EXCLUDE_GENA == 0 || EXCLUDE_SOAP == 0 || EXCLUDE_WEB_SERVER == 0
326 #       undef  EXCLUDE_MINISERVER 
327 #       define EXCLUDE_MINISERVER 0
328 #       if EXCLUDE_WEB_SERVER == 0 && !defined INTERNAL_WEB_SERVER
329 #               error "conflicting settings : use configure --enable-webserver"
330 #       endif
331 #endif
332
333
334
335 #ifdef INCLUDE_CLIENT_APIS
336 #       define CLIENTONLY(x) x
337 #else 
338 #       define CLIENTONLY(x)
339 #endif
340
341 //@}
342 #endif
343