Class MessageWriter

java.lang.Object

java.io.Writer

org.eclipse.jetty.websocket.common.message.MessageWriter

All Implemented Interfaces:

Closeable, Flushable, Appendable, AutoCloseable

public class MessageWriter
extends Writer

Support for writing a single WebSocket TEXT message via a Writer

Note: Per WebSocket spec, all WebSocket TEXT messages must be encoded in UTF-8

Field Summary

Fields

Modifier and Type	Field	Description
private final BlockingWriteCallback	blocker
private ByteBuffer	buffer
private final org.eclipse.jetty.io.ByteBufferPool	bufferPool
private WriteCallback	callback
private boolean	closed
private TextFrame	frame
private long	frameCount
private static final org.eclipse.jetty.util.log.Logger	LOG
private final OutgoingFrames	outgoing
private Utf8CharBuffer	utf

Fields inherited from class Writer

lock

Constructor Summary

Constructors

Constructor	Description
MessageWriter(OutgoingFrames outgoing, int bufferSize, org.eclipse.jetty.io.ByteBufferPool bufferPool)
MessageWriter(WebSocketSession session)

Method Summary

Modifier and Type	Method	Description
void	close()
void	flush()
private void	flush(boolean fin)
private void	notifyFailure(Throwable failure)
private void	notifySuccess()
private void	send(char[] chars, int offset, int length)
void	setCallback(WriteCallback callback)
void	write(char[] chars, int off, int len)
void	write(int c)

Methods inherited from class Writer

append, append, append, write, write, write

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

LOG

private static final org.eclipse.jetty.util.log.Logger LOG

outgoing

private final OutgoingFrames outgoing

bufferPool

private final org.eclipse.jetty.io.ByteBufferPool bufferPool

blocker

private final BlockingWriteCallback blocker

frameCount

private long frameCount

frame

private TextFrame frame

buffer

private ByteBuffer buffer

utf

private Utf8CharBuffer utf

callback

private WriteCallback callback

closed

private boolean closed

Constructor Details

MessageWriter

public MessageWriter(WebSocketSession session)

MessageWriter

public MessageWriter(OutgoingFrames outgoing,
 int bufferSize,
 org.eclipse.jetty.io.ByteBufferPool bufferPool)

Method Details

write

public void write(char[] chars,
 int off,
 int len)
           throws IOException

Specified by:

write in class Writer

Throws:

IOException

write

public void write(int c)
           throws IOException

Overrides:

write in class Writer

Throws:

IOException

flush

public void flush()
           throws IOException

Specified by:

flush in interface Flushable

Specified by:

flush in class Writer

Throws:

IOException

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Specified by:

close in class Writer

Throws:

IOException

flush

private void flush(boolean fin)
            throws IOException

Throws:

IOException

send

private void send(char[] chars,
 int offset,
 int length)
           throws IOException

Throws:

IOException

setCallback

public void setCallback(WriteCallback callback)

notifySuccess

private void notifySuccess()

notifyFailure

private void notifyFailure(Throwable failure)