The XDMessaging library provides an easy-to-use, zero configuration solution to same-box communications. It provides a simple API for broadcasting and receiving messages across application and process boundaries.
Version 1.0 was originally developed to use low-level Windows Messaging and to offer a performant solution for Windows Forms based applications. However, the restriction in using Windows Messages is that it does not provide a way to communicate with non-Forms based applications such as Windows Services which don't have their own message pump.
Version 2.0 now extends the library further, and provides a second file IO based transport mode for messaging. The new
IOStream mode can be used to communicate with Windows services, console apps, and continues to work with Forms based applications.
The library allows the use of user-defined pseudo channels through which messages may be sent and received. Any application can send a message to any channel, but it must register as a listener with the channel in order to receive. In this way, developers can quickly and programmatically devise how their applications will communicate with each other best, to work in harmony.
The XDMessaging library offers some advantages over other IPC technologies like WCF, .NET Remoting, Sockets, NamedPipes, and MailSlots. To begin with, the library does not require a server-client relationship as there is no physical connection between processes.
With XDMessaging, messages can be broadcast by multiple applications, and instantly received by multiple listeners in a disconnected fashion. MailSlots offer the closest match to this functionality; however, I found this had a few limitations. Although messages are also disconnected, there is no way to peek at a message, and as soon as the message is read, it is removed from the MailSlot. It's great for broadcasting messages, but limited to a single client for receiving the message. The other limitation is that messages are not instant, and requires polling of the MailSlot.
It's also worth noting that most of the existing IPC implementations require the opening of specific ports and a somewhat painful configuration of settings to make them work. With XDMessaging, there is no configuration; the API determines where messages are sent, and which messages are received using pseudo channels. The disadvantage is that communication is limited to a single machine, so for network communication, other IPC technologies such as WCF are much more suited.
Using the Library
To use the library, create an instance of a
IXDBroadcast and use this to send a message to a named channel. You can then create an instance of
IXDListener to receive messages on a particular channel. The channels are arbitrary strings chosen to represent a channel, and are not case sensitive.
Before creating the broadcast and listener instances, you must first decide which transport mode you want to use for the library. There are two modes as follows, and each has advantages over the other.
IOStream: This uses file based IO to broadcast messages via a shared directory. A
FileSystemWatcher is used within listener classes to monitor changes and trigger the
MessageReceived event containing the broadcast message. This mode can be used in Windows Services, console applications, and Windows Forms based applications. Channels are created as separate directories on the file system for each channel. The temporary directories should be accessible by all processes, and there should be no need for manual configuration.
WindowsMessaging: This uses the
WM_COPYDATA Windows message to copy data between applications. The broadcast implementation sends the Windows messages directly to a hidden window on the listener instance, which dispatches the
MessageReceived event with the copied data. Channels are created by adding/removing Windows properties. This offers the most performant solution for Windows Forms based applications, but does not work for Windows Services, console apps, or other applications without a message pump.
Note: Messages broadcast using a particular mode can only be read by applications using a listener in the same mode. For example,
IOStream listeners cannot read messages broadcast in the
See the included sample applications for more information on using the library in Windows Forms applications or within a Windows Service.
Example: Sending a message in a particular mode:
IXDBroadcast broadcast = XDBroadcast.CreateBroadcast(XDTransportMode.IOStream);
IXDBroadcast broadcast = XDBroadcast.CreateBroadcast(XDTransportMode.WindowsMessaging);
Example: Listening for messages on a particular channel:
IXDListener listener = XDListener.CreateListener(XDTransportMode.IOStream);
IXDListener listener = XDListener.CreateListener(XDTransportMode.WindowsMessaging);
Example: Handling the messages:
private void listener_MessageReceived(object sender, XDMessageEventArgs e)
- 12 Dec 2009: Initial release
- 16 Dec 2009: Optimized performance
- 4 Jan 2010: Adding network propagation support via MailSlots