KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > mina > filter > codec > demux > MessageEncoder


1 /*
2  * Licensed to the Apache Software Foundation (ASF) under one
3  * or more contributor license agreements. See the NOTICE file
4  * distributed with this work for additional information
5  * regarding copyright ownership. The ASF licenses this file
6  * to you under the Apache License, Version 2.0 (the
7  * "License"); you may not use this file except in compliance
8  * with the License. You may obtain a copy of the License at
9  *
10  * http://www.apache.org/licenses/LICENSE-2.0
11  *
12  * Unless required by applicable law or agreed to in writing,
13  * software distributed under the License is distributed on an
14  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15  * KIND, either express or implied. See the License for the
16  * specific language governing permissions and limitations
17  * under the License.
18  *
19  */

20 package org.apache.mina.filter.codec.demux;
21
22 import java.util.Set JavaDoc;
23
24 import org.apache.mina.common.ByteBuffer;
25 import org.apache.mina.common.IoSession;
26 import org.apache.mina.filter.codec.ProtocolEncoderOutput;
27
28 /**
29  * Encodes messages of specific types specified by {@link #getMessageTypes()}.
30  *
31  * @author The Apache Directory Project (mina-dev@directory.apache.org)
32  * @version $Rev: 555855 $, $Date: 2007-07-13 12:19:00 +0900 (금, 13 7월 2007) $
33  *
34  * @see DemuxingProtocolCodecFactory
35  * @see MessageEncoderFactory
36  */

37 public interface MessageEncoder {
38     /**
39      * Returns the set of message classes this encoder can encode.
40      */

41     Set JavaDoc<Class JavaDoc<?>> getMessageTypes();
42
43     /**
44      * Encodes higher-level message objects into binary or protocol-specific data.
45      * MINA invokes {@link #encode(IoSession, Object, ProtocolEncoderOutput)}
46      * method with message which is popped from the session write queue, and then
47      * the encoder implementation puts encoded {@link ByteBuffer}s into
48      * {@link ProtocolEncoderOutput}.
49      *
50      * @throws Exception if the message violated protocol specification
51      */

52     void encode(IoSession session, Object JavaDoc message, ProtocolEncoderOutput out)
53             throws Exception JavaDoc;
54 }
55
Popular Tags