org.macroing.cit.messaging (org.macroing.cit.messaging API)

Interface Summary
Interface	Description
Message	A `Message` that can be sent to a `MessageChannel`.
MessageChannelObserver	A `MessageChannelObserver` observes changes made to a `MessageChannel` instance.
MessageFilter	A `MessageFilter` filters what `Message`s a `MessageChannel` should process.
MessageHandler	A `MessageHandler` handles a `Message` sent to a `MessageChannel` instance.
MessageTranslator	A `MessageTranslator` is used to translate one `Message` being processed by a `MessageChannel` instance, into a possibly different one.
MessagingObserver	A `MessagingObserver` observes changes made to a `Messaging` instance.

Class Summary
Class	Description
MessageChannel	A `MessageChannel` is a channel in which you can send `Message`s.
MessageChannelObservers	A class that consists exclusively of static methods that operates on or returns `MessageChannelObserver`s.
Messages	A class that consists exclusively of static methods that operates on or returns `Message`s.
Messaging	A `Messaging` is an abstract base class for defining a messaging system.

Package org.macroing.cit.messaging Description

Provides the API for CIT Messaging.

CIT Messaging is a library for creating arbitrary messaging systems.

This library mainly provides the abstractions upon which you build your messaging system. This means that you will either have to use an existing extension of it, or build your own, in order to use it. Only a few concrete classes are available for use.

Concept Overview

To use this library, you need to understand the concepts provided. So here follows an overview of the concepts.

Message is an abstraction for arbitrary messages that can be sent to and received from a message channel.
MessageChannel is an abstraction for a message channel to which you can send, or from which you can receive messages.
MessageChannelObserver is an interface that you can implement to observe what's going on in a MessageChannel instance.
MessageFilter is an interface that you can implement to filter what messages a message channel should process.
MessageHandler is an interface that you can implement to handle messages that were processed by a message channel.
MessageTranslator is an interface that you can implement to translate a message into a different message as part of the message channel processing.
Messaging is the core class of this library, which you may have to implement yourself.
MessagingObserver is an interface that you can implement to observe what's going on in a Messaging instance.

Examples

The following example demonstrates how you can use this library.

 
 MyMessaging myMessaging = new MyMessaging();
 myMessaging.addMessagingObserver(new MyMessagingObserver());
 myMessaging.getMessageChannel().addMessageChannelObserver(new MyMessageChannelObserver());
 myMessaging.getMessageChannel().addMessageFilter(new MyMessageFilter());
 myMessaging.getMessageChannel().addMessageHandler(new MyMessageHandler());
 myMessaging.getMessageChannel().addMessageTranslator(new MyMessageTranslator());
 myMessaging.start();
 myMessaging.getMessageChannel().sendMessage(new MyMessage("Hello, World!"));

Official Extensions

The official extensions of this library will be listed below.

CIT Crypto is an extension that adds cryptographic message translators.
CIT Logger is an extension that implements Messaging and adds an API for logging.
CIT Network is an extension that adds binary messages and an API for sessions etc.
CIT Server is an extension that implements Messaging and adds an API for server development.
CIT Server MINA is an extension that extends the CIT Server extension with an Apache MINA server.