public class RateLimitingStreamSinkConduit extends AbstractStreamSinkConduit<StreamSinkConduit>
Allows send speed to be throttled
Note that throttling is applied after an initial write, so if a big write is performed initially it may be a while before it can write again.
next
Constructor and Description |
---|
RateLimitingStreamSinkConduit(StreamSinkConduit next,
int bytes,
long time,
TimeUnit timeUnit) |
Modifier and Type | Method and Description |
---|---|
void |
awaitWritable()
Block until this channel becomes writable again.
|
void |
awaitWritable(long time,
TimeUnit timeUnit)
Block until this conduit becomes writable again, or until the timeout expires.
|
boolean |
isWriteResumed()
Determine whether write notifications are currently enabled.
|
void |
resumeWrites()
Indicate that the conduit's
WriteReadyHandler should be invoked as soon as data can be written
without blocking. |
void |
suspendWrites()
Indicate that calling the conduit's
WriteReadyHandler should be suspended. |
long |
transferFrom(FileChannel src,
long position,
long count)
Transfer bytes into this conduit from the given file.
|
long |
transferFrom(StreamSourceChannel source,
long count,
ByteBuffer throughBuffer)
Transfers bytes from the given channel source.
|
void |
wakeupWrites()
Indicate that the conduit's
WriteReadyHandler should be invoked immediately, and then again as soon
as data can be written without blocking. |
int |
write(ByteBuffer src)
Writes a sequence of bytes to this conduit from the given buffer.
|
long |
write(ByteBuffer[] srcs,
int offs,
int len)
Writes a sequence of bytes to this conduit from the given buffers.
|
int |
writeFinal(ByteBuffer src)
Writes some data to the conduit, with the same semantics as
StreamSinkConduit.write(java.nio.ByteBuffer) . |
long |
writeFinal(ByteBuffer[] srcs,
int offs,
int len)
Writes some data to the conduit, with the same semantics as
StreamSinkConduit.write(java.nio.ByteBuffer[], int, int) . |
flush, getWriteThread, isWriteShutdown, setWriteReadyHandler, terminateWrites, truncateWrites
getWorker
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
flush, getWriteThread, isWriteShutdown, setWriteReadyHandler, terminateWrites, truncateWrites
public RateLimitingStreamSinkConduit(StreamSinkConduit next, int bytes, long time, TimeUnit timeUnit)
next
- The next conduitbytes
- The number of bytes that are allowed per time frametime
- The time frametimeUnit
- The time unitpublic int write(ByteBuffer src) throws IOException
StreamSinkConduit
write
in interface StreamSinkConduit
write
in class AbstractStreamSinkConduit<StreamSinkConduit>
src
- the buffer containing data to writeClosedChannelException
- if this conduit's SinkConduit.terminateWrites()
method was previously calledIOException
- if an error occurspublic long transferFrom(FileChannel src, long position, long count) throws IOException
StreamSinkConduit
transferFrom
in interface StreamSinkConduit
transferFrom
in class AbstractStreamSinkConduit<StreamSinkConduit>
src
- the file to read fromposition
- the position within the file from which the transfer is to begincount
- the number of bytes to be transferredIOException
- if an I/O error occurspublic long transferFrom(StreamSourceChannel source, long count, ByteBuffer throughBuffer) throws IOException
StreamSinkConduit
throughBuffer
will be cleared. On exit, the
buffer will be flipped for emptying, and may be empty or may contain data. If this method returns a value less
than count
, then the remaining data in throughBuffer
may contain data read from source
which must be written to this channel to complete the operation.transferFrom
in interface StreamSinkConduit
transferFrom
in class AbstractStreamSinkConduit<StreamSinkConduit>
source
- the source to read fromcount
- the number of bytes to be transferredthroughBuffer
- the buffer to copy through.IOException
- if an I/O error occurspublic long write(ByteBuffer[] srcs, int offs, int len) throws IOException
StreamSinkConduit
write
in interface StreamSinkConduit
write
in class AbstractStreamSinkConduit<StreamSinkConduit>
srcs
- the buffers containing data to writeoffs
- the offset into the buffer arraylen
- the number of buffers to writeClosedChannelException
- if this conduit's SinkConduit.terminateWrites()
method was previously calledIOException
- if an error occurspublic int writeFinal(ByteBuffer src) throws IOException
StreamSinkConduit
StreamSinkConduit.write(java.nio.ByteBuffer)
. If all the data is written
out then the conduit will have its writes terminated. Semantically this
method is equivalent to:
int rem = src.remaining();
int written = conduit.write(src);
if(written == rem) {
conduit.terminateWrites()
}
writeFinal
in interface StreamSinkConduit
writeFinal
in class AbstractStreamSinkConduit<StreamSinkConduit>
src
- The data to writeIOException
public long writeFinal(ByteBuffer[] srcs, int offs, int len) throws IOException
StreamSinkConduit
StreamSinkConduit.write(java.nio.ByteBuffer[], int, int)
. If all the data is written
out then the conduit will have its writes terminated.writeFinal
in interface StreamSinkConduit
writeFinal
in class AbstractStreamSinkConduit<StreamSinkConduit>
srcs
- The buffers from which bytes are to be retrievedoffs
- The offset within the buffer array of the first buffer from
which bytes are to be retrieved; must be non-negative and no
larger than srcs.lengthlen
- The maximum number of buffers to be accessed; must be
non-negative and no larger than
srcs.length - offsetIOException
public void resumeWrites()
SinkConduit
WriteReadyHandler
should be invoked as soon as data can be written
without blocking.resumeWrites
in interface SinkConduit
resumeWrites
in class AbstractSinkConduit<StreamSinkConduit>
public void suspendWrites()
SinkConduit
WriteReadyHandler
should be suspended.suspendWrites
in interface SinkConduit
suspendWrites
in class AbstractSinkConduit<StreamSinkConduit>
public void wakeupWrites()
SinkConduit
WriteReadyHandler
should be invoked immediately, and then again as soon
as data can be written without blocking.wakeupWrites
in interface SinkConduit
wakeupWrites
in class AbstractSinkConduit<StreamSinkConduit>
public boolean isWriteResumed()
SinkConduit
isWriteResumed
in interface SinkConduit
isWriteResumed
in class AbstractSinkConduit<StreamSinkConduit>
true
if write notifications are enabledpublic void awaitWritable() throws IOException
SinkConduit
awaitWritable
in interface SinkConduit
awaitWritable
in class AbstractSinkConduit<StreamSinkConduit>
InterruptedIOException
- if the operation is interrupted; the thread's interrupt flag will be set
as wellIOException
- if an I/O error occurspublic void awaitWritable(long time, TimeUnit timeUnit) throws IOException
SinkConduit
awaitWritable
in interface SinkConduit
awaitWritable
in class AbstractSinkConduit<StreamSinkConduit>
time
- the time to waittimeUnit
- the time unitInterruptedIOException
- if the operation is interrupted; the thread's interrupt flag will be set
as wellIOException
- if an I/O error occursCopyright © 2021 JBoss by Red Hat. All rights reserved.