1 // 2 // ======================================================================== 3 // Copyright (c) 1995-2016 Mort Bay Consulting Pty. Ltd. 4 // ------------------------------------------------------------------------ 5 // All rights reserved. This program and the accompanying materials 6 // are made available under the terms of the Eclipse Public License v1.0 7 // and Apache License v2.0 which accompanies this distribution. 8 // 9 // The Eclipse Public License is available at 10 // http://www.eclipse.org/legal/epl-v10.html 11 // 12 // The Apache License v2.0 is available at 13 // http://www.opensource.org/licenses/apache2.0.php 14 // 15 // You may elect to redistribute this code under either of these licenses. 16 // ======================================================================== 17 // 18 19 package org.eclipse.jetty.websocket.common.message; 20 21 import java.io.IOException; 22 import java.nio.ByteBuffer; 23 24 /** 25 * Appender for messages (used for multiple frames with continuations, and also to allow for streaming APIs) 26 */ 27 public interface MessageAppender 28 { 29 /** 30 * Append the frame payload to the message. 31 * 32 * @param framePayload 33 * the frame payload to append. 34 * @param isLast 35 * flag indicating if this is the last part of the message or not. 36 * @throws IOException 37 * if unable to append the frame payload 38 */ 39 abstract void appendFrame(ByteBuffer framePayload, boolean isLast) throws IOException; 40 41 /** 42 * Notification that message is to be considered complete. 43 * <p> 44 * Any cleanup or final actions should be taken here. 45 */ 46 abstract void messageComplete(); 47 }