Java Doc for MessageDecoder.java in  » Net » mina-2.0.0-M1 » org » apache » mina » filter » codec » demux » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » Net » mina 2.0.0 M1 » org.apache.mina.filter.codec.demux 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


org.apache.mina.filter.codec.demux.MessageDecoder

All known Subclasses:   org.apache.mina.example.sumup.codec.AbstractMessageDecoder,  org.apache.mina.filter.codec.demux.MessageDecoderAdapter,
MessageDecoder
public interface MessageDecoder (Code)
Decodes a certain type of messages.

We didn't provide any dispose method for MessageDecoder because it can give you performance penalty in case you have a lot of message types to handle.
author:
   The Apache MINA Project (dev@mina.apache.org)
version:
   $Rev: 590006 $, $Date: 2007-10-30 03:44:02 -0600 (Tue, 30 Oct 2007) $
See Also:   DemuxingProtocolDecoder
See Also:   MessageDecoderFactory



Field Summary
static  MessageDecoderResultNEED_DATA
     Represents a result from MessageDecoder.decodable(IoSession,IoBuffer) and MessageDecoder.decode(IoSession,IoBuffer,ProtocolDecoderOutput) .
static  MessageDecoderResultNOT_OK
     Represents a result from MessageDecoder.decodable(IoSession,IoBuffer) and MessageDecoder.decode(IoSession,IoBuffer,ProtocolDecoderOutput) .
static  MessageDecoderResultOK
     Represents a result from MessageDecoder.decodable(IoSession,IoBuffer) and MessageDecoder.decode(IoSession,IoBuffer,ProtocolDecoderOutput) .


Method Summary
 MessageDecoderResultdecodable(IoSession session, IoBuffer in)
     Checks the specified buffer is decodable by this decoder.
 MessageDecoderResultdecode(IoSession session, IoBuffer in, ProtocolDecoderOutput out)
     Decodes binary or protocol-specific content into higher-level message objects.
 voidfinishDecode(IoSession session, ProtocolDecoderOutput out)
     Invoked when the specified session is closed while this decoder was parsing the data.

Field Detail
NEED_DATA
static MessageDecoderResult NEED_DATA(Code)
Represents a result from MessageDecoder.decodable(IoSession,IoBuffer) and MessageDecoder.decode(IoSession,IoBuffer,ProtocolDecoderOutput) . Please refer to each method's documentation for detailed explanation.



NOT_OK
static MessageDecoderResult NOT_OK(Code)
Represents a result from MessageDecoder.decodable(IoSession,IoBuffer) and MessageDecoder.decode(IoSession,IoBuffer,ProtocolDecoderOutput) . Please refer to each method's documentation for detailed explanation.



OK
static MessageDecoderResult OK(Code)
Represents a result from MessageDecoder.decodable(IoSession,IoBuffer) and MessageDecoder.decode(IoSession,IoBuffer,ProtocolDecoderOutput) . Please refer to each method's documentation for detailed explanation.





Method Detail
decodable
MessageDecoderResult decodable(IoSession session, IoBuffer in)(Code)
Checks the specified buffer is decodable by this decoder. MessageDecoder.OK if this decoder can decode the specified buffer.MessageDecoder.NOT_OK if this decoder cannot decode the specified buffer.MessageDecoder.NEED_DATA if more data is required to determine if thespecified buffer is decodable (MessageDecoder.OK) or not decodableMessageDecoder.NOT_OK.



decode
MessageDecoderResult decode(IoSession session, IoBuffer in, ProtocolDecoderOutput out) throws Exception(Code)
Decodes binary or protocol-specific content into higher-level message objects. MINA invokes MessageDecoder.decode(IoSession,IoBuffer,ProtocolDecoderOutput) method with read data, and then the decoder implementation puts decoded messages into ProtocolDecoderOutput . MessageDecoder.OK if you finished decoding messages successfully.MessageDecoder.NEED_DATA if you need more data to finish decoding current message.MessageDecoder.NOT_OK if you cannot decode current message due to protocol specification violation.
throws:
  Exception - if the read data violated protocol specification



finishDecode
void finishDecode(IoSession session, ProtocolDecoderOutput out) throws Exception(Code)
Invoked when the specified session is closed while this decoder was parsing the data. This method is useful when you deal with the protocol which doesn't specify the length of a message such as HTTP response without content-length header. Implement this method to process the remaining data that MessageDecoder.decode(IoSession,IoBuffer,ProtocolDecoderOutput) method didn't process completely.
throws:
  Exception - if the read data violated protocol specification



www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.