HttpListener for .NET Core and the Universal Windows Platform (UWP)
Switch branches/tags
Nothing to show
Clone or download
robertsundstrom Merge pull request #5 from StefH/master
Upgrade to netstandard1.3 and format and cleanup the code
Latest commit 1686722 May 12, 2017

README.md

HttpListener for .NET Core and UWP

A simple library that essentially allows for building your own HTTP server on .NET Core and the Universal Windows Platform (UWP).

Overview

This library fills the void left by the missing System.Net.Http.HttpListener in .NET Core and Universal Windows Platform (UWP).

By targetting .NET Core and UWP, this API enables HTTP server scenarios on Windows 10 for IoT on Raspberry Pi (2 & 3).

Taking a modern approach, this API is not meant to be entirely compatible with the HttpListener found in the full .NET Framework on Windows desktop.

Please, be aware that this is an early concept, and thus not ready for production.

Contributions are most welcome.

Solution

The solution consists of two projects with a common core targetting:

  1. .NET Core project - Windows, Linux and Mac OS X.
  2. Universal Windows Platform (UWP) - Windows 10 and up.

The API:s are generally similar, but may differ slightly on each platform due to their respective API constraints. However, the core concepts remain the same.

On .NET Core it uses .NET:s TcpListener and TcpClient.

On UWP it uses Windows Runtime's StreamSocketListener and StreamSocket.

Get the package(s)

The latest version that has been release can be found in this NuGet feed:

https://www.myget.org/F/roberts-core-feed/api/v3/index.json

Add this to your Package Sources.

Search for "HttpListener" and the packages "System.Net.Http.HttpListener" and "System.Net.Http.HttpListener.UWP" should show up.

Choose the one that is to your liking.

Todo

Here are some things to consider doing in the future:

  • Rewrite the HttpRequest parser and implement missing features, like authentication and the handling of content types.
  • Consolidate the two libraries (.NET Core and UWP) into one single .NET Standard-compliant library when possible to do so.

Sample

Add the using statement.

...
using System.Net.Http;

The code used in this sample should be the same on any platform.

var listener = new HttpListener(IPAddress.Parse("127.0.0.1"), 8081);
try 
{
	listener.Request += async (sender, context) => {
		var request = context.Request;
		var response = context.Response;
		if(request.Method == HttpMethod.Get) 
		{
			await response.WriteAsync($"Hello from Server at: {DateTime.Now}\r\n");
		}
		else
		{
			response.MethodNotAllowed();
		}
		// Close the HttpResponse to send it back to the client.
		response.Close();
	};
	listener.Start();

	Console.WriteLine("Press any key to exit.");
	Console.ReadKey();
}
catch(Exception exc) 
{
	Console.WriteLine(exc.ToString());
}
finally 
{
	listener.Close();
}

Visit 127.0.0.1:8081 in your browser.

Also consider having a look at the unit tests.