| [Top] | [Contents] | [Index] | [ ? ] |
This manual documents GNU libmicrohttpd version 0.3.1, last updated 26 May 2008. It is built upon the documentation in the header file ‘microhttpd.h’.
Copyright © 2007, 2008 Christian Grothoff
Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.2 or any later version published by the Free Software Foundation; with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free Documentation License".
GNU libmicrohttpd is a GNU package.
| 1. Introduction | ||
| 2. Constants | ||
| 3. Structures type definition | ||
| 4. Callback functions definition | ||
| 5. Starting and stopping the server | ||
6. Implementing external select | ||
| 7. Handling requests | ||
| 8. Building answers to responses | Building responses to requests. | |
9. Adding a POST processor | ||
Appendices | ||
|---|---|---|
| Copying | The GNU Lesser General Public License says how you can copy and share some parts of `libmicrohttpd'. | |
| GNU-FDL | The GNU Free Documentation License says how you can copy and share the documentation of `libmicrohttpd'. | |
Indices | ||
| Concept Index | Index of concepts and programs. | |
| Function and Data Index | Index of functions, variables and data types. | |
| Type Index | Index of data types. | |
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
All symbols defined in the public API start with MHD_. MHD
is a small HTTP daemon library. As such, it does not have any API
for logging errors (you can only enable or disable logging to stderr).
Also, it may not support all of the HTTP features directly, where
applicable, portions of HTTP may have to be handled by clients of the
library.
The library is supposed to handle everything that it must handle
(because the API would not allow clients to do this), such as basic
connection management; however, detailed interpretations of headers —
such as range requests — and HTTP methods are left to clients. The
library does understand HEAD and will only send the headers of
the response and not the body, even if the client supplied a body. The
library also understands headers that control connection management
(specifically, Connection: close and Expect: 100 continue
are understood and handled automatically).
MHD understands POST data and is able to decode certain
formats (at the moment only application/x-www-form-urlencoded
and multipart/form-data) using the post processor API. The
data stream of a POST is also provided directly to the main
application, so unsupported encodings could still be processed, just
not conveniently by MHD.
The header file defines various constants used by the HTTP protocol. This does not mean that MHD actually interprets all of these values. The provided constants are exported as a convenience for users of the library. MHD does not verify that transmitted HTTP headers are part of the standard specification; users of the library are free to define their own extensions of the HTTP standard and use those with MHD.
All functions are guaranteed to be completely reentrant and thread-safe. MHD checks for allocation failures and tries to recover gracefully (for example, by closing the connection). Additionally, clients can specify resource limits on the overall number of connections, number of connections per IP address and memory used per connection to avoid resource exhaustion.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
Options for the MHD daemon.
Note that if neither MHD_USER_THREAD_PER_CONNECTION nor
MHD_USE_SELECT_INTERNALLY are used, the client wants control over
the process and will call the appropriate microhttpd callbacks.
Starting the daemon may also fail if a particular option is not implemented or not supported on the target platform (i.e. no support for SSL, threads or IPv6).
MHD_NO_FLAGNo options selected.
MHD_USE_DEBUGRun in debug mode. If this flag is used, the library should print error
messages and warnings to stderr. Note that MHD also needs to be
compiled with the configure option --enable-messages for this
run-time option to have any effect.
MHD_USE_SSLRun in https mode (this is not yet supported).
MHD_USE_THREAD_PER_CONNECTIONRun using one thread per connection.
MHD_USE_SELECT_INTERNALLYRun using an internal thread doing SELECT.
MHD_USE_IPv6Run using the IPv6 protocol (otherwise, MHD will just support IPv4).
MHD_USE_PEDANTIC_CHECKSBe pedantic about the protocol (as opposed to as tolerant as possible).
Specifically, at the moment, this flag causes MHD to reject HTTP
1.1 connections without a Host header. This is required by the
standard, but of course in violation of the “be as liberal as possible
in what you accept” norm. It is recommended to turn this ON
if you are testing clients against MHD, and OFF in
production.
MHD options. Passed in the varargs portion of
MHD_start_daemon().
MHD_OPTION_ENDNo more options / last option. This is used to terminate the VARARGs list.
MHD_OPTION_CONNECTION_MEMORY_LIMITMaximum memory size per connection (followed by an unsigned int).
MHD_OPTION_CONNECTION_LIMITMaximum number of concurrenct connections to accept (followed by an
unsigned int).
MHD_OPTION_CONNECTION_TIMEOUTAfter how many seconds of inactivity should a connection automatically
be timed out? (followed by an unsigned int; use zero for no
timeout).
MHD_OPTION_NOTIFY_COMPLETEDRegister a function that should be called whenever a request has been
completed (this can be used for application-specific clean up).
Requests that have never been presented to the application (via
MHD_AccessHandlerCallback()) will not result in
notifications.
This option should be followed by TWO pointers. First a
pointer to a function of type MHD_RequestCompletedCallback()
and second a pointer to a closure to pass to the request completed
callback. The second pointer maybe NULL.
MHD_OPTION_PER_IP_CONNECTION_LIMITLimit on the number of (concurrent) connections made to the
server from the same IP address. Can be used to prevent one
IP from taking over all of the allowed connections. If the
same IP tries to establish more than the specified number of
connections, they will be immediately rejected. The option
should be followed by an unsigned int. The default is
zero, which means no limit on the number of connections
from the same IP address.
The MHD_ValueKind specifies the source of the key-value pairs in
the HTTP protocol.
MHD_RESPONSE_HEADER_KINDResponse header.
MHD_HEADER_KINDHTTP header.
MHD_COOKIE_KINDCookies. Note that the original HTTP header containing the cookie(s) will still be available and intact.
MHD_POSTDATA_KINDPOST data. This is available only if a content encoding
supported by MHD is used (currently only URL encoding), and
only if the posted content fits within the available memory pool. Note
that in that case, the upload data given to the
MHD_AccessHandlerCallback() will be empty (since it has
already been processed).
MHD_GET_ARGUMENT_KINDGET (URI) arguments.
MHD_HEADER_KINDHTTP footer (only for http 1.1 chunked encodings).
The MHD_RequestTerminationCode specifies reasons why a request
has been terminated (or completed).
MHD_REQUEST_TERMINATED_COMPLETED_OKWe finished sending the response.
MHD_REQUEST_TERMINATED_WITH_ERRORError handling the connection (resources exhausted, other side closed connection, application error accepting request, etc.)
MHD_REQUEST_TERMINATED_TIMEOUT_REACHEDNo activity on the connection for the number of seconds specified using
MHD_OPTION_CONNECTION_TIMEOUT.
MHD_REQUEST_TERMINATED_DAEMON_SHUTDOWNWe had to close the session since MHD was being shut down.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
Handle for the daemon (listening on a socket for HTTP traffic).
Handle for a connection / HTTP request. With HTTP/1.1, multiple requests can be run over the same connection. However, MHD will only show one request per TCP connection to the client at any given time.
Handle for a response.
Handle for POST processing.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
Invoked in the context of a connection to allow or deny a client to
connect. This callback return MHD_YES if connection is allowed,
MHD_NO if not.
custom value selected at callback registration time;
address information from the client;
length of the address information.
Invoked in the context of a connection to answer a request from the
client. This callback must call MHD functions (example: the
MHD_Response ones) to provide content to give back to the client
and return an HTTP status code (i.e. 200 for OK, 404,
etc.).
Adding a POST processor, for details on how to code this callback.
Must return MHD_YES if the connection was handled successfully,
MHD_NO if the socket must be closed due to a serious error while
handling the request
custom value selected at callback registration time;
the URL requested by the client;
the HTTP method used by the client (GET, PUT,
DELETE, POST, etc.);
the HTTP version string (i.e. HTTP/1.1);
the data being uploaded (excluding headers):
POST that fits into memory and that is encoded with a
supported encoding, the POST data will NOT be given in
upload_data and is instead available as part of
MHD_get_connection_values();
POST data will be made available
incrementally in upload_data;
set initially to the size of the upload_data provided; this
callback must update this value to the number of bytes NOT
processed; unless external select is used, the callback maybe
required to process at least some data. If the callback fails to
process data in multi-threaded or internal-select mode and if the
read-buffer is already at the maximum size that MHD is willing to
use for reading (about half of the maximum amount of memory allowed
for the connection), then MHD will abort handling the connection
and return an internal server error to the client. In order to
avoid this, clients must be able to process upload data incrementally
and reduce the value of upload_data_size.
reference to a pointer, initially set to NULL, that this callback can
set to some address and that will be preserved by MHD for future
calls for this request;
since the access handler may be called many times (i.e., for a
PUT/POST operation with plenty of upload data) this allows
the application to easily associate some request-specific state;
if necessary, this state can be cleaned up in the global
MHD_RequestCompletedCallback (which can be set with the
MHD_OPTION_NOTIFY_COMPLETED).
Signature of the callback used by MHD to notify the application about completed requests.
custom value selected at callback registration time;
connection handle;
value as set by the last call to the
MHD_AccessHandlerCallback;
reason for request termination see MHD_OPTION_NOTIFY_COMPLETED.
Iterator over key-value pairs. This iterator can be used to iterate
over all of the cookies, headers, or POST-data fields of a
request, and also to iterate over the headers that have been added to a
response.
Return MHD_YES to continue iterating, MHD_NO to abort the
iteration.
Callback used by MHD in order to obtain content. The callback has to copy at most max bytes of content into buf. The total number of bytes that has been placed into buf should be returned.
Note that returning zero will cause MHD to try again, either
“immediately” if in multi-threaded mode (in which case the callback
may want to do blocking operations) or in the next round if MHD_run is
used. Returning zero for a daemon that runs in internal
select() mode is an error (since it would result in busy
waiting) and will cause the program to be aborted (abort()).
custom value selected at callback registration time;
position in the datastream to access; note that if an
MHD_Response object is re-used, it is possible for the same
content reader to be queried multiple times for the same data; however,
if an MHD_Response is not re-used, MHD guarantees that
pos will be the sum of all non-negative return values obtained
from the content reader so far.
Return -1 on error (MHD will no longer try to read content and
instead close the connection with the client).
This method is called by MHD if we are done with a content reader. It should be used to free resources associated with the content reader.
Iterator over key-value pairs where the value maybe made available in
increments and/or may not be zero-terminated. Used for processing
POST data.
custom value selected at callback registration time;
type of the value;
zero-terminated key for the value;
name of the uploaded file, NULL if not known;
mime-type of the data, NULL if not known;
encoding of the data, NULL if not known;
pointer to size bytes of data at the specified offset;
offset of data in the overall value;
number of bytes in data available.
Return MHD_YES to continue iterating, MHD_NO to abort the
iteration.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
Start a webserver on the given port.
OR-ed combination of MHD_FLAG values;
port to bind to;
callback to call to check which clients will be allowed to connect; you
can pass NULL in which case connections from any IP will be
accepted;
extra argument to apc;
default handler for all URIs;
extra argument to dh.
Additional arguments are a list of options (type-value pairs,
terminated with MHD_OPTION_END). It is mandatory to use
MHD_OPTION_END as last argument, even when there are no
additional arguments.
Return NULL on error, handle to daemon on success.
Shutdown an HTTP daemon.
Run webserver operations (without blocking unless in client callbacks).
This method should be called by clients in combination with
MHD_get_fdset() if the client-controlled select()
method is used.
Return MHD_YES on success, MHD_NO if this daemon was not
started with the right options for this call.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
select Obtain the select() sets for this daemon. The daemon's socket
is added to read_fd_set. The list of currently existent
connections is scanned and their file descriptors added to the correct
set.
see (libc), for details on file descriptor sets.
After the call completed successfully: the variable referenced by max_fd references the file descriptor with highest integer identifier. The variable must be set to zero before invoking this function.
Return MHD_YES on success, MHD_NO if: the arguments are
invalid (example: NULL pointers); this daemon was not started with
the right options for this call.
Obtain timeout value for select for this daemon (only needed if
connection timeout is used). The returned value is how long
select() should at most block, not the timeout value set for
connections.
set to the timeout (in milliseconds).
Return MHD_YES on success, MHD_NO if timeouts are not used
(or no connections exist that would necessiate the use of a timeout
right now).
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
Get all the headers matching kind from the request.
The iterator callback is invoked once for each header, with
iterator_cls as first argument. Return the number of entries
iterated over; this can be less than the number of headers if, while
iterating, iterator returns MHD_NO.
iterator can be NULL: in this case this function just counts
and returns the number of headers.
Get a particular header value. If multiple values match the kind,
return one of them (the “first”, whatever that means). key must
reference a zero-terminated ASCII-coded string representing the
header to look for: it is compared against the headers using
strcasecmp(), so case is ignored. Return NULL if no such
item was found.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
Response objects handling by MHD is asynchronous with respect to the
application execution flow. Instances of the MHD_Response
structure are not associated to a daemon and neither to a client
connection: they are managed with reference counting.
In the simplest case: we allocate a new MHD_Response structure
for each response, we use it once and finally we destroy it.
MHD allows more efficient resources usages.
Example: we allocate a new MHD_Response structure for each
response kind, we use it every time we have to give that
responce and we finally destroy it only when the daemon shuts down.
| 8.1 Enqueuing a response | ||
| 8.2 Creating response objects | Creating a response object. | |
| 8.3 Adding headers to a response | ||
| 8.4 Inspecting a response object |
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
Queue a response to be transmitted to the client as soon as possible (increment the reference counter).
the connection identifying the client;
HTTP status code (i.e. 200 for OK);
response to transmit.
Return MHD_YES on success or if message has been queued. Return
MHD_NO: if arguments are invalid (example: NULL pointer); on
error (i.e. reply already sent).
Destroy a response object and associated resources (decrement the reference counter). Note that MHD may keep some of the resources around if the response is still in the queue for some clients, so the memory may not necessarily be freed immediatley.
An explanation of reference counting(1):
MHD_Response object is allocated:
struct MHD_Response * response = MHD_create_response_from_data(...); /* here: reference counter = 1 */ |
MHD_Response object is enqueued in a MHD_Connection:
MHD_queue_response(connection, , response); /* here: reference counter = 2 */ |
MHD_destroy_response(response); /* here: reference counter = 1 */ |
MHD_destroy_response(): the counter's value drops to zero and
the MHD_Response object is released.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
Create a response object. The response object can be extended with header information and then it can be used any number of times.
size of the data portion of the response, -1 for unknown;
preferred block size for querying crc (advisory only, MHD may still call crc using smaller chunks); this is essentially the buffer size used for IO, clients should pick a value that is appropriate for IO and memory performance requirements;
callback to use to obtain response data;
extra argument to crc;
callback to call to free crc_cls resources.
Return NULL on error (i.e. invalid arguments, out of memory).
Create a response object. The response object can be extended with header information and then it can be used any number of times.
size of the data portion of the response;
the data itself;
if true: MHD should free data when done;
if true: MHD allocates a block of memory and use it to make a copy of
data embedded in the returned MHD_Response structure;
handling of the embedded memory is responsibility of MHD; data
can be released anytime after this call returns.
Return NULL on error (i.e. invalid arguments, out of memory).
Example: create a response from a statically allocated string:
const char * data = "<html><body><p>Error!</p></body></html>";
struct MHD_Connection * connection = ...;
struct MHD_Response * response;
response = MHD_create_response_from_data(strlen(data), data,
MHD_NO, MHD_NO);
MHD_queue_response(connection, 404, response);
MHD_destroy_response(response);
|
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
Add a header line to the response. The strings referenced by header and content must be zero-terminated and they are duplicated into memory blocks embedded in response.
Notice that the strings must not hold newlines, carriage returns or tab chars.
Return MHD_NO on error (i.e. invalid header or content format or
memory allocation error).
Delete a header line from the response. Return MHD_NO on error
(arguments are invalid or no such header known).
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
Get all of the headers added to a response.
Invoke the iterator callback for each header in the response,
using iterator_cls as first argument. Return number of entries
iterated over. iterator can be NULL: in this case the function
just counts headers.
iterator should not modify the its key and value arguments, unless we know what we are doing.
Find and return a pointer to the value of a particular header from the
response. key must reference a zero-terminated string
representing the header to look for. The search is case sensitive.
Return NULL if header does not exist or key is NULL.
We should not modify the value, unless we know what we are doing.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
POST processor 9.1 Programming interface for the POST processor |
MHD provides the post procesor API to make it easier for applications to
parse the data of a client's POST request: the
MHD_AccessHandlerCallback will be invoked multiple times to
process data as it arrives; at each invocation a new chunk of data must
be processed. The arguments upload_data and upload_data_size
are used to reference the chunk of data.
When MHD_AccessHandlerCallback is invoked for a new connection:
its *con_cls argument is set to NULL. When POST
data comes in the upload buffer it is mandatory to use the
con_cls to store a reference to per-connection data. The fact
that the pointer was initially NULL can be used to detect that
this is a new request.
One method to detect that a new connection was established is
to set *con_cls to anunused integer:
int
access_handler (void *cls,
struct MHD_Connection * connection,
const char *url,
const char *method, const char *version,
const char *upload_data, unsigned int *upload_data_size,
void **con_cls)
{
static int old_connection_marker;
int new_connection = (MYNULL == *con_cls);
if (new_connection)
{
/* new connection with POST */
*con_cls = &old_connection_marker;
}
...
}
|
In contrast to the previous example, for POST requests in particular,
it is more common to use the value of *con_cls to keep track of
actual state used during processing, such as the post processor (or a
struct containing a post processor):
int
access_handler (void *cls,
struct MHD_Connection * connection,
const char *url,
const char *method, const char *version,
const char *upload_data, unsigned int *upload_data_size,
void **con_cls)
{
struct MHD_PostProcessor * pp = *con_cls;
if (pp == NULL)
{
pp = MHD_create_post_processor(connection, ...);
*con_cls = pp;
return MHD_YES;
}
if (*upload_data_size)
{
MHD_post_process(pp, upload_data, *upload_data_size);
*upload_data_size = 0;
return MHD_YES;
}
else
{
MHD_destroy_post_processor(pp);
return MHD_queue_response(...);
}
}
|
Note that the callback from MHD_OPTION_NOTIFY_COMPLETED
should be used to destroy the post processor. This cannot be
done inside of the access handler since the connection may not
always terminate normally.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
POST processor Create a PostProcessor. A PostProcessor can be used to (incrementally)
parse the data portion of a POST request.
the connection on which the POST is happening (used to determine
the POST format);
maximum number of bytes to use for internal buffering (used only for the parsing, specifically the parsing of the keys). A tiny value (256-1024) should be sufficient; do NOT use a value smaller than 256;
iterator to be called with the parsed data; must NOT be
NULL;
custom value to be used as first argument to iterator.
Return NULL on error (out of memory, unsupported encoding), otherwise
a PP handle.
Parse and process POST data. Call this function when POST
data is available (usually during an MHD_AccessHandlerCallback)
with the upload_data and upload_data_size. Whenever
possible, this will then cause calls to the
MHD_IncrementalKeyValueIterator.
the post processor;
post_data_len bytes of POST data;
length of post_data.
Return MHD_YES on success, MHD_NO on error
(out-of-memory, iterator aborted, parse error).
Release PostProcessor resources. After this function is being called, the PostProcessor is guaranteed to no longer call its iterator. There is no special call to the iterator to indicate the end of the post processing stream. After destroying the PostProcessor, the programmer should perform any necessary work to complete the processing of the iterator.
Return MHD_YES if processing completed nicely, MHD_NO
if there were spurious characters or formatting problems with
the post request. It is common to ignore the return value
of this function.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
Version 2.1, February 1999
Copyright © 1991, 1999 Free Software Foundation, Inc. 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. [This is the first released version of the Lesser GPL. It also counts as the successor of the GNU Library Public License, version 2, hence the version number 2.1.] |
The licenses for most software are designed to take away your freedom to share and change it. By contrast, the GNU General Public Licenses are intended to guarantee your freedom to share and change free software—to make sure the software is free for all its users.
This license, the Lesser General Public License, applies to some specially designated software—typically libraries—of the Free Software Foundation and other authors who decide to use it. You can use it too, but we suggest you first think carefully about whether this license or the ordinary General Public License is the better strategy to use in any particular case, based on the explanations below.
When we speak of free software, we are referring to freedom of use, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for this service if you wish); that you receive source code or can get it if you want it; that you can change the software and use pieces of it in new free programs; and that you are informed that you can do these things.
To protect your rights, we need to make restrictions that forbid distributors to deny you these rights or to ask you to surrender these rights. These restrictions translate to certain responsibilities for you if you distribute copies of the library or if you modify it.
For example, if you distribute copies of the library, whether gratis or for a fee, you must give the recipients all the rights that we gave you. You must make sure that they, too, receive or can get the source code. If you link other code with the library, you must provide complete object files to the recipients, so that they can relink them with the library after making changes to the library and recompiling it. And you must show them these terms so they know their rights.
We protect your rights with a two-step method: (1) we copyright the library, and (2) we offer you this license, which gives you legal permission to copy, distribute and/or modify the library.
To protect each distributor, we want to make it very clear that there is no warranty for the free library. Also, if the library is modified by someone else and passed on, the recipients should know that what they have is not the original version, so that the original author's reputation will not be affected by problems that might be introduced by others.
Finally, software patents pose a constant threat to the existence of any free program. We wish to make sure that a company cannot effectively restrict the users of a free program by obtaining a restrictive license from a patent holder. Therefore, we insist that any patent license obtained for a version of the library must be consistent with the full freedom of use specified in this license.
Most GNU software, including some libraries, is covered by the ordinary GNU General Public License. This license, the GNU Lesser General Public License, applies to certain designated libraries, and is quite different from the ordinary General Public License. We use this license for certain libraries in order to permit linking those libraries into non-free programs.
When a program is linked with a library, whether statically or using a shared library, the combination of the two is legally speaking a combined work, a derivative of the original library. The ordinary General Public License therefore permits such linking only if the entire combination fits its criteria of freedom. The Lesser General Public License permits more lax criteria for linking other code with the library.
We call this license the Lesser General Public License because it does Less to protect the user's freedom than the ordinary General Public License. It also provides other free software developers Less of an advantage over competing non-free programs. These disadvantages are the reason we use the ordinary General Public License for many libraries. However, the Lesser license provides advantages in certain special circumstances.
For example, on rare occasions, there may be a special need to encourage the widest possible use of a certain library, so that it becomes a de-facto standard. To achieve this, non-free programs must be allowed to use the library. A more frequent case is that a free library does the same job as widely used non-free libraries. In this case, there is little to gain by limiting the free library to free software only, so we use the Lesser General Public License.
In other cases, permission to use a particular library in non-free programs enables a greater number of people to use a large body of free software. For example, permission to use the GNU C Library in non-free programs enables many more people to use the whole GNU operating system, as well as its variant, the GNU/Linux operating system.
Although the Lesser General Public License is Less protective of the users' freedom, it does ensure that the user of a program that is linked with the Library has the freedom and the wherewithal to run that program using a modified version of the Library.
The precise terms and conditions for copying, distribution and modification follow. Pay close attention to the difference between a “work based on the library” and a “work that uses the library”. The former contains code derived from the library, whereas the latter must be combined with the library in order to run.
A “library” means a collection of software functions and/or data prepared so as to be conveniently linked with application programs (which use some of those functions and data) to form executables.
The “Library”, below, refers to any such software library or work which has been distributed under these terms. A “work based on the Library” means either the Library or any derivative work under copyright law: that is to say, a work containing the Library or a portion of it, either verbatim or with modifications and/or translated straightforwardly into another language. (Hereinafter, translation is included without limitation in the term “modification”.)
“Source code” for a work means the preferred form of the work for making modifications to it. For a library, complete source code means all the source code for all modules it contains, plus any associated interface definition files, plus the scripts used to control compilation and installation of the library.
Activities other than copying, distribution and modification are not covered by this License; they are outside its scope. The act of running a program using the Library is not restricted, and output from such a program is covered only if its contents constitute a work based on the Library (independent of the use of the Library in a tool for writing it). Whether that is true depends on what the Library does and what the program that uses the Library does.
You may charge a fee for the physical act of transferring a copy, and you may at your option offer warranty protection in exchange for a fee.
(For example, a function in a library to compute square roots has a purpose that is entirely well-defined independent of the application. Therefore, Subsection 2d requires that any application-supplied function or table used by this function must be optional: if the application does not supply it, the square root function must still compute square roots.)
These requirements apply to the modified work as a whole. If identifiable sections of that work are not derived from the Library, and can be reasonably considered independent and separate works in themselves, then this License, and its terms, do not apply to those sections when you distribute them as separate works. But when you distribute the same sections as part of a whole which is a work based on the Library, the distribution of the whole must be on the terms of this License, whose permissions for other licensees extend to the entire whole, and thus to each and every part regardless of who wrote it.
Thus, it is not the intent of this section to claim rights or contest your rights to work written entirely by you; rather, the intent is to exercise the right to control the distribution of derivative or collective works based on the Library.
In addition, mere aggregation of another work not based on the Library with the Library (or with a work based on the Library) on a volume of a storage or distribution medium does not bring the other work under the scope of this License.
Once this change is made in a given copy, it is irreversible for that copy, so the ordinary GNU General Public License applies to all subsequent copies and derivative works made from that copy.
This option is useful when you wish to copy part of the code of the Library into a program that is not a library.
If distribution of object code is made by offering access to copy from a designated place, then offering equivalent access to copy the source code from the same place satisfies the requirement to distribute the source code, even though third parties are not compelled to copy the source along with the object code.
However, linking a “work that uses the Library” with the Library creates an executable that is a derivative of the Library (because it contains portions of the Library), rather than a “work that uses the library”. The executable is therefore covered by this License. Section 6 states terms for distribution of such executables.
When a “work that uses the Library” uses material from a header file that is part of the Library, the object code for the work may be a derivative work of the Library even though the source code is not. Whether this is true is especially significant if the work can be linked without the Library, or if the work is itself a library. The threshold for this to be true is not precisely defined by law.
If such an object file uses only numerical parameters, data structure layouts and accessors, and small macros and small inline functions (ten lines or less in length), then the use of the object file is unrestricted, regardless of whether it is legally a derivative work. (Executables containing this object code plus portions of the Library will still fall under Section 6.)
Otherwise, if the work is a derivative of the Library, you may distribute the object code for the work under the terms of Section 6. Any executables containing that work also fall under Section 6, whether or not they are linked directly with the Library itself.
You must give prominent notice with each copy of the work that the Library is used in it and that the Library and its use are covered by this License. You must supply a copy of this License. If the work during execution displays copyright notices, you must include the copyright notice for the Library among them, as well as a reference directing the user to the copy of this License. Also, you must do one of these things:
For an executable, the required form of the “work that uses the Library” must include any data and utility programs needed for reproducing the executable from it. However, as a special exception, the materials to be distributed need not include anything that is normally distributed (in either source or binary form) with the major components (compiler, kernel, and so on) of the operating system on which the executable runs, unless that component itself accompanies the executable.
It may happen that this requirement contradicts the license restrictions of other proprietary libraries that do not normally accompany the operating system. Such a contradiction means you cannot use both them and the Library together in an executable that you distribute.
If any portion of this section is held invalid or unenforceable under any particular circumstance, the balance of the section is intended to apply, and the section as a whole is intended to apply in other circumstances.
It is not the purpose of this section to induce you to infringe any patents or other property right claims or to contest validity of any such claims; this section has the sole purpose of protecting the integrity of the free software distribution system which is implemented by public license practices. Many people have made generous contributions to the wide range of software distributed through that system in reliance on consistent application of that system; it is up to the author/donor to decide if he or she is willing to distribute software through any other system and a licensee cannot impose that choice.
This section is intended to make thoroughly clear what is believed to be a consequence of the rest of this License.
Each version is given a distinguishing version number. If the Library specifies a version number of this License which applies to it and “any later version”, you have the option of following the terms and conditions either of that version or of any later version published by the Free Software Foundation. If the Library does not specify a license version number, you may choose any version ever published by the Free Software Foundation.
If you develop a new library, and you want it to be of the greatest possible use to the public, we recommend making it free software that everyone can redistribute and change. You can do so by permitting redistribution under these terms (or, alternatively, under the terms of the ordinary General Public License).
To apply these terms, attach the following notices to the library. It is safest to attach them to the start of each source file to most effectively convey the exclusion of warranty; and each file should have at least the “copyright” line and a pointer to where the full notice is found.
one line to give the library's name and an idea of what it does. Copyright (C) year name of author This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 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 Lesser General Public License for more details. You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. |
Also add information on how to contact you by electronic and paper mail.
You should also get your employer (if you work as a programmer) or your school, if any, to sign a “copyright disclaimer” for the library, if necessary. Here is a sample; alter the names:
Yoyodyne, Inc., hereby disclaims all copyright interest in the library `Frob' (a library for tweaking knobs) written by James Random Hacker. signature of Ty Coon, 1 April 1990 Ty Coon, President of Vice |
That's all there is to it!
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
Version 1.2, November 2002
Copyright © 2000,2001,2002 Free Software Foundation, Inc. 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. |
The purpose of this License is to make a manual, textbook, or other functional and useful document free in the sense of freedom: to assure everyone the effective freedom to copy and redistribute it, with or without modifying it, either commercially or noncommercially. Secondarily, this License preserves for the author and publisher a way to get credit for their work, while not being considered responsible for modifications made by others.
This License is a kind of “copyleft”, which means that derivative works of the document must themselves be free in the same sense. It complements the GNU General Public License, which is a copyleft license designed for free software.
We have designed this License in order to use it for manuals for free software, because free software needs free documentation: a free program should come with manuals providing the same freedoms that the software does. But this License is not limited to software manuals; it can be used for any textual work, regardless of subject matter or whether it is published as a printed book. We recommend this License principally for works whose purpose is instruction or reference.
This License applies to any manual or other work, in any medium, that contains a notice placed by the copyright holder saying it can be distributed under the terms of this License. Such a notice grants a world-wide, royalty-free license, unlimited in duration, to use that work under the conditions stated herein. The “Document”, below, refers to any such manual or work. Any member of the public is a licensee, and is addressed as “you”. You accept the license if you copy, modify or distribute the work in a way requiring permission under copyright law.
A “Modified Version” of the Document means any work containing the Document or a portion of it, either copied verbatim, or with modifications and/or translated into another language.
A “Secondary Section” is a named appendix or a front-matter section of the Document that deals exclusively with the relationship of the publishers or authors of the Document to the Document's overall subject (or to related matters) and contains nothing that could fall directly within that overall subject. (Thus, if the Document is in part a textbook of mathematics, a Secondary Section may not explain any mathematics.) The relationship could be a matter of historical connection with the subject or with related matters, or of legal, commercial, philosophical, ethical or political position regarding them.
The “Invariant Sections” are certain Secondary Sections whose titles are designated, as being those of Invariant Sections, in the notice that says that the Document is released under this License. If a section does not fit the above definition of Secondary then it is not allowed to be designated as Invariant. The Document may contain zero Invariant Sections. If the Document does not identify any Invariant Sections then there are none.
The “Cover Texts” are certain short passages of text that are listed, as Front-Cover Texts or Back-Cover Texts, in the notice that says that the Document is released under this License. A Front-Cover Text may be at most 5 words, and a Back-Cover Text may be at most 25 words.
A “Transparent” copy of the Document means a machine-readable copy, represented in a format whose specification is available to the general public, that is suitable for revising the document straightforwardly with generic text editors or (for images composed of pixels) generic paint programs or (for drawings) some widely available drawing editor, and that is suitable for input to text formatters or for automatic translation to a variety of formats suitable for input to text formatters. A copy made in an otherwise Transparent file format whose markup, or absence of markup, has been arranged to thwart or discourage subsequent modification by readers is not Transparent. An image format is not Transparent if used for any substantial amount of text. A copy that is not “Transparent” is called “Opaque”.
Examples of suitable formats for Transparent copies include plain ASCII without markup, Texinfo input format, LaTeX input format, SGML or XML using a publicly available DTD, and standard-conforming simple HTML, PostScript or PDF designed for human modification. Examples of transparent image formats include PNG, XCF and JPG. Opaque formats include proprietary formats that can be read and edited only by proprietary word processors, SGML or XML for which the DTD and/or processing tools are not generally available, and the machine-generated HTML, PostScript or PDF produced by some word processors for output purposes only.
The “Title Page” means, for a printed book, the title page itself, plus such following pages as are needed to hold, legibly, the material this License requires to appear in the title page. For works in formats which do not have any title page as such, “Title Page” means the text near the most prominent appearance of the work's title, preceding the beginning of the body of the text.
A section “Entitled XYZ” means a named subunit of the Document whose title either is precisely XYZ or contains XYZ in parentheses following text that translates XYZ in another language. (Here XYZ stands for a specific section name mentioned below, such as “Acknowledgements”, “Dedications”, “Endorsements”, or “History”.) To “Preserve the Title” of such a section when you modify the Document means that it remains a section “Entitled XYZ” according to this definition.
The Document may include Warranty Disclaimers next to the notice which states that this License applies to the Document. These Warranty Disclaimers are considered to be included by reference in this License, but only as regards disclaiming warranties: any other implication that these Warranty Disclaimers may have is void and has no effect on the meaning of this License.
You may copy and distribute the Document in any medium, either commercially or noncommercially, provided that this License, the copyright notices, and the license notice saying this License applies to the Document are reproduced in all copies, and that you add no other conditions whatsoever to those of this License. You may not use technical measures to obstruct or control the reading or further copying of the copies you make or distribute. However, you may accept compensation in exchange for copies. If you distribute a large enough number of copies you must also follow the conditions in section 3.
You may also lend copies, under the same conditions stated above, and you may publicly display copies.
If you publish printed copies (or copies in media that commonly have printed covers) of the Document, numbering more than 100, and the Document's license notice requires Cover Texts, you must enclose the copies in covers that carry, clearly and legibly, all these Cover Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on the back cover. Both covers must also clearly and legibly identify you as the publisher of these copies. The front cover must present the full title with all words of the title equally prominent and visible. You may add other material on the covers in addition. Copying with changes limited to the covers, as long as they preserve the title of the Document and satisfy these conditions, can be treated as verbatim copying in other respects.
If the required texts for either cover are too voluminous to fit legibly, you should put the first ones listed (as many as fit reasonably) on the actual cover, and continue the rest onto adjacent pages.
If you publish or distribute Opaque copies of the Document numbering more than 100, you must either include a machine-readable Transparent copy along with each Opaque copy, or state in or with each Opaque copy a computer-network location from which the general network-using public has access to download using public-standard network protocols a complete Transparent copy of the Document, free of added material. If you use the latter option, you must take reasonably prudent steps, when you begin distribution of Opaque copies in quantity, to ensure that this Transparent copy will remain thus accessible at the stated location until at least one year after the last time you distribute an Opaque copy (directly or through your agents or retailers) of that edition to the public.
It is requested, but not required, that you contact the authors of the Document well before redistributing any large number of copies, to give them a chance to provide you with an updated version of the Document.
You may copy and distribute a Modified Version of the Document under the conditions of sections 2 and 3 above, provided that you release the Modified Version under precisely this License, with the Modified Version filling the role of the Document, thus licensing distribution and modification of the Modified Version to whoever possesses a copy of it. In addition, you must do these things in the Modified Version:
If the Modified Version includes new front-matter sections or appendices that qualify as Secondary Sections and contain no material copied from the Document, you may at your option designate some or all of these sections as invariant. To do this, add their titles to the list of Invariant Sections in the Modified Version's license notice. These titles must be distinct from any other section titles.
You may add a section Entitled “Endorsements”, provided it contains nothing but endorsements of your Modified Version by various parties—for example, statements of peer review or that the text has been approved by an organization as the authoritative definition of a standard.
You may add a passage of up to five words as a Front-Cover Text, and a passage of up to 25 words as a Back-Cover Text, to the end of the list of Cover Texts in the Modified Version. Only one passage of Front-Cover Text and one of Back-Cover Text may be added by (or through arrangements made by) any one entity. If the Document already includes a cover text for the same cover, previously added by you or by arrangement made by the same entity you are acting on behalf of, you may not add another; but you may replace the old one, on explicit permission from the previous publisher that added the old one.
The author(s) and publisher(s) of the Document do not by this License give permission to use their names for publicity for or to assert or imply endorsement of any Modified Version.
You may combine the Document with other documents released under this License, under the terms defined in section 4 above for modified versions, provided that you include in the combination all of the Invariant Sections of all of the original documents, unmodified, and list them all as Invariant Sections of your combined work in its license notice, and that you preserve all their Warranty Disclaimers.
The combined work need only contain one copy of this License, and multiple identical Invariant Sections may be replaced with a single copy. If there are multiple Invariant Sections with the same name but different contents, make the title of each such section unique by adding at the end of it, in parentheses, the name of the original author or publisher of that section if known, or else a unique number. Make the same adjustment to the section titles in the list of Invariant Sections in the license notice of the combined work.
In the combination, you must combine any sections Entitled “History” in the various original documents, forming one section Entitled “History”; likewise combine any sections Entitled “Acknowledgements”, and any sections Entitled “Dedications”. You must delete all sections Entitled “Endorsements.”
You may make a collection consisting of the Document and other documents released under this License, and replace the individual copies of this License in the various documents with a single copy that is included in the collection, provided that you follow the rules of this License for verbatim copying of each of the documents in all other respects.
You may extract a single document from such a collection, and distribute it individually under this License, provided you insert a copy of this License into the extracted document, and follow this License in all other respects regarding verbatim copying of that document.
A compilation of the Document or its derivatives with other separate and independent documents or works, in or on a volume of a storage or distribution medium, is called an “aggregate” if the copyright resulting from the compilation is not used to limit the legal rights of the compilation's users beyond what the individual works permit. When the Document is included in an aggregate, this License does not apply to the other works in the aggregate which are not themselves derivative works of the Document.
If the Cover Text requirement of section 3 is applicable to these copies of the Document, then if the Document is less than one half of the entire aggregate, the Document's Cover Texts may be placed on covers that bracket the Document within the aggregate, or the electronic equivalent of covers if the Document is in electronic form. Otherwise they must appear on printed covers that bracket the whole aggregate.
Translation is considered a kind of modification, so you may distribute translations of the Document under the terms of section 4. Replacing Invariant Sections with translations requires special permission from their copyright holders, but you may include translations of some or all Invariant Sections in addition to the original versions of these Invariant Sections. You may include a translation of this License, and all the license notices in the Document, and any Warranty Disclaimers, provided that you also include the original English version of this License and the original versions of those notices and disclaimers. In case of a disagreement between the translation and the original version of this License or a notice or disclaimer, the original version will prevail.
If a section in the Document is Entitled “Acknowledgements”, “Dedications”, or “History”, the requirement (section 4) to Preserve its Title (section 1) will typically require changing the actual title.
You may not copy, modify, sublicense, or distribute the Document except as expressly provided for under this License. Any other attempt to copy, modify, sublicense or distribute the Document is void, and will automatically terminate your rights under this License. However, parties who have received copies, or rights, from you under this License will not have their licenses terminated so long as such parties remain in full compliance.
The Free Software Foundation may publish new, revised versions of the GNU Free Documentation License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. See http://www.gnu.org/copyleft/.
Each version of the License is given a distinguishing version number. If the Document specifies that a particular numbered version of this License “or any later version” applies to it, you have the option of following the terms and conditions either of that specified version or of any later version that has been published (not as a draft) by the Free Software Foundation. If the Document does not specify a version number of this License, you may choose any version ever published (not as a draft) by the Free Software Foundation.
To use this License in a document you have written, include a copy of the License in the document and put the following copyright and license notices just after the title page:
Copyright (C) year your name. Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.2 or any later version published by the Free Software Foundation; with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A copy of the license is included in the section entitled ``GNU Free Documentation License''. |
If you have Invariant Sections, Front-Cover Texts and Back-Cover Texts, replace the “with…Texts.” line with this:
with the Invariant Sections being list their titles, with
the Front-Cover Texts being list, and with the Back-Cover Texts
being list.
|
If you have Invariant Sections without Cover Texts, or some other combination of the three, merge those two alternatives to suit the situation.
If your document contains nontrivial examples of program code, we recommend releasing these examples in parallel under your choice of free software license, such as the GNU General Public License, to permit their use in free software.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
| Jump to: | *
M |
|---|
| Jump to: | *
M |
|---|
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
| Jump to: | M |
|---|
| Jump to: | M |
|---|
| [Top] | [Contents] | [Index] | [ ? ] |
Note to readers acquainted
to the Tcl API: reference counting on MHD_Connection
structures is handled in the same way as Tcl handles Tcl_Obj
structures through Tcl_IncrRefCount() and
Tcl_DecrRefCount().
| [Top] | [Contents] | [Index] | [ ? ] |
selectPOST processor
| [Top] | [Contents] | [Index] | [ ? ] |
selectPOST processor| [Top] | [Contents] | [Index] | [ ? ] |
This document was generated by Christian Grothoff on May, 26 2008 using texi2html 1.78.
The buttons in the navigation panels have the following meaning:
| Button | Name | Go to | From 1.2.3 go to |
|---|---|---|---|
| [ < ] | Back | Previous section in reading order | 1.2.2 |
| [ > ] | Forward | Next section in reading order | 1.2.4 |
| [ << ] | FastBack | Beginning of this chapter or previous chapter | 1 |
| [ Up ] | Up | Up section | 1.2 |
| [ >> ] | FastForward | Next chapter | 2 |