Documentation

Presentation Materials

These presentation materials will help you understand the overall architecture and core constructs of MINA

There are currently three branches in MINA:

JavaDoc	Source Code	Description
1.0.x	main, test	The officially recommended production-ready branch. Please use this branch unless you are an experienced MINA user.
1.1.x	main, test	Java 5 port of 1.0 without any new feature addition. Please use this branch if you run your applications on Java 5.
Trunk	main, test	The bleeding-edge branch with a lot of work going on. If you are interested in MINA development or brave enough to try new API and features, this is yours.

You might also want to read the frequently asked questions and learn how to contact us before getting started.

The tutorials are provided for two branches, 1.x and 2.x, due to the backward incompatibilities between the APIs.

Version 1.x - Hard-Boiled Wonderland and the End of the World Version 2.x - Norweigian Wood

MINA v1.x Quick Start Guide - Creating your first MINA based program
Logging Configuration - Configuring your MINA-based application for logging
Transport-specific Configuration
- UDP Tutorial - Writing a User Datagram Protocol (UDP) client and server using MINA
Advanced Topic
- Writing IoFilter - Writing your own IoFilter implementation to deal with cross-cutting concerns
- Writing Protocol Codec - Implementing a protocol codec for separation of concern
- Configuring Thread Model - Controlling the size of thread pool and choosing the right thread model
- JMX Integration - Making your network application manageable
Coming soon! (not written yet)
- Overall Architecture
- Basic Constructs
  - ByteBuffer
  - IoService
  - IoHandler
  - IoFilter
  - IoFuture
- Advanced Topic
  - Unit-testing
  - Performance Tips

Changes Between 2.x and 1.x
MINA v2.0 Quick Start Guide - Create your first MINA based program using MINA version 2.0
Logging Configuration - Configuring your MINA-based application for logging
Transport-specific Configuration
- Serial Tutorial - Serial communications with MINA trunk
- UDP Tutorial - Writing a User Datagram Protocol (UDP) client and server using MINA
Advanced Topic
- Writing IoFilter - Writing your own IoFilter implementation to deal with cross-cutting concerns
- Writing Protocol Codec for MINA 2.x - Implementing a protocol codec for separation of concern
- Configuring Thread Model - Controlling the size of thread pool and choosing the right thread model
- JMX Integration - Making your network application manageable
- Introduction to mina-statemachine - Implementing state machine based MINA applications using Java5 annotations
- ErrorGeneratingFilter Tutorial - Simulating newtork error by adding a ErrorGeneratingFiler.
Coming soon! (not written yet)
- Overall Architecture
- Basic Constructs
  - ByteBuffer
  - IoService
  - IoHandler
  - IoFilter
  - IoFuture
- Advanced Topic
  - Unit-testing
  - Performance Tips

You can browse all examples here.

Name	Feature it demonstrates	Side
Reverser	Text protocol based on a protocol codec	Server
SumUp server	Complex binary protocol based on a protocol codec	Both
Echo server	Low-level I/O and SSL	Server
NetCat	Client programming	Client
HTTP server	Stream-based synchronous I/O	Server
Tennis	In-VM pipe communication	Both
Chat server	Spring integration	Both
Proxy	Resending received bytes on another session.	Both