Module: Vertx::WriteStream
- Includes:
- StreamBase
- Included in:
- AsyncFile, HttpClientRequest, HttpServerResponse, MessageProducer, NetSocket, PacketWritestream, WebSocketBase, WriteStreamImpl
- Defined in:
- /Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/src/main/resources/vertx/write_stream.rb
Instance Method Summary (collapse)
-
- (self) drain_handler { ... }
Set a drain handler on the stream.
-
- (self) exception_handler { ... }
Set an exception handler on the write stream.
-
- (self) set_write_queue_max_size(maxSize = nil)
Set the maximum size of the write queue to maxSize.
-
- (self) write(data = nil)
Write some data to the stream.
-
- (true, false) write_queue_full?
This will return true if there are more bytes in the write queue than the value set using #set_write_queue_max_size.
Instance Method Details
- (self) drain_handler { ... }
Set a drain handler on the stream. If the write queue is full, then the handler will be called when the write
queue has been reduced to maxSize / 2. See Pump for an example of this being used.
53 54 55 56 57 58 59 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/src/main/resources/vertx/write_stream.rb', line 53 def drain_handler if block_given? @j_del.java_method(:drainHandler, [Java::IoVertxCore::Handler.java_class]).call(Proc.new { yield }) return self end raise ArgumentError, "Invalid arguments when calling drain_handler()" end |
- (self) exception_handler { ... }
Set an exception handler on the write stream.
10 11 12 13 14 15 16 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/src/main/resources/vertx/write_stream.rb', line 10 def exception_handler if block_given? @j_del.java_method(:exceptionHandler, [Java::IoVertxCore::Handler.java_class]).call((Proc.new { |event| yield(event) })) return self end raise ArgumentError, "Invalid arguments when calling exception_handler()" end |
- (self) set_write_queue_max_size(maxSize = nil)
Set the maximum size of the write queue to
maxSize
. You will still be able to write to the stream even
if there is more than maxSize
bytes in the write queue. This is used as an indicator by classes such as
Pump
to provide flow control.
34 35 36 37 38 39 40 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/src/main/resources/vertx/write_stream.rb', line 34 def set_write_queue_max_size(maxSize=nil) if maxSize.class == Fixnum && !block_given? @j_del.java_method(:setWriteQueueMaxSize, [Java::int.java_class]).call(maxSize) return self end raise ArgumentError, "Invalid arguments when calling set_write_queue_max_size(maxSize)" end |
- (self) write(data = nil)
Write some data to the stream. The data is put on an internal write queue, and the write actually happens
asynchronously. To avoid running out of memory by putting too much on the write queue,
check the #write_queue_full method before writing. This is done automatically if using a Pump.
22 23 24 25 26 27 28 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/src/main/resources/vertx/write_stream.rb', line 22 def write(data=nil) if (data.class == String || data.class == Hash || data.class == Array || data.class == NilClass || data.class == TrueClass || data.class == FalseClass || data.class == Fixnum || data.class == Float) && !block_given? @j_del.java_method(:write, [Java::java.lang.Object.java_class]).call(::Vertx::Util::Utils.to_object(data)) return self end raise ArgumentError, "Invalid arguments when calling write(data)" end |
- (true, false) write_queue_full?
This will return
true
if there are more bytes in the write queue than the value set using #set_write_queue_max_size
43 44 45 46 47 48 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/src/main/resources/vertx/write_stream.rb', line 43 def write_queue_full? if !block_given? return @j_del.java_method(:writeQueueFull, []).call() end raise ArgumentError, "Invalid arguments when calling write_queue_full?()" end |