Class: Vertx::RecordParser
- Inherits:
-
Object
- Object
- Vertx::RecordParser
- Includes:
- ReadStream
- Defined in:
- /Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx/record_parser.rb
Overview
Instances of this class take as input Buffer instances containing raw bytes, and output records.
For example, if I had a simple ASCII text protocol delimited by '\n' and the input was the following:
buffer1:HELLO\nHOW ARE Y
buffer2:OU?\nI AM
buffer3: DOING OK
buffer4:\n
Then the output would be:
buffer1:HELLO
buffer2:HOW ARE YOU?
buffer3:I AM DOING OK
Instances of this class can be changed between delimited mode and fixed size record mode on the fly as
individual records are read, this allows you to parse protocols where, for example, the first 5 records might
all be fixed size (of potentially different sizes), followed by some delimited records, followed by more fixed
size records.
Instances of this class can't currently be used for protocols where the text is encoded with something other than a 1-1 byte-char mapping.
Please see the documentation for more information.
Constant Summary
- @@j_api_type =
Object.new
Class Method Summary (collapse)
- + (Boolean) accept?(obj)
- + (Object) j_api_type
- + (Object) j_class
-
+ (::Vertx::RecordParser) new_delimited(param_1 = nil, param_2 = nil)
Like #new_delimited but wraps the stream.
-
+ (::Vertx::RecordParser) new_fixed(size = nil, stream = nil)
Like #new_fixed but wraps the stream.
- + (Object) unwrap(obj)
- + (Object) wrap(obj)
Instance Method Summary (collapse)
-
- (void) delimited_mode(param_1 = nil)
Flip the parser into delimited mode, and where the delimiter can be represented by the delimiter delim.
- - (self) end_handler { ... }
- - (self) exception_handler { ... }
- - (self) fetch(amount = nil)
-
- (void) fixed_size_mode(size = nil)
Flip the parser into fixed size mode, where the record size is specified by size in bytes.
-
- (void) handle(buffer = nil)
This method is called to provide the parser with data.
- - (self) handler { ... }
-
- (self) max_record_size(size = nil)
Set the maximum allowed size for a record when using the delimited mode.
- - (self) pause
-
- (::Vertx::Pipe) pipe
Pause this stream and return a to transfer the elements of this stream to a destination .
-
- (void) pipe_to(dst = nil) { ... }
Pipe this ReadStream to the WriteStream.
- - (self) resume
- - (void) set_output { ... }
Class Method Details
+ (Boolean) accept?(obj)
51 52 53 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx/record_parser.rb', line 51 def @@j_api_type.accept?(obj) obj.class == RecordParser end |
+ (Object) j_api_type
60 61 62 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx/record_parser.rb', line 60 def self.j_api_type @@j_api_type end |
+ (Object) j_class
63 64 65 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx/record_parser.rb', line 63 def self.j_class Java::IoVertxCoreParsetools::RecordParser.java_class end |
+ (::Vertx::RecordParser) newDelimited(delim) + (::Vertx::RecordParser) newDelimited(delim) + (::Vertx::RecordParser) newDelimited(delim, output) { ... } + (::Vertx::RecordParser) newDelimited(delim, stream) + (::Vertx::RecordParser) newDelimited(delim, output) { ... } + (::Vertx::RecordParser) newDelimited(delim, stream)
stream. The stream handlers will be set/unset
when the #handler is set.
The pause()/resume() operations are propagated to the stream.
120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx/record_parser.rb', line 120 def self.new_delimited(param_1=nil,param_2=nil) if param_1.class == String && !block_given? && param_2 == nil return ::Vertx::Util::Utils.safe_create(Java::IoVertxCoreParsetools::RecordParser.java_method(:newDelimited, [Java::java.lang.String.java_class]).call(param_1),::Vertx::RecordParser) elsif param_1.class.method_defined?(:j_del) && !block_given? && param_2 == nil return ::Vertx::Util::Utils.safe_create(Java::IoVertxCoreParsetools::RecordParser.java_method(:newDelimited, [Java::IoVertxCoreBuffer::Buffer.java_class]).call(param_1.j_del),::Vertx::RecordParser) elsif param_1.class == String && true && param_2 == nil return ::Vertx::Util::Utils.safe_create(Java::IoVertxCoreParsetools::RecordParser.java_method(:newDelimited, [Java::java.lang.String.java_class,Java::IoVertxCore::Handler.java_class]).call(param_1,(Proc.new { |event| yield(::Vertx::Util::Utils.safe_create(event,::Vertx::Buffer)) unless !block_given? })),::Vertx::RecordParser) elsif param_1.class == String && param_2.class.method_defined?(:j_del) && !block_given? return ::Vertx::Util::Utils.safe_create(Java::IoVertxCoreParsetools::RecordParser.java_method(:newDelimited, [Java::java.lang.String.java_class,Java::IoVertxCoreStreams::ReadStream.java_class]).call(param_1,param_2.j_del),::Vertx::RecordParser) elsif param_1.class.method_defined?(:j_del) && true && param_2 == nil return ::Vertx::Util::Utils.safe_create(Java::IoVertxCoreParsetools::RecordParser.java_method(:newDelimited, [Java::IoVertxCoreBuffer::Buffer.java_class,Java::IoVertxCore::Handler.java_class]).call(param_1.j_del,(Proc.new { |event| yield(::Vertx::Util::Utils.safe_create(event,::Vertx::Buffer)) unless !block_given? })),::Vertx::RecordParser) elsif param_1.class.method_defined?(:j_del) && param_2.class.method_defined?(:j_del) && !block_given? return ::Vertx::Util::Utils.safe_create(Java::IoVertxCoreParsetools::RecordParser.java_method(:newDelimited, [Java::IoVertxCoreBuffer::Buffer.java_class,Java::IoVertxCoreStreams::ReadStream.java_class]).call(param_1.j_del,param_2.j_del),::Vertx::RecordParser) end raise ArgumentError, "Invalid arguments when calling new_delimited(#{param_1},#{param_2})" end |
+ (::Vertx::RecordParser) new_fixed(size = nil, stream = nil)
stream. The stream handlers will be set/unset
when the #handler is set.
The pause()/resume() operations are propagated to the stream.
143 144 145 146 147 148 149 150 151 152 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx/record_parser.rb', line 143 def self.new_fixed(size=nil,stream=nil) if size.class == Fixnum && !block_given? && stream == nil return ::Vertx::Util::Utils.safe_create(Java::IoVertxCoreParsetools::RecordParser.java_method(:newFixed, [Java::int.java_class]).call(size),::Vertx::RecordParser) elsif size.class == Fixnum && true && stream == nil return ::Vertx::Util::Utils.safe_create(Java::IoVertxCoreParsetools::RecordParser.java_method(:newFixed, [Java::int.java_class,Java::IoVertxCore::Handler.java_class]).call(size,(Proc.new { |event| yield(::Vertx::Util::Utils.safe_create(event,::Vertx::Buffer)) unless !block_given? })),::Vertx::RecordParser) elsif size.class == Fixnum && stream.class.method_defined?(:j_del) && !block_given? return ::Vertx::Util::Utils.safe_create(Java::IoVertxCoreParsetools::RecordParser.java_method(:newFixed, [Java::int.java_class,Java::IoVertxCoreStreams::ReadStream.java_class]).call(size,stream.j_del),::Vertx::RecordParser) end raise ArgumentError, "Invalid arguments when calling new_fixed(#{size},#{stream})" end |
+ (Object) unwrap(obj)
57 58 59 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx/record_parser.rb', line 57 def @@j_api_type.unwrap(obj) obj.j_del end |
+ (Object) wrap(obj)
54 55 56 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx/record_parser.rb', line 54 def @@j_api_type.wrap(obj) RecordParser.new(obj) end |
Instance Method Details
- (void) delimitedMode(delim) - (void) delimitedMode(delim)
This method returns an undefined value.
Flip the parser into delimited mode, and where the delimiter can be represented by the delimiterdelim.
This method can be called multiple times with different values of delim while data is being parsed.
162 163 164 165 166 167 168 169 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx/record_parser.rb', line 162 def delimited_mode(param_1=nil) if param_1.class == String && !block_given? return @j_del.java_method(:delimitedMode, [Java::java.lang.String.java_class]).call(param_1) elsif param_1.class.method_defined?(:j_del) && !block_given? return @j_del.java_method(:delimitedMode, [Java::IoVertxCoreBuffer::Buffer.java_class]).call(param_1.j_del) end raise ArgumentError, "Invalid arguments when calling delimited_mode(#{param_1})" end |
- (self) end_handler { ... }
248 249 250 251 252 253 254 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx/record_parser.rb', line 248 def end_handler if true @j_del.java_method(:endHandler, [Java::IoVertxCore::Handler.java_class]).call(Proc.new { yield unless !block_given? }) return self end raise ArgumentError, "Invalid arguments when calling end_handler()" end |
- (self) exception_handler { ... }
205 206 207 208 209 210 211 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx/record_parser.rb', line 205 def exception_handler if true @j_del.java_method(:exceptionHandler, [Java::IoVertxCore::Handler.java_class]).call((Proc.new { |event| yield(::Vertx::Util::Utils.from_throwable(event)) unless !block_given? })) return self end raise ArgumentError, "Invalid arguments when calling exception_handler()" end |
- (self) fetch(amount = nil)
231 232 233 234 235 236 237 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx/record_parser.rb', line 231 def fetch(amount=nil) if amount.class == Fixnum && !block_given? @j_del.java_method(:fetch, [Java::long.java_class]).call(amount) return self end raise ArgumentError, "Invalid arguments when calling fetch(#{amount})" end |
- (void) fixed_size_mode(size = nil)
This method returns an undefined value.
Flip the parser into fixed size mode, where the record size is specified bysize in bytes.
This method can be called multiple times with different values of size while data is being parsed.
175 176 177 178 179 180 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx/record_parser.rb', line 175 def fixed_size_mode(size=nil) if size.class == Fixnum && !block_given? return @j_del.java_method(:fixedSizeMode, [Java::int.java_class]).call(size) end raise ArgumentError, "Invalid arguments when calling fixed_size_mode(#{size})" end |
- (void) handle(buffer = nil)
This method returns an undefined value.
This method is called to provide the parser with data.
197 198 199 200 201 202 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx/record_parser.rb', line 197 def handle(buffer=nil) if buffer.class.method_defined?(:j_del) && !block_given? return @j_del.java_method(:handle, [Java::IoVertxCoreBuffer::Buffer.java_class]).call(buffer.j_del) end raise ArgumentError, "Invalid arguments when calling handle(#{buffer})" end |
- (self) handler { ... }
214 215 216 217 218 219 220 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx/record_parser.rb', line 214 def handler if true @j_del.java_method(:handler, [Java::IoVertxCore::Handler.java_class]).call((Proc.new { |event| yield(::Vertx::Util::Utils.safe_create(event,::Vertx::Buffer)) unless !block_given? })) return self end raise ArgumentError, "Invalid arguments when calling handler()" end |
- (self) max_record_size(size = nil)
If a record is longer than specified, an IllegalStateException will be thrown.
187 188 189 190 191 192 193 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx/record_parser.rb', line 187 def max_record_size(size=nil) if size.class == Fixnum && !block_given? @j_del.java_method(:maxRecordSize, [Java::int.java_class]).call(size) return self end raise ArgumentError, "Invalid arguments when calling max_record_size(#{size})" end |
- (self) pause
222 223 224 225 226 227 228 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx/record_parser.rb', line 222 def pause if !block_given? @j_del.java_method(:pause, []).call() return self end raise ArgumentError, "Invalid arguments when calling pause()" end |
- (::Vertx::Pipe) pipe
WriteStream.
70 71 72 73 74 75 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx/record_parser.rb', line 70 def pipe if !block_given? return ::Vertx::Util::Utils.safe_create(@j_del.java_method(:pipe, []).call(),::Vertx::Pipe,::Vertx::Buffer.j_api_type) end raise ArgumentError, "Invalid arguments when calling pipe()" end |
- (void) pipe_to(dst = nil) { ... }
This method returns an undefined value.
Pipe thisReadStream to the WriteStream.
Elements emitted by this stream will be written to the write stream until this stream ends or fails.
Once this stream has ended or failed, the write stream will be ended and the handler will be
called with the result.
85 86 87 88 89 90 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx/record_parser.rb', line 85 def pipe_to(dst=nil) if dst.class.method_defined?(:j_del) && true return @j_del.java_method(:pipeTo, [Java::IoVertxCoreStreams::WriteStream.java_class,Java::IoVertxCore::Handler.java_class]).call(dst.j_del,(Proc.new { |ar| yield(ar.failed ? ar.cause : nil) } unless !block_given?)) end raise ArgumentError, "Invalid arguments when calling pipe_to(#{dst})" end |
- (self) resume
239 240 241 242 243 244 245 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx/record_parser.rb', line 239 def resume if !block_given? @j_del.java_method(:resume, []).call() return self end raise ArgumentError, "Invalid arguments when calling resume()" end |
- (void) set_output { ... }
This method returns an undefined value.
93 94 95 96 97 98 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx/record_parser.rb', line 93 def set_output if true return @j_del.java_method(:setOutput, [Java::IoVertxCore::Handler.java_class]).call((Proc.new { |event| yield(::Vertx::Util::Utils.safe_create(event,::Vertx::Buffer)) unless !block_given? })) end raise ArgumentError, "Invalid arguments when calling set_output()" end |