Class: Arachni::Support::Buffer::Base

Inherits:
Object
  • Object
show all
Includes:
Mixins::Observable
Defined in:
lib/arachni/support/buffer/base.rb

Overview

Base buffer class to be extended by more specialised implementation.

Author:

Direct Known Subclasses

AutoFlush

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Mixins::Observable

included

Methods included from Utilities

#available_port, #caller_name, #caller_path, #cookie_decode, #cookie_encode, #cookies_from_document, #cookies_from_file, #cookies_from_response, #exception_jail, #exclude_path?, #follow_protocol?, #form_decode, #form_encode, #forms_from_document, #forms_from_response, #generate_token, #get_path, #hms_to_seconds, #html_decode, #html_encode, #include_path?, #links_from_document, #links_from_response, #normalize_url, #page_from_response, #page_from_url, #parse_set_cookie, #path_in_domain?, #path_too_deep?, #port_available?, #rand_port, #random_seed, #redundant_path?, #remove_constants, #request_parse_body, #seconds_to_hms, #skip_page?, #skip_path?, #skip_resource?, #skip_response?, #to_absolute, #uri_decode, #uri_encode, #uri_parse, #uri_parse_query, #uri_parser, #uri_rewrite

Constructor Details

#initialize(max_size = nil, type = Array) ⇒ Base

Returns a new instance of Base.

Parameters:

  • max_size (Integer) (defaults to: nil) —

    Maximum buffer size – won’t be enforced.

  • type (#<<, #|, #clear, #size, #empty?) (defaults to: Array) —

    Internal storage class to use.



39
40
41
42
43
 
# File 'lib/arachni/support/buffer/base.rb', line 39

def initialize( max_size = nil, type = Array )
    super()
    @buffer    = type.new
    @max_size  = max_size
end

Instance Attribute Details

#max_size ⇒ Integer (readonly)

Returns Maximum buffer size.

Returns:

  • (Integer) —

    Maximum buffer size.



33
34
35
 
# File 'lib/arachni/support/buffer/base.rb', line 33

def max_size
  @max_size
end

Instance Method Details

#<<(obj) ⇒ Object Also known as: push

Note:

Calls #on_push blocks with the given object and pushes an object to the buffer.

Parameters:

  • obj (Object) —

    Object to push.



50
51
52
53
54
 
# File 'lib/arachni/support/buffer/base.rb', line 50

def <<( obj )
    notify_on_push obj
    @buffer << obj
    self
end

#batch_push(list) ⇒ Object

Note:

Calls #on_batch_push blocks with the given list and merges the buffer with the contents of a list.

Parameters:

  • list (#|) —

    List of objects



62
63
64
65
66
 
# File 'lib/arachni/support/buffer/base.rb', line 62

def batch_push( list )
    notify_on_batch_push list
    @buffer |= list
    self
end

#empty? ⇒ Bool

Returns ‘true` if the buffer is empty, `false` otherwise.

Returns:

  • (Bool) —

    ‘true` if the buffer is empty, `false` otherwise.



76
77
78
 
# File 'lib/arachni/support/buffer/base.rb', line 76

def empty?
    @buffer.empty?
end

#flush ⇒ Object

Note:

Calls #on_flush blocks with the buffer and then empties it.

Returns current buffer.

Returns:

  • current buffer



89
90
91
92
93
94
95
 
# File 'lib/arachni/support/buffer/base.rb', line 89

def flush
    buffer = @buffer.dup
    notify_on_flush buffer
    buffer
ensure
    @buffer.clear
end

#full? ⇒ Bool

Returns ‘true` if the buffer is full, `false` otherwise.

Returns:

  • (Bool) —

    ‘true` if the buffer is full, `false` otherwise.



82
83
84
 
# File 'lib/arachni/support/buffer/base.rb', line 82

def full?
    !!(max_size && size >= max_size)
end

#on_batch_push(&block) ⇒ Object

Parameters:



26
 
# File 'lib/arachni/support/buffer/base.rb', line 26

advertise :on_batch_push

#on_flush(&block) ⇒ Object

Parameters:

  • block (Block) —

    block to call on #flush



30
 
# File 'lib/arachni/support/buffer/base.rb', line 30

advertise :on_flush

#on_push(&block) ⇒ Object

Parameters:

  • block (Block) —

    block to call on #push



22
 
# File 'lib/arachni/support/buffer/base.rb', line 22

advertise :on_push

#size ⇒ Integer

Returns Number of object in the buffer.

Returns:

  • (Integer) —

    Number of object in the buffer.



70
71
72
 
# File 'lib/arachni/support/buffer/base.rb', line 70

def size
    @buffer.size
end