You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@mina.apache.org by "Bogdan Pistol (JIRA)" <ji...@apache.org> on 2010/01/08 13:10:55 UTC
[jira] Created: (DIRMINA-754) Javadoc omission in
IoFilterChain#fireMessageSent()
Javadoc omission in IoFilterChain#fireMessageSent()
---------------------------------------------------
Key: DIRMINA-754
URL: https://issues.apache.org/jira/browse/DIRMINA-754
Project: MINA
Issue Type: Improvement
Components: Core
Affects Versions: 2.0.0-RC1
Environment: N/A
Reporter: Bogdan Pistol
Priority: Trivial
Fix For: 2.0.0-RC1
The javadoc of the org.apache.mina.core.filterchain.IoFilterChain#fireMessageSent() is
/**
* Fires a {@link IoHandler#sessionOpened(IoSession)} event. Most users don't need to call
* this method at all. Please use this method only when you implement a new transport or
* fire a virtual event.
*/
public void fireMessageSent(WriteRequest request);
And instead a better javadoc would be:
/**
* Fires a {@link IoHandler#messageSent(IoSession, Object)} event. Most users don't need to call
* this method at all. Please use this method only when you implement a new transport or
* fire a virtual event.
*/
public void fireMessageSent(WriteRequest request);
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
[jira] Updated: (DIRMINA-754) Javadoc omission in
IoFilterChain#fireMessageSent()
Posted by "Emmanuel Lecharny (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/DIRMINA-754?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Emmanuel Lecharny updated DIRMINA-754:
--------------------------------------
Fix Version/s: (was: 2.0.0-RC1)
2.0.0-RC2
Move to RC2. RC1 has been released.
> Javadoc omission in IoFilterChain#fireMessageSent()
> ---------------------------------------------------
>
> Key: DIRMINA-754
> URL: https://issues.apache.org/jira/browse/DIRMINA-754
> Project: MINA
> Issue Type: Improvement
> Components: Core
> Affects Versions: 2.0.0-RC1
> Environment: N/A
> Reporter: Bogdan Pistol
> Priority: Trivial
> Fix For: 2.0.0-RC2
>
>
> The javadoc of the org.apache.mina.core.filterchain.IoFilterChain#fireMessageSent() is
> /**
> * Fires a {@link IoHandler#sessionOpened(IoSession)} event. Most users don't need to call
> * this method at all. Please use this method only when you implement a new transport or
> * fire a virtual event.
> */
> public void fireMessageSent(WriteRequest request);
> And instead a better javadoc would be:
> /**
> * Fires a {@link IoHandler#messageSent(IoSession, Object)} event. Most users don't need to call
> * this method at all. Please use this method only when you implement a new transport or
> * fire a virtual event.
> */
> public void fireMessageSent(WriteRequest request);
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
[jira] Updated: (DIRMINA-754) Javadoc omission in
IoFilterChain#fireMessageSent()
Posted by "Emmanuel Lecharny (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/DIRMINA-754?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Emmanuel Lecharny updated DIRMINA-754:
--------------------------------------
Fix Version/s: (was: 2.0.0-RC2)
2.0.0
> Javadoc omission in IoFilterChain#fireMessageSent()
> ---------------------------------------------------
>
> Key: DIRMINA-754
> URL: https://issues.apache.org/jira/browse/DIRMINA-754
> Project: MINA
> Issue Type: Improvement
> Components: Core
> Affects Versions: 2.0.0-RC1
> Environment: N/A
> Reporter: Bogdan Pistol
> Assignee: Emmanuel Lecharny
> Priority: Trivial
> Fix For: 2.0.0
>
>
> The javadoc of the org.apache.mina.core.filterchain.IoFilterChain#fireMessageSent() is
> /**
> * Fires a {@link IoHandler#sessionOpened(IoSession)} event. Most users don't need to call
> * this method at all. Please use this method only when you implement a new transport or
> * fire a virtual event.
> */
> public void fireMessageSent(WriteRequest request);
> And instead a better javadoc would be:
> /**
> * Fires a {@link IoHandler#messageSent(IoSession, Object)} event. Most users don't need to call
> * this method at all. Please use this method only when you implement a new transport or
> * fire a virtual event.
> */
> public void fireMessageSent(WriteRequest request);
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
[jira] Assigned: (DIRMINA-754) Javadoc omission in
IoFilterChain#fireMessageSent()
Posted by "Emmanuel Lecharny (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/DIRMINA-754?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Emmanuel Lecharny reassigned DIRMINA-754:
-----------------------------------------
Assignee: Emmanuel Lecharny
> Javadoc omission in IoFilterChain#fireMessageSent()
> ---------------------------------------------------
>
> Key: DIRMINA-754
> URL: https://issues.apache.org/jira/browse/DIRMINA-754
> Project: MINA
> Issue Type: Improvement
> Components: Core
> Affects Versions: 2.0.0-RC1
> Environment: N/A
> Reporter: Bogdan Pistol
> Assignee: Emmanuel Lecharny
> Priority: Trivial
> Fix For: 2.0.0-RC2
>
>
> The javadoc of the org.apache.mina.core.filterchain.IoFilterChain#fireMessageSent() is
> /**
> * Fires a {@link IoHandler#sessionOpened(IoSession)} event. Most users don't need to call
> * this method at all. Please use this method only when you implement a new transport or
> * fire a virtual event.
> */
> public void fireMessageSent(WriteRequest request);
> And instead a better javadoc would be:
> /**
> * Fires a {@link IoHandler#messageSent(IoSession, Object)} event. Most users don't need to call
> * this method at all. Please use this method only when you implement a new transport or
> * fire a virtual event.
> */
> public void fireMessageSent(WriteRequest request);
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
[jira] Resolved: (DIRMINA-754) Javadoc omission in
IoFilterChain#fireMessageSent()
Posted by "Emmanuel Lecharny (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/DIRMINA-754?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Emmanuel Lecharny resolved DIRMINA-754.
---------------------------------------
Resolution: Fixed
Fixed in http://svn.apache.org/viewvc?rev=898585&view=rev
I completely reviewed the doco for the whole class. What a mess it was !
> Javadoc omission in IoFilterChain#fireMessageSent()
> ---------------------------------------------------
>
> Key: DIRMINA-754
> URL: https://issues.apache.org/jira/browse/DIRMINA-754
> Project: MINA
> Issue Type: Improvement
> Components: Core
> Affects Versions: 2.0.0-RC1
> Environment: N/A
> Reporter: Bogdan Pistol
> Assignee: Emmanuel Lecharny
> Priority: Trivial
> Fix For: 2.0.0-RC2
>
>
> The javadoc of the org.apache.mina.core.filterchain.IoFilterChain#fireMessageSent() is
> /**
> * Fires a {@link IoHandler#sessionOpened(IoSession)} event. Most users don't need to call
> * this method at all. Please use this method only when you implement a new transport or
> * fire a virtual event.
> */
> public void fireMessageSent(WriteRequest request);
> And instead a better javadoc would be:
> /**
> * Fires a {@link IoHandler#messageSent(IoSession, Object)} event. Most users don't need to call
> * this method at all. Please use this method only when you implement a new transport or
> * fire a virtual event.
> */
> public void fireMessageSent(WriteRequest request);
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
[jira] Commented: (DIRMINA-754) Javadoc omission in
IoFilterChain#fireMessageSent()
Posted by "Emmanuel Lecharny (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/DIRMINA-754?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12797999#action_12797999 ]
Emmanuel Lecharny commented on DIRMINA-754:
-------------------------------------------
IMO, looking at the current Javadoc, ad the current impl I think it's totally FU :/
The DefaultIoFilterChain method fireMessageSent( WriteRequest) does :
public void fireMessageSent(WriteRequest request) {
... (blah)
Entry head = this.head;
callNextMessageSent(head, session, request);
}
private void callNextMessageSent(Entry entry, IoSession session,
WriteRequest writeRequest) {
try {
IoFilter filter = entry.getFilter();
NextFilter nextFilter = entry.getNextFilter();
filter.messageSent(nextFilter, session,
writeRequest);
} catch (Throwable e) {
fireExceptionCaught(e);
}
}
We see that we move to the head of the filter chain, and call the messageSent( filter, session, request ) from he beginning.
It has nothing to do with IoHandler at this point.
I would rather replace the Javadoc by something like :
/**
* Fires a {@link IoFilter#messageSent(NextFilter, IoSession, Object)} event. Most users don't need to call
* this method at all. Please use this method only when you implement a new transport or
* fire a virtual event.
*/
wdyt ?
(The very same for all the other methods, btw)
> Javadoc omission in IoFilterChain#fireMessageSent()
> ---------------------------------------------------
>
> Key: DIRMINA-754
> URL: https://issues.apache.org/jira/browse/DIRMINA-754
> Project: MINA
> Issue Type: Improvement
> Components: Core
> Affects Versions: 2.0.0-RC1
> Environment: N/A
> Reporter: Bogdan Pistol
> Priority: Trivial
> Fix For: 2.0.0-RC1
>
>
> The javadoc of the org.apache.mina.core.filterchain.IoFilterChain#fireMessageSent() is
> /**
> * Fires a {@link IoHandler#sessionOpened(IoSession)} event. Most users don't need to call
> * this method at all. Please use this method only when you implement a new transport or
> * fire a virtual event.
> */
> public void fireMessageSent(WriteRequest request);
> And instead a better javadoc would be:
> /**
> * Fires a {@link IoHandler#messageSent(IoSession, Object)} event. Most users don't need to call
> * this method at all. Please use this method only when you implement a new transport or
> * fire a virtual event.
> */
> public void fireMessageSent(WriteRequest request);
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
[jira] Commented: (DIRMINA-754) Javadoc omission in
IoFilterChain#fireMessageSent()
Posted by "Bogdan Pistol (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/DIRMINA-754?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12798143#action_12798143 ]
Bogdan Pistol commented on DIRMINA-754:
---------------------------------------
You're right, the IoFilter#messageSent() better describes the event, the IoHandler#messageSent() is called as consequence from the DefaultIoFilterChain#messageSent()
> Javadoc omission in IoFilterChain#fireMessageSent()
> ---------------------------------------------------
>
> Key: DIRMINA-754
> URL: https://issues.apache.org/jira/browse/DIRMINA-754
> Project: MINA
> Issue Type: Improvement
> Components: Core
> Affects Versions: 2.0.0-RC1
> Environment: N/A
> Reporter: Bogdan Pistol
> Priority: Trivial
> Fix For: 2.0.0-RC2
>
>
> The javadoc of the org.apache.mina.core.filterchain.IoFilterChain#fireMessageSent() is
> /**
> * Fires a {@link IoHandler#sessionOpened(IoSession)} event. Most users don't need to call
> * this method at all. Please use this method only when you implement a new transport or
> * fire a virtual event.
> */
> public void fireMessageSent(WriteRequest request);
> And instead a better javadoc would be:
> /**
> * Fires a {@link IoHandler#messageSent(IoSession, Object)} event. Most users don't need to call
> * this method at all. Please use this method only when you implement a new transport or
> * fire a virtual event.
> */
> public void fireMessageSent(WriteRequest request);
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.