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; 21 22 import org.apache.mina.core.buffer.IoBuffer; 23 import org.apache.mina.core.session.IoSession; 24 25 /** 26 * Encodes higher-level message objects into binary or protocol-specific data. 27 * MINA invokes {@link #encode(IoSession, Object, ProtocolEncoderOutput)} 28 * method with message which is popped from the session write queue, and then 29 * the encoder implementation puts encoded messages (typically {@link IoBuffer}s) 30 * into {@link ProtocolEncoderOutput} by calling {@link ProtocolEncoderOutput#write(Object)}. 31 * <p> 32 * Please refer to 33 * <a href="../../../../../xref-examples/org/apache/mina/examples/reverser/TextLineEncoder.html"><code>TextLineEncoder</code></a> 34 * example. 35 * 36 * @author The Apache MINA Project (dev@mina.apache.org) 37 * @version $Rev: 671827 $, $Date: 2008-06-26 10:49:48 +0200 (jeu, 26 jun 2008) $ 38 * 39 * @see ProtocolEncoderException 40 */ 41 public interface ProtocolEncoder { 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 messages (typically {@link IoBuffer}s) 48 * into {@link ProtocolEncoderOutput}. 49 * 50 * @throws Exception if the message violated protocol specification 51 */ 52 void encode(IoSession session, Object message, ProtocolEncoderOutput out) 53 throws Exception; 54 55 /** 56 * Releases all resources related with this encoder. 57 * 58 * @throws Exception if failed to dispose all resources 59 */ 60 void dispose(IoSession session) throws Exception; 61 }