org.eclipse.jetty.websocket.common.message

Interface MessageAppender

All Known Implementing Classes:

BinaryPartialMessage, BinaryPartialOnMessage, BinaryWholeMessage, MessageInputStream, MessageReader, SimpleBinaryMessage, SimpleTextMessage, TextPartialMessage, TextPartialOnMessage, TextWholeMessage

public interface MessageAppender

Appender for messages (used for multiple frames with continuations, and also to allow for streaming APIs)

Method Summary

Methods

Modifier and Type	Method and Description
void	appendFrame(ByteBuffer framePayload, boolean isLast) Append the frame payload to the message.
void	messageComplete() Notification that message is to be considered complete.

Method Detail

appendFrame

void appendFrame(ByteBuffer framePayload,
               boolean isLast)
                 throws IOException

Append the frame payload to the message.

Parameters:

framePayload - the frame payload to append.

isLast - flag indicating if this is the last part of the message or not.

Throws:

IOException - if unable to append the frame payload

messageComplete

void messageComplete()

Notification that message is to be considered complete.

Any cleanup or final actions should be taken here.