Rearranged code with NArrange -- I've been forgetting to do this for a couple of...
[lwes-dotnet/github-mirror.git] / README.txt
blobfd66a0b8888728a72d9bec421609d9bb1f0f64ff
1 This is the .NET API for the Light Weight Event System.\r
2 \r
3 2009-08-13 Version 0.1.* ALPHA - Happy Birthday to me: LWES DotNet Binding.\r
4         \r
5         This is the initial check-in - it remains a work in progress. I've been working\r
6         with this code for a couple of weeks, un-protected by version control, so it \r
7         was time to pull the trigger.\r
8         \r
9         The project requires Visual Studio .NET 2008 and .NET 3.0 (or above). \r
10         Be warned: I HAVE NOT tested all possible configurations! Also note that\r
11         your network and firewall settings may prevent some of the tests from\r
12         succeeding. \r
13         \r
14         I noticed during development that when I was debugging from a computer that\r
15         hosts VMWare the virtual device driver prevented the mutlicast traffic from\r
16         being sent. I was debugging the java TestListener on Ubuntu Linux and couldn't\r
17         "hear" the multicast events from my Vista64 box until I uninstalled VMWare. \r
18         My approach was probably too dramatic - you probably won't have to uninstall \r
19         VMWare, particularly if you've got more patience than I did but I didn't feel \r
20         like taking the time to figure it out.\r
21         \r
22         I also noticed anomolies when using     Sun's VirtualBox, to get the multicast \r
23         traffic to be reliably transmitted between guest and host I had to bridge \r
24         a physical adapters so the guest OS     has its own IP addy on the network. \r
25         The virtual host-only network does not handle multicast traffic properly.\r
26         \r
27         Test code targets the built in VSTS. I made this choice based on one simple \r
28         fact: any developer using Visual Studio .NET 2008 will have the least \r
29         resistance      getting the solution to build/and run tests. At some point I may \r
30         put up some NUnit tests since that is my framework of choice (but don't hold \r
31         me to it).\r
32         \r
33         Some of the tests make use of the MOQ for mocking, it can be found \r
34         at http://code.google.com/p/moq/\r
35         \r
36         The IoC support built into this API requires the CommonServiceLocator found \r
37         at http://www.codeplex.com/CommonServiceLocator. You'll find links to your\r
38         favorite IoC container among the links on that page.\r
39                 \r
40         I have begun a journaler implementation that will use file-based rollover\r
41         logs for storing raw events.\r
42         \r
43         Feel free to offer suggestions or assistance.\r
44         \r
45         ~Phillip (cerebralkungfu)\r
46