Module: Vertx::WriteStream
- Includes:
- StreamBase
- Included in:
- AsyncFile, HttpClientRequest, HttpServerResponse, MessageProducer, NetSocket, WebSocketBase, WriteStreamImpl, VertxAmqpClient::AmqpSender, VertxKafkaClient::KafkaProducer, VertxWeb::SockJSSocket
- Defined in:
- /Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx/write_stream.rb
Instance Method Summary (collapse)
-
- (self) drain_handler { ... }
Set a drain handler on the stream.
-
- (void) end(data = nil) { ... }
Same as but with an handler called when the operation completes.
-
- (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) { ... }
Same as but with an handler called when the operation completes.
-
- (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 is ready to accept buffers again. See Pump for an example of this being used.
The stream implementation defines when the drain handler, for example it could be when the queue size has been
reduced to
maxSize / 2
.
78 79 80 81 82 83 84 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx/write_stream.rb', line 78 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 |
- (void) end(data = nil) { ... }
This method returns an undefined value.
Same as but with anhandler
called when the operation completes
35 36 37 38 39 40 41 42 43 44 45 46 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx/write_stream.rb', line 35 def end(data=nil) if !block_given? && data == nil return @j_del.java_method(:end, []).call() elsif block_given? && data == nil return @j_del.java_method(:end, [Java::IoVertxCore::Handler.java_class]).call((Proc.new { |ar| yield(ar.failed ? ar.cause : nil) })) elsif @j_arg_T.accept?(data) && !block_given? return @j_del.java_method(:end, [Java::java.lang.Object.java_class]).call(@j_arg_T.unwrap(data)) elsif @j_arg_T.accept?(data) && block_given? return @j_del.java_method(:end, [Java::java.lang.Object.java_class,Java::IoVertxCore::Handler.java_class]).call(@j_arg_T.unwrap(data),(Proc.new { |ar| yield(ar.failed ? ar.cause : nil) })) end raise ArgumentError, "Invalid arguments when calling end(#{data})" 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/vertx-lang-ruby/target/classes/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(::Vertx::Util::Utils.from_throwable(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
items in the write queue. This is used as an indicator by classes such as
Pump
to provide flow control.
The value is defined by the implementation of the stream, e.g in bytes for a
NetSocket, the number of Message for a
MessageProducer, etc...
56 57 58 59 60 61 62 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx/write_stream.rb', line 56 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) { ... }
Same as but with an
handler
called when the operation completes
21 22 23 24 25 26 27 28 29 30 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx/write_stream.rb', line 21 def write(data=nil) if @j_arg_T.accept?(data) && !block_given? @j_del.java_method(:write, [Java::java.lang.Object.java_class]).call(@j_arg_T.unwrap(data)) return self elsif @j_arg_T.accept?(data) && block_given? @j_del.java_method(:write, [Java::java.lang.Object.java_class,Java::IoVertxCore::Handler.java_class]).call(@j_arg_T.unwrap(data),(Proc.new { |ar| yield(ar.failed ? ar.cause : nil) })) 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
65 66 67 68 69 70 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx/write_stream.rb', line 65 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 |