config.hpp File Reference

Main program configuration file. More...

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros
Compile time configuration options
The Linux SDK for UPnP Devices contains some compile-time parameters that effect the behavior of the SDK. All configuration options are located in src/inc/config.hpp.
#define	THREAD_IDLE_TIME   5000
	The THREAD_IDLE_TIME constant determines when a thread will be removed from the thread pool and returned to the operating system. When a thread in the thread pool has been idle for this number of milliseconds the thread will be released from the thread pool. The default value is 5000 milliseconds (5 seconds).
#define	JOBS_PER_THREAD   10
	The JOBS_PER_THREAD constant determines when a new thread will be allocated to the thread pool inside the SDK. The thread pool will try and maintain this jobs/thread ratio. When the jobs/thread ratio becomes greater than this, then a new thread (up to the max) will be allocated to the thread pool. The default ratio is 10 jobs/thread.
#define	MIN_THREADS   2
	The MIN_THREADS constant defines the minimum number of threads the thread pool inside the SDK will create. The thread pool will always have this number of threads. These threads are used for both callbacks into applications built on top of the SDK and also for making connections to other control points and devices. This number includes persistent threads. The default value is two threads.
#define	MAX_THREADS   12
	The MAX_THREADS constant defines the maximum number of threads the thread pool inside the SDK will create. These threads are used for both callbacks into applications built on top of the library and also for making connections to other control points and devices. It is not recommended that this value be below 10, since the threads are necessary for correct operation. This value can be increased for greater performance in operation at the expense of greater memory overhead. The default value is 12.
#define	THREAD_STACK_SIZE   (size_t)0
	The THREAD_STACK_SIZE constant defines the minimum stack size (in bytes) allocated for the stack of each thread the thread pool inside the SDK will create. These threads are used for both callbacks into applications built on top of the library and also for making connections to other control points and devices. This value will not be used if it is lower than ITHREAD_STACK_MIN or greater than a system-imposed limit. This value can be used to lower memory overhead in embedded systems. The default value is 0 (so it is not used by default).
#define	MAX_JOBS_TOTAL   100
	The MAX_JOBS_TOTAL constant determines the maximum number of jobs that can be queued. If this limit is reached further jobs will be thrown to avoid memory exhaustion. The default value 100. (Added by Axis.)
#define	MAX_SUBSCRIPTION_QUEUED_EVENTS   10
	The MAX_SUBSCRIPTION_QUEUED_EVENTS determines the maximum number of events which can be queued for a given subscription before events begin to be discarded. This limits the amount of memory used for a non-responding subscribed entity.
#define	MAX_SUBSCRIPTION_EVENT_AGE   30
	The MAX_SUBSCRIPTION__EVENT_AGE determines the maximum number of seconds which an event can spend on a subscription queue (waiting for the event at the head of the queue to be communicated). This parameter will have no effect in most situations with the default (low) value of MAX_SUBSCRIPTION_QUEUED_EVENTS. However, if MAX_SUBSCRIPTION_QUEUED_EVENTS is set to a high value, the AGE parameter will allow pruning the queue in good conformance with the UPnP Device Architecture standard, at the price of higher potential memory use.
#define	DEFAULT_SOAP_CONTENT_LENGTH   16000
	SOAP messages will read at most DEFAULT_SOAP_CONTENT_LENGTH bytes. This prevents devices that have a misbehaving web server to send a large amount of data to the control point causing it to crash. This can be adjusted dynamically with UpnpSetMaxContentLength.
#define	NUM_SSDP_COPY   2
	This configuration parameter determines how many copies of each SSDP advertisement and search packets will be sent. By default it will send two copies of every packet.
#define	SSDP_PAUSE   100u
	This configuration parameter determines the pause between identical SSDP advertisement and search packets. The pause is measured in milliseconds and defaults to 100.
#define	WEB_SERVER_BUF_SIZE   (size_t)(1024 * 1024)
	This configuration parameter sets the maximum buffer size for the webserver. The default value is 1MB.
#define	WEB_SERVER_CONTENT_LANGUAGE   ""
	This configuration parameter sets the value of the Content-Language header for the webserver. Thanks to this parameter, the use can advertize the language used by the device in the description (friendlyName) and presentation steps of UPnP. The default value is empty string so no Content-Language header is added.
#define	AUTO_RENEW_TIME   10
	The AUTO_RENEW_TIME is the time, in seconds, before a subscription expires that the SDK automatically resubscribes. The default value is 10 seconds. Setting this value too low can result in the subscription renewal not making it to the device in time, causing the subscription to timeout. In order to avoid continually resubscribing the minimum subscription time is five seconds more than the auto renew time.
#define	CP_MINIMUM_SUBSCRIPTION_TIME   (AUTO_RENEW_TIME + 5)
	The CP_MINIMUM_SUBSCRIPTION_TIME is the minimum subscription time allowed for a control point using the SDK. Subscribing for less than this time automatically results in a subscription for this amount. The default value is 5 seconds more than the AUTO_RENEW_TIME, or 15 seconds.
#define	MAX_SEARCH_TIME   80
	The MAX_SEARCH_TIME is the maximum time allowed for an SSDP search by a control point. Searching for greater than this time automatically results in a search for this amount. The default value is 80 seconds.
#define	MIN_SEARCH_TIME   2
	The MIN_SEARCH_TIME is the minimumm time allowed for an SSDP search by a control point. Searching for less than this time automatically results in a search for this amount. The default value is 2 seconds.
#define	AUTO_ADVERTISEMENT_TIME   30
	The AUTO_ADVERTISEMENT_TIME is the time, in seconds, before an device advertisements expires before a renewed advertisement is sent. The default time is 30 seconds.
#define	SSDP_PACKET_DISTRIBUTE   1
	The SSDP_PACKET_DISTRIBUTE enables the SSDP packets to be sent at an interval equal to half of the expiration time of SSDP packets minus the AUTO_ADVERTISEMENT_TIME. This is used to increase the probability of SSDP packets reaching to control points. It is recommended that this flag be turned on for embedded wireless devices.
#define	GENA_NOTIFICATION_SENDING_TIMEOUT   HTTP_DEFAULT_TIMEOUT
	The GENA_NOTIFICATION_SENDING_TIMEOUT specifies the number of seconds to wait for sending GENA notifications to the Control Point.
#define	GENA_NOTIFICATION_ANSWERING_TIMEOUT   HTTP_DEFAULT_TIMEOUT
	The GENA_NOTIFICATION_ANSWERING_TIMEOUT specifies the number of seconds to wait for receiving the answer to a GENA notification from the Control Point.
Other debugging features
The UPnP SDK contains other features to aid in debugging: see Compa/inc/upnpdebug.hpp.
#define	DEBUG_ALL   1
	Debug feature.
#define	DEBUG_SSDP   0
	Debug feature.
#define	DEBUG_SOAP   0
	Debug feature.
#define	DEBUG_GENA   0
	Debug feature.
#define	DEBUG_TPOOL   0
	Debug feature.
#define	DEBUG_MSERV   0
	Debug feature.
#define	DEBUG_DOM   0
	Debug feature.
#define	DEBUG_HTTP   0
	Debug feature.
#define	DEBUG_API   0
	Debug feature.

Detailed Description

Main program configuration file.

Definition in file config.hpp.

Macro Definition Documentation

THREAD_IDLE_TIME

#define THREAD_IDLE_TIME   5000

The THREAD_IDLE_TIME constant determines when a thread will be removed from the thread pool and returned to the operating system. When a thread in the thread pool has been idle for this number of milliseconds the thread will be released from the thread pool. The default value is 5000 milliseconds (5 seconds).

Definition at line 58 of file config.hpp.

JOBS_PER_THREAD

#define JOBS_PER_THREAD   10

The JOBS_PER_THREAD constant determines when a new thread will be allocated to the thread pool inside the SDK. The thread pool will try and maintain this jobs/thread ratio. When the jobs/thread ratio becomes greater than this, then a new thread (up to the max) will be allocated to the thread pool. The default ratio is 10 jobs/thread.

Definition at line 67 of file config.hpp.

MIN_THREADS

#define MIN_THREADS   2

The MIN_THREADS constant defines the minimum number of threads the thread pool inside the SDK will create. The thread pool will always have this number of threads. These threads are used for both callbacks into applications built on top of the SDK and also for making connections to other control points and devices. This number includes persistent threads. The default value is two threads.

Definition at line 77 of file config.hpp.

MAX_THREADS

#define MAX_THREADS   12

The MAX_THREADS constant defines the maximum number of threads the thread pool inside the SDK will create. These threads are used for both callbacks into applications built on top of the library and also for making connections to other control points and devices. It is not recommended that this value be below 10, since the threads are necessary for correct operation. This value can be increased for greater performance in operation at the expense of greater memory overhead. The default value is 12.

Definition at line 88 of file config.hpp.

THREAD_STACK_SIZE

#define THREAD_STACK_SIZE   (size_t)0

The THREAD_STACK_SIZE constant defines the minimum stack size (in bytes) allocated for the stack of each thread the thread pool inside the SDK will create. These threads are used for both callbacks into applications built on top of the library and also for making connections to other control points and devices. This value will not be used if it is lower than ITHREAD_STACK_MIN or greater than a system-imposed limit. This value can be used to lower memory overhead in embedded systems. The default value is 0 (so it is not used by default).

Definition at line 100 of file config.hpp.

MAX_JOBS_TOTAL

#define MAX_JOBS_TOTAL   100

The MAX_JOBS_TOTAL constant determines the maximum number of jobs that can be queued. If this limit is reached further jobs will be thrown to avoid memory exhaustion. The default value 100. (Added by Axis.)

Definition at line 107 of file config.hpp.

MAX_SUBSCRIPTION_QUEUED_EVENTS

#define MAX_SUBSCRIPTION_QUEUED_EVENTS   10

The MAX_SUBSCRIPTION_QUEUED_EVENTS determines the maximum number of events which can be queued for a given subscription before events begin to be discarded. This limits the amount of memory used for a non-responding subscribed entity.

Definition at line 115 of file config.hpp.

MAX_SUBSCRIPTION_EVENT_AGE

#define MAX_SUBSCRIPTION_EVENT_AGE   30

The MAX_SUBSCRIPTION__EVENT_AGE determines the maximum number of seconds which an event can spend on a subscription queue (waiting for the event at the head of the queue to be communicated). This parameter will have no effect in most situations with the default (low) value of MAX_SUBSCRIPTION_QUEUED_EVENTS. However, if MAX_SUBSCRIPTION_QUEUED_EVENTS is set to a high value, the AGE parameter will allow pruning the queue in good conformance with the UPnP Device Architecture standard, at the price of higher potential memory use.

Definition at line 127 of file config.hpp.

DEFAULT_SOAP_CONTENT_LENGTH

#define DEFAULT_SOAP_CONTENT_LENGTH   16000

SOAP messages will read at most DEFAULT_SOAP_CONTENT_LENGTH bytes. This prevents devices that have a misbehaving web server to send a large amount of data to the control point causing it to crash. This can be adjusted dynamically with UpnpSetMaxContentLength.

Definition at line 135 of file config.hpp.

NUM_SSDP_COPY

#define NUM_SSDP_COPY   2

This configuration parameter determines how many copies of each SSDP advertisement and search packets will be sent. By default it will send two copies of every packet.

Definition at line 142 of file config.hpp.

SSDP_PAUSE

#define SSDP_PAUSE   100u

This configuration parameter determines the pause between identical SSDP advertisement and search packets. The pause is measured in milliseconds and defaults to 100.

Definition at line 149 of file config.hpp.

WEB_SERVER_BUF_SIZE

#define WEB_SERVER_BUF_SIZE   (size_t)(1024 * 1024)

This configuration parameter sets the maximum buffer size for the webserver. The default value is 1MB.

Definition at line 155 of file config.hpp.

WEB_SERVER_CONTENT_LANGUAGE

#define WEB_SERVER_CONTENT_LANGUAGE   ""

This configuration parameter sets the value of the Content-Language header for the webserver. Thanks to this parameter, the use can advertize the language used by the device in the description (friendlyName) and presentation steps of UPnP. The default value is empty string so no Content-Language header is added.

Definition at line 164 of file config.hpp.

AUTO_RENEW_TIME

#define AUTO_RENEW_TIME   10

The AUTO_RENEW_TIME is the time, in seconds, before a subscription expires that the SDK automatically resubscribes. The default value is 10 seconds. Setting this value too low can result in the subscription renewal not making it to the device in time, causing the subscription to timeout. In order to avoid continually resubscribing the minimum subscription time is five seconds more than the auto renew time.

Definition at line 174 of file config.hpp.

CP_MINIMUM_SUBSCRIPTION_TIME

#define CP_MINIMUM_SUBSCRIPTION_TIME   (AUTO_RENEW_TIME + 5)

The CP_MINIMUM_SUBSCRIPTION_TIME is the minimum subscription time allowed for a control point using the SDK. Subscribing for less than this time automatically results in a subscription for this amount. The default value is 5 seconds more than the AUTO_RENEW_TIME, or 15 seconds.

Definition at line 183 of file config.hpp.

MAX_SEARCH_TIME

#define MAX_SEARCH_TIME   80

The MAX_SEARCH_TIME is the maximum time allowed for an SSDP search by a control point. Searching for greater than this time automatically results in a search for this amount. The default value is 80 seconds.

Definition at line 190 of file config.hpp.

MIN_SEARCH_TIME

#define MIN_SEARCH_TIME   2

The MIN_SEARCH_TIME is the minimumm time allowed for an SSDP search by a control point. Searching for less than this time automatically results in a search for this amount. The default value is 2 seconds.

Definition at line 197 of file config.hpp.

AUTO_ADVERTISEMENT_TIME

#define AUTO_ADVERTISEMENT_TIME   30

The AUTO_ADVERTISEMENT_TIME is the time, in seconds, before an device advertisements expires before a renewed advertisement is sent. The default time is 30 seconds.

Definition at line 204 of file config.hpp.

SSDP_PACKET_DISTRIBUTE

#define SSDP_PACKET_DISTRIBUTE   1

The SSDP_PACKET_DISTRIBUTE enables the SSDP packets to be sent at an interval equal to half of the expiration time of SSDP packets minus the AUTO_ADVERTISEMENT_TIME. This is used to increase the probability of SSDP packets reaching to control points. It is recommended that this flag be turned on for embedded wireless devices.

Definition at line 214 of file config.hpp.

GENA_NOTIFICATION_SENDING_TIMEOUT

#define GENA_NOTIFICATION_SENDING_TIMEOUT   HTTP_DEFAULT_TIMEOUT

The GENA_NOTIFICATION_SENDING_TIMEOUT specifies the number of seconds to wait for sending GENA notifications to the Control Point.

This timeout will be used to know how many seconds GENA notification threads will wait to write on the socket to send the notification. By putting a lower value than HTTP_DEFAULT_TIMEOUT, the thread will not wait too long and will return quickly if writing is impossible. This is very useful as some Control Points disconnect from the network without unsubscribing as a result if HTTP_DEFAULT_TIMEOUT is used, all the GENA threads will be blocked to send notifications to those disconnected Control Points until the subscription expires.

Definition at line 229 of file config.hpp.

GENA_NOTIFICATION_ANSWERING_TIMEOUT

#define GENA_NOTIFICATION_ANSWERING_TIMEOUT   HTTP_DEFAULT_TIMEOUT

The GENA_NOTIFICATION_ANSWERING_TIMEOUT specifies the number of seconds to wait for receiving the answer to a GENA notification from the Control Point.

This timeout will be used to know how many seconds GENA notification threads will wait on the socket to read for an answer from the CP. By putting a lower value than HTTP_DEFAULT_TIMEOUT, the thread will not wait too long and will return quickly if there is no answer from the CP. This is very useful as some Control Points disconnect from the network without unsubscribing and if HTTP_DEFAULT_TIMEOUT is used, all the GENA threads will be blocked to wait for an answer from those disconnected Control Points until the subscription expires. However, it should be noted that UDA specifies a value of 30s for waiting the CP's answer.

Definition at line 246 of file config.hpp.

DEBUG_ALL

#define DEBUG_ALL   1

Debug feature.

Definition at line 279 of file config.hpp.

DEBUG_SSDP

#define DEBUG_SSDP   0

Debug feature.

Definition at line 280 of file config.hpp.

DEBUG_SOAP

#define DEBUG_SOAP   0

Debug feature.

Definition at line 281 of file config.hpp.

DEBUG_GENA

#define DEBUG_GENA   0

Debug feature.

Definition at line 282 of file config.hpp.

DEBUG_TPOOL

#define DEBUG_TPOOL   0

Debug feature.

Definition at line 283 of file config.hpp.

DEBUG_MSERV

#define DEBUG_MSERV   0

Debug feature.

Definition at line 284 of file config.hpp.

DEBUG_DOM

#define DEBUG_DOM   0

Debug feature.

Definition at line 285 of file config.hpp.

DEBUG_HTTP

#define DEBUG_HTTP   0

Debug feature.

Definition at line 286 of file config.hpp.

DEBUG_API

#define DEBUG_API   0

Debug feature.

Definition at line 287 of file config.hpp.