This is an automated email from the ASF dual-hosted git repository.
elecharny pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/mina-site.git
The following commit(s) were added to refs/heads/master by this push:
new 8845f0314 Added info about TLS, updated the session page, fixed some
links
8845f0314 is described below
commit 8845f0314f51d8d4edb6afc6beeb33a6483925b0
Author: emmanuel lecharny <[email protected]>
AuthorDate: Mon Sep 16 09:40:09 2024 +0200
Added info about TLS, updated the session page, fixed some links
---
source/mina-project/documentation.md | 4 +-
.../technical-documentation/ssl-tls-internal.md | 2 +-
.../userguide/ch4-session/ch4-session.md | 72 +++++++++++-----------
3 files changed, 39 insertions(+), 39 deletions(-)
diff --git a/source/mina-project/documentation.md
b/source/mina-project/documentation.md
index c88281e0d..7a6b95ba3 100644
--- a/source/mina-project/documentation.md
+++ b/source/mina-project/documentation.md
@@ -6,7 +6,7 @@ title: Documentation
# Documentation
<div class="note" markdown="1">
- The MINA 2.0 User Guide can be found here : [User
Guide](userguide/user-guide-toc.html)
+ The MINA 2.0 User Guide can be found here : <a
href="userguide/user-guide-toc.html">User Guide</a>[User Guide]()
</div>
{{% toc %}}
@@ -49,7 +49,7 @@ You might also want to read the [frequently asked
questions](faq.html] and learn
* [Using an Executor
Filter](userguide/ch10-executor-filter/ch10-executor-filter.html) - Controlling
the size of thread pool and choosing the right thread model
* [JMX Integration](userguide/ch16-jmx-support/ch16-jmx-support.html) -
Making your network application manageable
* [Introduction to
mina-statemachine](userguide/ch14-state-machine/ch14-state-machine.html) -
Implementing state machine based MINA applications using Java5 annotations
-* [User Guide](userguide/user-guide-toc.html) - The new draft MINA User Guide.
+* [User Guide](userguide/user-guide-toc.html) - The new **MINA 2.0** User
Guide.
### For Developers
diff --git a/source/mina-project/technical-documentation/ssl-tls-internal.md
b/source/mina-project/technical-documentation/ssl-tls-internal.md
index 7a32f55c3..69cf78412 100644
--- a/source/mina-project/technical-documentation/ssl-tls-internal.md
+++ b/source/mina-project/technical-documentation/ssl-tls-internal.md
@@ -27,7 +27,7 @@ When injecting the **SslFilter** into your chain, either
before starting your se
Most of the time, both phases will be merged, as one can tell the first phase
to immediately starts the second.
-In any case, it's handled by the __onPreAdd__ and __onPostAdd_ events, which
means it's automatically processed when you push the **SslFilter** into the
chain.
+In any case, it's handled by the __onPreAdd__ and __onPostAdd__ events, which
means it's automatically processed when you push the **SslFilter** into the
chain.
### onPreAdd
diff --git a/source/mina-project/userguide/ch4-session/ch4-session.md
b/source/mina-project/userguide/ch4-session/ch4-session.md
index 7e6e4a399..1c8188859 100644
--- a/source/mina-project/userguide/ch4-session/ch4-session.md
+++ b/source/mina-project/userguide/ch4-session/ch4-session.md
@@ -32,17 +32,17 @@ In other words, don't call session.read(). Never.
A session has a state, which will evolve during time.
-* Created : the session has just been created
-* Connected : the session has been created and is available
-* Idle : the session hasn't processed any request for at least a period of
time (this period is configurable)
- * Idle for read : no read has actually been made for a period of time
- * Idle for write : no write has actually been made for a period of time
- * Idle for both : no read nor write for a period of time
-* Secured : the TLS layer has been initialised
-* Unsecured : The TLS layer has been shut down
-* Closing : the session is being closed (the remaining messages are being
flushed, cleaning up is not terminated)
-* Input closed : the input part of the socket has been closed
-* Closed : The session is now closed, nothing else can be done to revive it.
This is actually not a real state : when teh session is closed, it's removed.
+* _Created_ : the session has just been created
+* _Connected_ : the session has been created and is available
+* _Idle _: the session hasn't processed any request for at least a period of
time (this period is configurable)
+ * Idle for read_ : no read has actually been made for a period of time
+ * Idle for write_ : no write has actually been made for a period of time
+ * Idle for both_ : no read nor write for a period of time
+* _Secured_ : the TLS layer has been initialised
+* _Unsecured_ : The TLS layer has been shut down
+* _Closing_ : the session is being closed (the remaining messages are being
flushed, cleaning up is not terminated)
+* _Input closed_ : the input part of the socket has been closed
+* _Closed_ : The session is now closed, nothing else can be done to revive it.
This is actually not a real state : when teh session is closed, it's removed.
The following state diagram exposes all the possible states and transitions :
@@ -52,18 +52,18 @@ We have a set of methods to get some information about the
session status.
Session status :
-* isActive() : tells if the session is valid (it might mean different things
depending on the implementation)
-* isBothIdle() : tells if the session is idling on reads and writes
-* isClosing() : tells if the session is already being closed
-* isConnected() : tells if the session is active (ie, not in the closing mode)
-* isIdle( idling status ) : tells if the session is idling on a specific state
(read or write)
-* isReadIdle() : tells if the session is idling on reads
-* isReadSuspended() : tells if the session is not allowed to read messsages
-* isScheduledForFlush() : tells if the session has pending messages that are
to be written
-* isSecured() : tells if teh TLS layer is active and initialized
-* isServer() : tells if the session is on the server side
-* isWriteIdle() : tells if the session is idling on writes
-* isWriteSuspended() : tells if the session is not allowed to write messsages
+* _isActive()_ : tells if the session is valid (it might mean different things
depending on the implementation)
+* _isBothIdle()_ : tells if the session is idling on reads and writes
+* _isClosing()_ : tells if the session is already being closed
+* _isConnected()_ : tells if the session is active (ie, not in the closing
mode)
+* _isIdle( idling status )_ : tells if the session is idling on a specific
state (read or write)
+* _isReadIdle()_ : tells if the session is idling on reads
+* _isReadSuspended()_ : tells if the session is not allowed to read messsages
+* _isScheduledForFlush()_ : tells if the session has pending messages that are
to be written
+* _isSecured()_ : tells if teh TLS layer is active and initialized
+* _isServer()_ : tells if the session is on the server side
+* _isWriteIdle()_ : tells if the session is idling on writes
+* _isWriteSuspended()_ : tells if the session is not allowed to write messsages
## Opening a session
@@ -94,9 +94,9 @@ session = connector.connect(address).getSession();
## Initialization
-When a new session is created, it has to be initialized. This is done using
the default IoService configuration, but you can update this configuration
later on. Actually, when the session is created, we internally create a copy of
the default IoService configuration that is stored within the session, and this
is this configuration instance that will be used (and that can be modified).
+When a new session is created, it has to be initialized. This is done using
the default _IoService_ configuration, but you can update this configuration
later on. Actually, when the session is created, we internally create a copy of
the default _IoService_ configuration that is stored within the session, and
this is this configuration instance that will be used (and that can be
modified).
-This initialization will also starts the statistics counters, create the
Attributes container, associate a write queue to to the session (this is where
the messages will be enqueued until they have been sent), and ultimately, would
you have provided a specific task to do during this phase, it will call it.
+This initialization will also starts the statistics counters, create the
_Attributes_ container, associate a write queue to to the session (this is
where the messages will be enqueued until they have been sent), and ultimately,
would you have provided a specific task to do during this phase, it will call
it.
## Closing a session
@@ -204,17 +204,17 @@ public interface IoSessionDataStructureFactory {
There are many methods available to manipulate the session's attributes :
-* boolean containsAttribute(Object key) : tells if a given attribute is present
-* Object getAttribute(Object key) : gets the value for a given attribute
-* Object getAttribute(Object key, Object defaultValue) : gets the value for a
given attribute, or a default value if absent
-* Set{{< html "<" >}}Object{{< html ">" >}} getAttributeKeys() : gets
the set of all the stored attributes
-* Object removeAttribute(Object key) : remove a given attribute
-* boolean removeAttribute(Object key, Object value) : remove a given
attribute/value pair
-* boolean replaceAttribute(Object key, Object oldValue, Object newValue) :
replace a give attribute/value pair
-* Object setAttribute(Object key) : adds a new attribute with no value
-* Object setAttribute(Object key, Object value) : adds a new attribute/value
pair
-* Object setAttributeIfAbsent(Object key) : adds a new attribute with no
value, if it does not already exist
-* Object setAttributeIfAbsent(Object key, Object value) : adds a new
attribute/value pair, if it does not already exist
+* _boolean containsAttribute(Object key)_ : tells if a given attribute is
present
+* _Object getAttribute(Object key)_ : gets the value for a given attribute
+* _Object getAttribute(Object key, Object defaultValue)_ : gets the value for
a given attribute, or a default value if absent
+* _Set{{< html "<" >}}Object{{< html ">" >}} getAttributeKeys()_ : gets
the set of all the stored attributes
+* _Object removeAttribute(Object key)_ : remove a given attribute
+* _boolean removeAttribute(Object key, Object value)_ : remove a given
attribute/value pair
+* _boolean replaceAttribute(Object key, Object oldValue, Object newValue)_ :
replace a give attribute/value pair
+* _Object setAttribute(Object key)_ : adds a new attribute with no value
+* _Object setAttribute(Object key, Object value)_ : adds a new attribute/value
pair
+* _Object setAttributeIfAbsent(Object key)_ : adds a new attribute with no
value, if it does not already exist
+* _Object setAttributeIfAbsent(Object key, Object value)_ : adds a new
attribute/value pair, if it does not already exist
All those methods allows your application to store, remove, get or update the
attributes stored into your session. Also note that some attributes are used
internally by MINA : don't lightly modify those you didn't create !
