📄 protocolencoderoutput.html
字号:
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"><!--NewPage--><HTML><HEAD><!-- Generated by javadoc (build 1.6.0_04) on Tue Feb 19 10:50:43 MST 2008 --><META http-equiv="Content-Type" content="text/html; charset=UTF-8"><TITLE>ProtocolEncoderOutput (Apache MINA 2.0.0-M1 API Documentation)</TITLE><META NAME="date" CONTENT="2008-02-19"><LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style"><SCRIPT type="text/javascript">function windowTitle(){ if (location.href.indexOf('is-external=true') == -1) { parent.document.title="ProtocolEncoderOutput (Apache MINA 2.0.0-M1 API Documentation)"; }}</SCRIPT><NOSCRIPT></NOSCRIPT></HEAD><BODY BGCOLOR="white" onload="windowTitle();"><HR><!-- ========= START OF TOP NAVBAR ======= --><A NAME="navbar_top"><!-- --></A><A HREF="#skip-navbar_top" title="Skip navigation links"></A><TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""><TR><TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"><A NAME="navbar_top_firstrow"><!-- --></A><TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> <TR ALIGN="center" VALIGN="top"> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/ProtocolEncoderOutput.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> </TR></TABLE></TD><TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM></EM></TD></TR><TR><TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../../../org/apache/mina/filter/codec/ProtocolEncoderException.html" title="class in org.apache.mina.filter.codec"><B>PREV CLASS</B></A> <A HREF="../../../../../org/apache/mina/filter/codec/RecoverableProtocolDecoderException.html" title="class in org.apache.mina.filter.codec"><B>NEXT CLASS</B></A></FONT></TD><TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../../../index.html?org/apache/mina/filter/codec/ProtocolEncoderOutput.html" target="_top"><B>FRAMES</B></A> <A HREF="ProtocolEncoderOutput.html" target="_top"><B>NO FRAMES</B></A> <SCRIPT type="text/javascript"> <!-- if(window==top) { document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>'); } //--></SCRIPT><NOSCRIPT> <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A></NOSCRIPT></FONT></TD></TR><TR><TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD><TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD></TR></TABLE><A NAME="skip-navbar_top"></A><!-- ========= END OF TOP NAVBAR ========= --><HR><!-- ======== START OF CLASS DATA ======== --><H2><FONT SIZE="-1">org.apache.mina.filter.codec</FONT><BR>Interface ProtocolEncoderOutput</H2><DL><DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../../../org/apache/mina/filter/codec/AbstractProtocolEncoderOutput.html" title="class in org.apache.mina.filter.codec">AbstractProtocolEncoderOutput</A></DD></DL><HR><DL><DT><PRE>public interface <B>ProtocolEncoderOutput</B></DL></PRE><P>Callback for <A HREF="../../../../../org/apache/mina/filter/codec/ProtocolEncoder.html" title="interface in org.apache.mina.filter.codec"><CODE>ProtocolEncoder</CODE></A> to generate encoded messages such as <A HREF="../../../../../org/apache/mina/common/IoBuffer.html" title="class in org.apache.mina.common"><CODE>IoBuffer</CODE></A>s. <A HREF="../../../../../org/apache/mina/filter/codec/ProtocolEncoder.html" title="interface in org.apache.mina.filter.codec"><CODE>ProtocolEncoder</CODE></A> must call <A HREF="../../../../../org/apache/mina/filter/codec/ProtocolEncoderOutput.html#write(java.lang.Object)"><CODE>write(Object)</CODE></A> for each encoded message.<P><P><DL><DT><B>Version:</B></DT> <DD>$Rev: 607166 $, $Date: 2007-12-27 20:43:04 -0700 (Thu, 27 Dec 2007) $</DD><DT><B>Author:</B></DT> <DD>The Apache MINA Project (dev@mina.apache.org)</DD></DL><HR><P><!-- ========== METHOD SUMMARY =========== --><A NAME="method_summary"><!-- --></A><TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""><TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"><TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"><B>Method Summary</B></FONT></TH></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE> <A HREF="../../../../../org/apache/mina/common/WriteFuture.html" title="interface in org.apache.mina.common">WriteFuture</A></CODE></FONT></TD><TD><CODE><B><A HREF="../../../../../org/apache/mina/filter/codec/ProtocolEncoderOutput.html#flush()">flush</A></B>()</CODE><BR> Flushes all buffers you wrote via <A HREF="../../../../../org/apache/mina/filter/codec/ProtocolEncoderOutput.html#write(java.lang.Object)"><CODE>write(Object)</CODE></A> to the session.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE> void</CODE></FONT></TD><TD><CODE><B><A HREF="../../../../../org/apache/mina/filter/codec/ProtocolEncoderOutput.html#mergeAll()">mergeAll</A></B>()</CODE><BR> Merges all buffers you wrote via <A HREF="../../../../../org/apache/mina/filter/codec/ProtocolEncoderOutput.html#write(java.lang.Object)"><CODE>write(Object)</CODE></A> into one <A HREF="../../../../../org/apache/mina/common/IoBuffer.html" title="class in org.apache.mina.common"><CODE>IoBuffer</CODE></A> and replaces the old fragmented ones with it.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE> void</CODE></FONT></TD><TD><CODE><B><A HREF="../../../../../org/apache/mina/filter/codec/ProtocolEncoderOutput.html#write(java.lang.Object)">write</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A> encodedMessage)</CODE><BR> Callback for <A HREF="../../../../../org/apache/mina/filter/codec/ProtocolEncoder.html" title="interface in org.apache.mina.filter.codec"><CODE>ProtocolEncoder</CODE></A> to generate an encoded message such as an <A HREF="../../../../../org/apache/mina/common/IoBuffer.html" title="class in org.apache.mina.common"><CODE>IoBuffer</CODE></A>.</TD></TR></TABLE> <P><!-- ============ METHOD DETAIL ========== --><A NAME="method_detail"><!-- --></A><TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""><TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"><TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"><B>Method Detail</B></FONT></TH></TR></TABLE><A NAME="write(java.lang.Object)"><!-- --></A><H3>write</H3><PRE>void <B>write</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A> encodedMessage)</PRE><DL><DD>Callback for <A HREF="../../../../../org/apache/mina/filter/codec/ProtocolEncoder.html" title="interface in org.apache.mina.filter.codec"><CODE>ProtocolEncoder</CODE></A> to generate an encoded message such as an <A HREF="../../../../../org/apache/mina/common/IoBuffer.html" title="class in org.apache.mina.common"><CODE>IoBuffer</CODE></A>. <A HREF="../../../../../org/apache/mina/filter/codec/ProtocolEncoder.html" title="interface in org.apache.mina.filter.codec"><CODE>ProtocolEncoder</CODE></A> must call <A HREF="../../../../../org/apache/mina/filter/codec/ProtocolEncoderOutput.html#write(java.lang.Object)"><CODE>write(Object)</CODE></A> for each encoded message.<P><DD><DL><DT><B>Parameters:</B><DD><CODE>encodedMessage</CODE> - the encoded message, typically an <A HREF="../../../../../org/apache/mina/common/IoBuffer.html" title="class in org.apache.mina.common"><CODE>IoBuffer</CODE></A> or a <A HREF="../../../../../org/apache/mina/common/FileRegion.html" title="interface in org.apache.mina.common"><CODE>FileRegion</CODE></A>.</DL></DD></DL><HR><A NAME="mergeAll()"><!-- --></A><H3>mergeAll</H3><PRE>void <B>mergeAll</B>()</PRE><DL><DD>Merges all buffers you wrote via <A HREF="../../../../../org/apache/mina/filter/codec/ProtocolEncoderOutput.html#write(java.lang.Object)"><CODE>write(Object)</CODE></A> into one <A HREF="../../../../../org/apache/mina/common/IoBuffer.html" title="class in org.apache.mina.common"><CODE>IoBuffer</CODE></A> and replaces the old fragmented ones with it. This method is useful when you want to control the way MINA generates network packets. Please note that this method only works when you called <A HREF="../../../../../org/apache/mina/filter/codec/ProtocolEncoderOutput.html#write(java.lang.Object)"><CODE>write(Object)</CODE></A> method with only <A HREF="../../../../../org/apache/mina/common/IoBuffer.html" title="class in org.apache.mina.common"><CODE>IoBuffer</CODE></A>s.<P><DD><DL><DT><B>Throws:</B><DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang">IllegalStateException</A></CODE> - if you wrote something else than <A HREF="../../../../../org/apache/mina/common/IoBuffer.html" title="class in org.apache.mina.common"><CODE>IoBuffer</CODE></A></DL></DD></DL><HR><A NAME="flush()"><!-- --></A><H3>flush</H3><PRE><A HREF="../../../../../org/apache/mina/common/WriteFuture.html" title="interface in org.apache.mina.common">WriteFuture</A> <B>flush</B>()</PRE><DL><DD>Flushes all buffers you wrote via <A HREF="../../../../../org/apache/mina/filter/codec/ProtocolEncoderOutput.html#write(java.lang.Object)"><CODE>write(Object)</CODE></A> to the session. This operation is asynchronous; please wait for the returned <A HREF="../../../../../org/apache/mina/common/WriteFuture.html" title="interface in org.apache.mina.common"><CODE>WriteFuture</CODE></A> if you want to wait for the buffers flushed.<P><DD><DL><DT><B>Returns:</B><DD><tt>null</tt> if there is nothing to flush at all.</DL></DD></DL><!-- ========= END OF CLASS DATA ========= --><HR><!-- ======= START OF BOTTOM NAVBAR ====== --><A NAME="navbar_bottom"><!-- --></A><A HREF="#skip-navbar_bottom" title="Skip navigation links"></A><TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""><TR><TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"><A NAME="navbar_bottom_firstrow"><!-- --></A><TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> <TR ALIGN="center" VALIGN="top"> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/ProtocolEncoderOutput.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> </TR></TABLE></TD><TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM></EM></TD></TR><TR><TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../../../org/apache/mina/filter/codec/ProtocolEncoderException.html" title="class in org.apache.mina.filter.codec"><B>PREV CLASS</B></A> <A HREF="../../../../../org/apache/mina/filter/codec/RecoverableProtocolDecoderException.html" title="class in org.apache.mina.filter.codec"><B>NEXT CLASS</B></A></FONT></TD><TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../../../index.html?org/apache/mina/filter/codec/ProtocolEncoderOutput.html" target="_top"><B>FRAMES</B></A> <A HREF="ProtocolEncoderOutput.html" target="_top"><B>NO FRAMES</B></A> <SCRIPT type="text/javascript"> <!-- if(window==top) { document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>'); } //--></SCRIPT><NOSCRIPT> <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A></NOSCRIPT></FONT></TD></TR><TR><TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD><TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD></TR></TABLE><A NAME="skip-navbar_bottom"></A><!-- ======== END OF BOTTOM NAVBAR ======= --><HR>Copyright 漏 2004-2008 <a href="http://mina.apache.org/">Apache MINA Project</a>. All Rights Reserved.</BODY></HTML>⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -