Class: Fluent::Plugin::Base

Inherits:
Object
  • Object
show all
Includes:
Configurable, SystemConfig::Mixin
Defined in:
lib/fluent/plugin/base.rb

Defined Under Namespace

Classes: State

Constant Summary

Constants included from Configurable

Configurable::CONFIG_TYPE_REGISTRY

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from SystemConfig::Mixin

#system_config, #system_config_override

Methods included from Configurable

#config, included, lookup_type, register_type

Constructor Details

#initialize ⇒ Base

Returns a new instance of Base.



31
32
33
34
35
 
# File 'lib/fluent/plugin/base.rb', line 31

def initialize
  super
  @_state = State.new(false, false, false, false, false, false, false, false, false)
  @under_plugin_development = false
end

Instance Attribute Details

#under_plugin_development ⇒ Object

Returns the value of attribute under_plugin_development.



29
30
31
 
# File 'lib/fluent/plugin/base.rb', line 29

def under_plugin_development
  @under_plugin_development
end

Instance Method Details

#after_shutdown ⇒ Object 



73
74
75
76
 
# File 'lib/fluent/plugin/base.rb', line 73

def after_shutdown
  @_state.after_shutdown = true
  self
end

#after_shutdown? ⇒ Boolean

Returns:

  • (Boolean) 


112
113
114
 
# File 'lib/fluent/plugin/base.rb', line 112

def after_shutdown?
  @_state.after_shutdown
end

#after_start ⇒ Object 



53
54
55
56
 
# File 'lib/fluent/plugin/base.rb', line 53

def after_start
  @_state.after_start = true
  self
end

#after_started? ⇒ Boolean

Returns:

  • (Boolean) 


96
97
98
 
# File 'lib/fluent/plugin/base.rb', line 96

def after_started?
  @_state.after_start
end

#before_shutdown ⇒ Object 



63
64
65
66
 
# File 'lib/fluent/plugin/base.rb', line 63

def before_shutdown
  @_state.before_shutdown = true
  self
end

#before_shutdown? ⇒ Boolean

Returns:

  • (Boolean) 


104
105
106
 
# File 'lib/fluent/plugin/base.rb', line 104

def before_shutdown?
  @_state.before_shutdown
end

#close ⇒ Object 



78
79
80
81
 
# File 'lib/fluent/plugin/base.rb', line 78

def close
  @_state.close = true
  self
end

#closed? ⇒ Boolean

Returns:

  • (Boolean) 


116
117
118
 
# File 'lib/fluent/plugin/base.rb', line 116

def closed?
  @_state.close
end

#configure(conf) ⇒ Object 



41
42
43
44
45
46
 
# File 'lib/fluent/plugin/base.rb', line 41

def configure(conf)
  super
  @_state ||= State.new(false, false, false, false, false, false, false, false, false)
  @_state.configure = true
  self
end

#configured? ⇒ Boolean

Returns:

  • (Boolean) 


88
89
90
 
# File 'lib/fluent/plugin/base.rb', line 88

def configured?
  @_state.configure
end

#has_router? ⇒ Boolean

Returns:

  • (Boolean) 


37
38
39
 
# File 'lib/fluent/plugin/base.rb', line 37

def has_router?
  false
end

#inspect ⇒ Object 



124
125
126
127
128
129
130
 
# File 'lib/fluent/plugin/base.rb', line 124

def inspect
  # Plugin instances are sometimes too big to dump because it may have too many thins (buffer,storage, ...)
  # Original commit comment says that:
  #   To emulate normal inspect behavior `ruby -e'o=Object.new;p o;p (o.__id__<<1).to_s(16)'`.
  #   https://github.com/ruby/ruby/blob/trunk/gc.c#L788
  "#<%s:%014x>" % [self.class.name, '0x%014x' % (__id__ << 1)]
end

#shutdown ⇒ Object 



68
69
70
71
 
# File 'lib/fluent/plugin/base.rb', line 68

def shutdown
  @_state.shutdown = true
  self
end

#shutdown? ⇒ Boolean

Returns:

  • (Boolean) 


108
109
110
 
# File 'lib/fluent/plugin/base.rb', line 108

def shutdown?
  @_state.shutdown
end

#start ⇒ Object 



48
49
50
51
 
# File 'lib/fluent/plugin/base.rb', line 48

def start
  @_state.start = true
  self
end

#started? ⇒ Boolean

Returns:

  • (Boolean) 


92
93
94
 
# File 'lib/fluent/plugin/base.rb', line 92

def started?
  @_state.start
end

#stop ⇒ Object 



58
59
60
61
 
# File 'lib/fluent/plugin/base.rb', line 58

def stop
  @_state.stop = true
  self
end

#stopped? ⇒ Boolean

Returns:

  • (Boolean) 


100
101
102
 
# File 'lib/fluent/plugin/base.rb', line 100

def stopped?
  @_state.stop
end

#terminate ⇒ Object 



83
84
85
86
 
# File 'lib/fluent/plugin/base.rb', line 83

def terminate
  @_state.terminate = true
  self
end

#terminated? ⇒ Boolean

Returns:

  • (Boolean) 


120
121
122
 
# File 'lib/fluent/plugin/base.rb', line 120

def terminated?
  @_state.terminate
end