JetByte Socket Tools Library - Example Servers

6.0

The Socket Tools Library provides a framework for client and server software that uses asynchronous I/O and I/O completion ports. The framework makes it easy to write high-performance stream (e.g. TCP) and datagram (e.g. UDP) servers and clients. The library also includes extensive classes for addressing using either TCPv4 or TCPv6 addressing. The server and client frameworks provide specific socket classes that expose only those details that are appropriate for the situation at hand. There is also a large amount of utility code to help with the construction of servers and clients. All classes are built to allow for networking other than TCP and UDP should the need arise. It's possible to add filtering to stream based systems so that the data stream can be manipulated before it reaches user code on the way in and before it reaches the network on the way out. This makes it easy to add encryption or compression, etc, below the business logic code.

Start here:

• Licensing Options
• Build configuration; what you need to do before you can compile for the first time
• Release Notes
• Some reasoning behind some of the decisions that were made during the development of this code
• Frequently asked project related questions
• A brief introduction to the design of the Socket Tools library
• Callbacks - how you get the framework to work for you
• Writing your first TCP server
• Writing your first TCP client
• The lifecycle of a stream socket connection
• Writing your first UDP server
• Writing your first UDP client
• Details of the example servers supplied with the framework
• TODO - things that may or may not be fixed or added...

Advanced concepts

• Details of the example servers supplied with the framework
• Everything you need to know about per connection user data
• Everything you need to know about sequencing TCP streams
• Everything you need to know about filtering TCP streams
• Everything you need to know about limiting resource usage in servers, including why you'd want to
• Frequently Asked Questions

Examples

The Socket Tools library ships with many different example programs which demonstrate different aspects of the framework. All of the examples are available in source code form from links on the pages that describe the contents of the example packs. Of course the examples that you can actually build will depend which options you selected when you licensed the framework (see here for licensing options) as this determines which tools libraries that you are sent and various example servers need various different tools libraries, it becomes fairly clear what you have and what you need once you take a look at one of the example projects.). The examples are grouped together in 'packs' of similar functionality, so, the easiest to understand servers are in the SimpleServers pack, servers that run as services are in the Services pack, etc. Please contact us by email for details of how to obtain any additional libraries that you may require to build particular server examples, or for custom server development.

Please note that, in general, each example aims to demonstrate one new feature. You can, of course, mix and match features and merge examples into considerably more complex scenarios than those presented here and some of the examples are fairly complex in their own right. We tend to develop new examples as and when clients require specific functionality in a server. Once more than one client needs a particular style of server we figure that it's probably worth creating an example that shows everyone else how to do it.
The current examples are split into the following packs. We note with each pack which options you need to license to be able to build the pack. Note that, of course, all packs require the "base framework" license.

• Simple Servers - A selection of example servers that demonstrate various aspects of the server framework.
• Connection Termination Examples - A server and client that demonstrate the various ways to terminate connections and what each method means in practice.
• Gateway Server Examples - This selection of servers demonstrate servers which connect two connections together. The gateway server can act as a proxy, or can process data as it flows from one connection to another, we've also developed gateways which perform protocol translation and which provide secure 'tunnelling' for insecure protocols.
• Services - Building servers that run as services. Requires the Windows Services license option.
• Services with Performance Counters - Building servers that run as services and expose performance counters for use with the standard Windows Perfmon tool. Requires the Windows Services and Performance Counters license options.
• Servers with Performance Counters - Building servers that expose performance counters but that run as normal executables. Requires the Performance Counters license option.
• Data Distribution Server examples - Servers and clients that demonstrate a high throughput publish/subscribe system. The examples consist of a simple pub/sub server, a client that acts as a data souce for the server and a client that acts as a subscriber. The server supports distributing the data that arrives from the data feed to several connected subscriber clients in an efficient manner. Requires the Performance Counters license option (but only because the server exposes performance counters so that it's easy to profile, the underlying publish/subscribe model doesn't require additional licensing.
• OpenSSL Servers - Servers that use OpenSSL to provide secure communication. Requires the OpenSSL license option.
• SChannel Servers - Servers that use Microsoft's SChannel to provide secure communication. Requires the SChannel license option.
• CLR Hosting Servers - Servers that host the CLR and allow business logic to be written in .Net code. Requires the CLR Hosting license option.
• Misc Servers - Miscellaneous servers that don't really fit in any of the other packs; e.g. Bluetooth servers, HTTP/HTTPS Servers, Telnet Servers, POP3 Servers. These may require additional licensing, contact us for details.

---