diff --git a/License.txt b/License.txt new file mode 100644 index 0000000..f0156c5 --- /dev/null +++ b/License.txt @@ -0,0 +1,165 @@ + GNU LESSER GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + + This version of the GNU Lesser General Public License incorporates +the terms and conditions of version 3 of the GNU General Public +License, supplemented by the additional permissions listed below. + + 0. Additional Definitions. + + As used herein, "this License" refers to version 3 of the GNU Lesser +General Public License, and the "GNU GPL" refers to version 3 of the GNU +General Public License. + + "The Library" refers to a covered work governed by this License, +other than an Application or a Combined Work as defined below. + + An "Application" is any work that makes use of an interface provided +by the Library, but which is not otherwise based on the Library. +Defining a subclass of a class defined by the Library is deemed a mode +of using an interface provided by the Library. + + A "Combined Work" is a work produced by combining or linking an +Application with the Library. The particular version of the Library +with which the Combined Work was made is also called the "Linked +Version". + + The "Minimal Corresponding Source" for a Combined Work means the +Corresponding Source for the Combined Work, excluding any source code +for portions of the Combined Work that, considered in isolation, are +based on the Application, and not on the Linked Version. + + The "Corresponding Application Code" for a Combined Work means the +object code and/or source code for the Application, including any data +and utility programs needed for reproducing the Combined Work from the +Application, but excluding the System Libraries of the Combined Work. + + 1. Exception to Section 3 of the GNU GPL. + + You may convey a covered work under sections 3 and 4 of this License +without being bound by section 3 of the GNU GPL. + + 2. Conveying Modified Versions. + + If you modify a copy of the Library, and, in your modifications, a +facility refers to a function or data to be supplied by an Application +that uses the facility (other than as an argument passed when the +facility is invoked), then you may convey a copy of the modified +version: + + a) under this License, provided that you make a good faith effort to + ensure that, in the event an Application does not supply the + function or data, the facility still operates, and performs + whatever part of its purpose remains meaningful, or + + b) under the GNU GPL, with none of the additional permissions of + this License applicable to that copy. + + 3. Object Code Incorporating Material from Library Header Files. + + The object code form of an Application may incorporate material from +a header file that is part of the Library. You may convey such object +code under terms of your choice, provided that, if the incorporated +material is not limited to numerical parameters, data structure +layouts and accessors, or small macros, inline functions and templates +(ten or fewer lines in length), you do both of the following: + + a) Give prominent notice with each copy of the object code that the + Library is used in it and that the Library and its use are + covered by this License. + + b) Accompany the object code with a copy of the GNU GPL and this license + document. + + 4. Combined Works. + + You may convey a Combined Work under terms of your choice that, +taken together, effectively do not restrict modification of the +portions of the Library contained in the Combined Work and reverse +engineering for debugging such modifications, if you also do each of +the following: + + a) Give prominent notice with each copy of the Combined Work that + the Library is used in it and that the Library and its use are + covered by this License. + + b) Accompany the Combined Work with a copy of the GNU GPL and this license + document. + + c) For a Combined Work that displays copyright notices during + execution, include the copyright notice for the Library among + these notices, as well as a reference directing the user to the + copies of the GNU GPL and this license document. + + d) Do one of the following: + + 0) Convey the Minimal Corresponding Source under the terms of this + License, and the Corresponding Application Code in a form + suitable for, and under terms that permit, the user to + recombine or relink the Application with a modified version of + the Linked Version to produce a modified Combined Work, in the + manner specified by section 6 of the GNU GPL for conveying + Corresponding Source. + + 1) Use a suitable shared library mechanism for linking with the + Library. A suitable mechanism is one that (a) uses at run time + a copy of the Library already present on the user's computer + system, and (b) will operate properly with a modified version + of the Library that is interface-compatible with the Linked + Version. + + e) Provide Installation Information, but only if you would otherwise + be required to provide such information under section 6 of the + GNU GPL, and only to the extent that such information is + necessary to install and execute a modified version of the + Combined Work produced by recombining or relinking the + Application with a modified version of the Linked Version. (If + you use option 4d0, the Installation Information must accompany + the Minimal Corresponding Source and Corresponding Application + Code. If you use option 4d1, you must provide the Installation + Information in the manner specified by section 6 of the GNU GPL + for conveying Corresponding Source.) + + 5. Combined Libraries. + + You may place library facilities that are a work based on the +Library side by side in a single library together with other library +facilities that are not Applications and are not covered by this +License, and convey such a combined library under terms of your +choice, if you do both of the following: + + a) Accompany the combined library with a copy of the same work based + on the Library, uncombined with any other library facilities, + conveyed under the terms of this License. + + b) Give prominent notice with the combined library that part of it + is a work based on the Library, and explaining where to find the + accompanying uncombined form of the same work. + + 6. Revised Versions of the GNU Lesser General Public License. + + The Free Software Foundation may publish revised and/or new versions +of the GNU Lesser General Public 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. + + Each version is given a distinguishing version number. If the +Library as you received it specifies that a certain numbered version +of the GNU Lesser General Public License "or any later version" +applies to it, you have the option of following the terms and +conditions either of that published version or of any later version +published by the Free Software Foundation. If the Library as you +received it does not specify a version number of the GNU Lesser +General Public License, you may choose any version of the GNU Lesser +General Public License ever published by the Free Software Foundation. + + If the Library as you received it specifies that a proxy can decide +whether future versions of the GNU Lesser General Public License shall +apply, that proxy's public statement of acceptance of any version is +permanent authorization for you to choose that version for the +Library. \ No newline at end of file diff --git a/NHttp.sln b/NHttp.sln index 260f9ae..a704046 100644 --- a/NHttp.sln +++ b/NHttp.sln @@ -5,20 +5,54 @@ Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "NHttp", "NHttp\NHttp.csproj EndProject Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "NHttp.Test", "NHttp.Test\NHttp.Test.csproj", "{62DDBB7E-4016-4832-9113-06B23557F263}" EndProject +Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution Items", "{DB6E7F19-1850-4AA5-8FCC-39E53C0BFB27}" + ProjectSection(SolutionItems) = preProject + License.txt = License.txt + README.markdown = README.markdown + EndProjectSection +EndProject +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "NHttp.Demo", "NHttp.Demo\NHttp.Demo.csproj", "{E9156E3C-F9F3-492B-B4EC-DBF12812195E}" +EndProject Global GlobalSection(SolutionConfigurationPlatforms) = preSolution Debug|Any CPU = Debug|Any CPU + Debug|Mixed Platforms = Debug|Mixed Platforms + Debug|x86 = Debug|x86 Release|Any CPU = Release|Any CPU + Release|Mixed Platforms = Release|Mixed Platforms + Release|x86 = Release|x86 EndGlobalSection GlobalSection(ProjectConfigurationPlatforms) = postSolution {7AD9DA80-AFB9-43EA-BDF2-9B75C47DC2CC}.Debug|Any CPU.ActiveCfg = Debug|Any CPU {7AD9DA80-AFB9-43EA-BDF2-9B75C47DC2CC}.Debug|Any CPU.Build.0 = Debug|Any CPU + {7AD9DA80-AFB9-43EA-BDF2-9B75C47DC2CC}.Debug|Mixed Platforms.ActiveCfg = Debug|Any CPU + {7AD9DA80-AFB9-43EA-BDF2-9B75C47DC2CC}.Debug|Mixed Platforms.Build.0 = Debug|Any CPU + {7AD9DA80-AFB9-43EA-BDF2-9B75C47DC2CC}.Debug|x86.ActiveCfg = Debug|Any CPU {7AD9DA80-AFB9-43EA-BDF2-9B75C47DC2CC}.Release|Any CPU.ActiveCfg = Release|Any CPU {7AD9DA80-AFB9-43EA-BDF2-9B75C47DC2CC}.Release|Any CPU.Build.0 = Release|Any CPU + {7AD9DA80-AFB9-43EA-BDF2-9B75C47DC2CC}.Release|Mixed Platforms.ActiveCfg = Release|Any CPU + {7AD9DA80-AFB9-43EA-BDF2-9B75C47DC2CC}.Release|Mixed Platforms.Build.0 = Release|Any CPU + {7AD9DA80-AFB9-43EA-BDF2-9B75C47DC2CC}.Release|x86.ActiveCfg = Release|Any CPU {62DDBB7E-4016-4832-9113-06B23557F263}.Debug|Any CPU.ActiveCfg = Debug|Any CPU {62DDBB7E-4016-4832-9113-06B23557F263}.Debug|Any CPU.Build.0 = Debug|Any CPU + {62DDBB7E-4016-4832-9113-06B23557F263}.Debug|Mixed Platforms.ActiveCfg = Debug|Any CPU + {62DDBB7E-4016-4832-9113-06B23557F263}.Debug|Mixed Platforms.Build.0 = Debug|Any CPU + {62DDBB7E-4016-4832-9113-06B23557F263}.Debug|x86.ActiveCfg = Debug|Any CPU {62DDBB7E-4016-4832-9113-06B23557F263}.Release|Any CPU.ActiveCfg = Release|Any CPU {62DDBB7E-4016-4832-9113-06B23557F263}.Release|Any CPU.Build.0 = Release|Any CPU + {62DDBB7E-4016-4832-9113-06B23557F263}.Release|Mixed Platforms.ActiveCfg = Release|Any CPU + {62DDBB7E-4016-4832-9113-06B23557F263}.Release|Mixed Platforms.Build.0 = Release|Any CPU + {62DDBB7E-4016-4832-9113-06B23557F263}.Release|x86.ActiveCfg = Release|Any CPU + {E9156E3C-F9F3-492B-B4EC-DBF12812195E}.Debug|Any CPU.ActiveCfg = Debug|x86 + {E9156E3C-F9F3-492B-B4EC-DBF12812195E}.Debug|Mixed Platforms.ActiveCfg = Debug|x86 + {E9156E3C-F9F3-492B-B4EC-DBF12812195E}.Debug|Mixed Platforms.Build.0 = Debug|x86 + {E9156E3C-F9F3-492B-B4EC-DBF12812195E}.Debug|x86.ActiveCfg = Debug|x86 + {E9156E3C-F9F3-492B-B4EC-DBF12812195E}.Debug|x86.Build.0 = Debug|x86 + {E9156E3C-F9F3-492B-B4EC-DBF12812195E}.Release|Any CPU.ActiveCfg = Release|x86 + {E9156E3C-F9F3-492B-B4EC-DBF12812195E}.Release|Mixed Platforms.ActiveCfg = Release|x86 + {E9156E3C-F9F3-492B-B4EC-DBF12812195E}.Release|Mixed Platforms.Build.0 = Release|x86 + {E9156E3C-F9F3-492B-B4EC-DBF12812195E}.Release|x86.ActiveCfg = Release|x86 + {E9156E3C-F9F3-492B-B4EC-DBF12812195E}.Release|x86.Build.0 = Release|x86 EndGlobalSection GlobalSection(SolutionProperties) = preSolution HideSolutionNode = FALSE diff --git a/README.markdown b/README.markdown new file mode 100644 index 0000000..7cb2342 --- /dev/null +++ b/README.markdown @@ -0,0 +1,79 @@ +# NHttp + +LGPL License. + +## Introduction + +NHttp is a simple asynchronous HTTP server written in C# for the .NET framework. + +NHttp supports the following features: + +* Full request parsing similar to the ASP.net model; + +* High performance asynchronous request processing using TcpListener/TcpClient; + +* Complete query string parsing; + +* Complete form parsing (i.e. application/x-www-form-urlencoded); + +* Complete multi-part parsing including file upload (i.e. multipart/form-data); + +* Support for parsing and sending cookies. + +NHttp specifically does **not** support any kind of utilities producing output. +It for example does not provide a StreamWriter or perform routing. Besides e.g. +the Headers and Cookies collections, only the raw output stream is provided. +The rest is up to you! + +## Usage + +The following shows how to use NHttp: + + using (var server = new HttpServer()) + { + server.RequestReceived += (s, e) => + { + using (var writer = new StreamWriter(e.Response.OutputStream)) + { + writer.Write("Hello world!"); + } + }; + + server.Start(); + + Process.Start(String.Format("http://{0}/", server.EndPoint)); + + Console.WriteLine("Press any key to continue..."); + Console.ReadKey(); + } + +Processing requests in NHttp is done in the RequestReceived event. There you +have access to the request and response information the request. The example +above creates a StreamReader to be able to write text to the response and +outputs the same response for every request. + +By default, NHttp listens to a random port. Use the following method to specify +the port NHttp should listen on: + + using (var server = new HttpServer()) + { + // ... + + server.EndPoint = new IPEndPoint(IPAddress.Loopback, 80); + + server.Start(); + + // ... + } + +This method can also be used to change the interface the HttpServer should be +listening to. + +## Bugs + +Bugs should be reported through github at +[http://github.com/pvginkel/NHttp/issues](http://github.com/pvginkel/NHttp/issues). + +## License + +NHttp is licensed under the LGPL 3. \ No newline at end of file