01: /*
02: * Licensed to the Apache Software Foundation (ASF) under one
03: * or more contributor license agreements. See the NOTICE file
04: * distributed with this work for additional information
05: * regarding copyright ownership. The ASF licenses this file
06: * to you under the Apache License, Version 2.0 (the
07: * "License"); you may not use this file except in compliance
08: * with the License. You may obtain a copy of the License at
09: *
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 org.apache.mina.common.IoBuffer;
23: import org.apache.mina.common.IoSession;
24: import org.apache.mina.filter.codec.ProtocolEncoderOutput;
25:
26: /**
27: * Encodes a certain type of messages.
28: * <p>
29: * We didn't provide any <tt>dispose</tt> method for {@link MessageEncoder}
30: * because it can give you performance penalty in case you have a lot of
31: * message types to handle.
32: *
33: * @author The Apache MINA Project (dev@mina.apache.org)
34: * @version $Rev: 590006 $, $Date: 2007-10-30 03:44:02 -0600 (Tue, 30 Oct 2007) $
35: *
36: * @see DemuxingProtocolEncoder
37: * @see MessageEncoderFactory
38: */
39: public interface MessageEncoder<T> {
40: /**
41: * Encodes higher-level message objects into binary or protocol-specific data.
42: * MINA invokes {@link #encode(IoSession, Object, ProtocolEncoderOutput)}
43: * method with message which is popped from the session write queue, and then
44: * the encoder implementation puts encoded {@link IoBuffer}s into
45: * {@link ProtocolEncoderOutput}.
46: *
47: * @throws Exception if the message violated protocol specification
48: */
49: void encode(IoSession session, T message, ProtocolEncoderOutput out)
50: throws Exception;
51: }
|