org.glassfish.tyrus.spi

Class Writer

java.lang.Object

org.glassfish.tyrus.spi.Writer

All Implemented Interfaces:

Closeable, AutoCloseable

public abstract class Writer
extends Object
implements Closeable

Writer class that is used by tyrus runtime to pass outbound websocket data for a connection to a transport. Then, the transport actually writes the data eventually.

A transport creates implementation of this class and registers the writer object using WebSocketEngine.UpgradeInfo.createConnection(org.glassfish.tyrus.spi.Writer, org.glassfish.tyrus.spi.Connection.CloseListener) after a successful upgrade.

Author:

Pavel Bucek (pavel.bucek at oracle.com)

Constructor Summary

Constructors

Constructor and Description
Writer()

Method Summary

Methods

Modifier and Type	Method and Description
abstract void	write(ByteBuffer buffer, CompletionHandler<ByteBuffer> completionHandler) Tyrus runtime calls this method to handover the data for a connection to the transport.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.io.Closeable

close

Constructor Detail

Writer

public Writer()

Method Detail

write

public abstract void write(ByteBuffer buffer,
         CompletionHandler<ByteBuffer> completionHandler)

Tyrus runtime calls this method to handover the data for a connection to the transport. The transport writes bytes to underlying connection. Tyrus runtime must not use the buffer until the write is completed.

Parameters:

buffer - bytes to write.

completionHandler - completion handler to know the write status.