You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@mina.apache.org by el...@apache.org on 2012/10/22 19:34:40 UTC
svn commit: r1400968 - in
/mina/site/trunk/content/mina/userguide/ch3-service: ch3-service.mdtext
io-service-details.mdtext io-service.mdtext
Author: elecharny
Date: Mon Oct 22 17:34:40 2012
New Revision: 1400968
URL: http://svn.apache.org/viewvc?rev=1400968&view=rev
Log:
Added the scrollbar for each chapter 3 sub-chapters
Modified:
mina/site/trunk/content/mina/userguide/ch3-service/ch3-service.mdtext
mina/site/trunk/content/mina/userguide/ch3-service/io-service-details.mdtext
mina/site/trunk/content/mina/userguide/ch3-service/io-service.mdtext
Modified: mina/site/trunk/content/mina/userguide/ch3-service/ch3-service.mdtext
URL: http://svn.apache.org/viewvc/mina/site/trunk/content/mina/userguide/ch3-service/ch3-service.mdtext?rev=1400968&r1=1400967&r2=1400968&view=diff
==============================================================================
--- mina/site/trunk/content/mina/userguide/ch3-service/ch3-service.mdtext (original)
+++ mina/site/trunk/content/mina/userguide/ch3-service/ch3-service.mdtext Mon Oct 22 17:34:40 2012
@@ -22,11 +22,11 @@ Notice: Licensed to the Apache Softwa
specific language governing permissions and limitations
under the License.
-# Chapter 3 - Service
+# Chapter 3 - IoService
-A MINA Service is the base class supporting all the IO services, either from the server side or the client side. It's an interface, which is implemented as an IoAcceptor for the server side, and IoConnector for the client side.
+A **MINA** _IoService_ is the base class supporting all the **IO** services, either from the server side or the client side. It's an interface, which is implemented as an _IoAcceptor_ for the server side, and _IoConnector_ for the client side.
A service not only processes incoming or outgoing messages, it also manage connections, sessions, and calls the application.
-* [IoService introduction](io-service.html)
-* [IO Service](io-service-details.html)
+* [IoService Introduction](io-service.html)
+* [IoService Details](io-service-details.html)
Modified: mina/site/trunk/content/mina/userguide/ch3-service/io-service-details.mdtext
URL: http://svn.apache.org/viewvc/mina/site/trunk/content/mina/userguide/ch3-service/io-service-details.mdtext?rev=1400968&r1=1400967&r2=1400968&view=diff
==============================================================================
--- mina/site/trunk/content/mina/userguide/ch3-service/io-service-details.mdtext (original)
+++ mina/site/trunk/content/mina/userguide/ch3-service/io-service-details.mdtext Mon Oct 22 17:34:40 2012
@@ -1,4 +1,8 @@
Title: IO Service
+NavUp: ch3-service.html
+NavUpText: Chapter 3 - Service
+NavPrev: io-service.html
+NavPrevText: IoService Introduction
Notice: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
@@ -16,7 +20,7 @@ Notice: Licensed to the Apache Softwa
specific language governing permissions and limitations
under the License.
-# Introduction
+# IoService Details
IoService is an interface that is implemented by the two most important classes in MINA :
Modified: mina/site/trunk/content/mina/userguide/ch3-service/io-service.mdtext
URL: http://svn.apache.org/viewvc/mina/site/trunk/content/mina/userguide/ch3-service/io-service.mdtext?rev=1400968&r1=1400967&r2=1400968&view=diff
==============================================================================
--- mina/site/trunk/content/mina/userguide/ch3-service/io-service.mdtext (original)
+++ mina/site/trunk/content/mina/userguide/ch3-service/io-service.mdtext Mon Oct 22 17:34:40 2012
@@ -1,4 +1,8 @@
Title: IO Service
+NavUp: ch3-service.html
+NavUpText: Chapter 3 - Service
+NavNext: io-service-details.html
+NavNextText: IoService Details
Notice: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
@@ -16,19 +20,19 @@ Notice: Licensed to the Apache Softwa
specific language governing permissions and limitations
under the License.
-# Overview
+# IoService Introduction
-[IoService](http://mina.apache.org/report/trunk/xref/org/apache/mina/core/service/IoService.html) provides basic I/O Service and manages I/O Sessions within MINA. Its one of the most crucial part of MINA Architecture. The implementing classes of IoService and child interface, are where most of the low level I/O operations are handled.
+[IoService](http://mina.apache.org/report/trunk/xref/org/apache/mina/core/service/IoService.html) provides basic I/O Service and manages **I/O** Sessions within **MINA**. Its one of the most crucial part of **MINA** Architecture. The implementing classes of _IoService_ and child interface, are where most of the low level **I/O** operations are handled.
# IoService Mind Map
-Lets try to see what are the responsibilities of the IoService and it implementing class [AbstractIoService](http://mina.apache.org/report/trunk/xref/org/apache/mina/core/service/AbstractIoService.html). Lets take a slightly different approach of first using a [Mind Map](http://en.wikipedia.org/wiki/Mind_map) and then jump into the inner working. The Mind Map was created using [XMind](http://www.xmind.net/).
+Lets try to see what are the responsibilities of the _IoService_ and it implementing class [AbstractIoService](http://mina.apache.org/report/trunk/xref/org/apache/mina/core/service/AbstractIoService.html). Lets take a slightly different approach of first using a [Mind Map](http://en.wikipedia.org/wiki/Mind_map) and then jump into the inner working. The Mind Map was created using [XMind](http://www.xmind.net/).
## Interface Details
-IoService is the base interface for all the IoConnector's and IoAcceptor's that provides I/O services and manages I/O sessions. The interface has all the functions need to perform I/O related operations.
+_IoService_ is the base interface for all the _IoConnector_'s and _IoAcceptor_'s that provides **I/O** services and manages **I/O** sessions. The interface has all the functions need to perform **I/O** related operations.
Lets take a deep dive into the various methods in the interface
@@ -56,15 +60,15 @@ Lets take a deep dive into the various m
### getTransportMetadata()
-This method returns the Transport meta-data the Acceptor or Connector is running. The typical details include provider name (nio, apr, rxtx), connection type (connectionless/connection oriented) etc.
+This method returns the Transport meta-data the _IoAcceptor_ or _IoConnector_ is running. The typical details include provider name (nio, apr, rxtx), connection type (connectionless/connection oriented) etc.
### addListener
-Allows to add a IoServiceListener to listen to specific events related to Ioservice.
+Allows to add a _IoServiceListener_ to listen to specific events related to _IoService_.
### removeListener
-Removes specified IoServiceListener attached to this IoService.
+Removes specified _IoServiceListener_ attached to this _IoService_.
### isDisposing
@@ -76,17 +80,17 @@ This method tells if the service has bee
### dispose
-This method releases all the resources the service has allocated. As it may take a while, the user should check the service status using the isDisposing() and isDisposed() to know if the service is now disposed completely.
+This method releases all the resources the service has allocated. As it may take a while, the user should check the service status using the _isDisposing()_ and _isDisposed()_ to know if the service is now disposed completely.
-Always call dispose() when you shutdown a service !
+Always call _dispose()_ when you shutdown a service !
### getHandler
-Returns the IoHandler associated with the service.
+Returns the _IoHandler_ associated with the service.
### setHandler
-Sets the IoHandler that will be responsible for handling all the events for the service. The handler contains your application logic !
+Sets the _IoHandler_ that will be responsible for handling all the events for the service. The handler contains your application logic !
### getManagedSessions
@@ -102,15 +106,15 @@ Returns the session configuration.
### getFilterChainBuilder
-Returns the Filter chain builder. This is useful if one wants to add some new filter that will be injected when the sessions will be created.
+Returns the _Filter_ chain builder. This is useful if one wants to add some new filter that will be injected when the sessions will be created.
### setFilterChainBuilder
-Defines the Filter chain builder to use with the service.
+Defines the _Filter_ chain builder to use with the service.
### getFilterChain
-Returns the current default Filter chain for the service.
+Returns the current default _Filter_ chain for the service.
### isActive
@@ -126,7 +130,7 @@ Writes the given message to all the mana
### setSessionDataStructureFactory
-Sets the IoSessionDataStructureFactory that provides related data structures for a new session created by this service.
+Sets the _IoSessionDataStructureFactory_ that provides related data structures for a new session created by this service.
### getScheduledWriteBytes
@@ -138,5 +142,5 @@ Returns the number of messages scheduled
### getStatistics
-Returns the IoServiceStatistics object for this service.
+Returns the _IoServiceStatistics_ object for this service.