Class: Karafka::Web::Pro::Commanding::Commands::Base

Inherits:

Object

• Object
• Karafka::Web::Pro::Commanding::Commands::Base

Defined in:

lib/karafka/web/pro/commanding/commands/base.rb

Overview

Base for all the commands

Direct Known Subclasses

Consumers::Quiet, Consumers::Stop, Consumers::Trace, Partitions::Pause, Partitions::Resume, Partitions::Seek, Topics::Pause, Topics::Resume

Class Attribute Summary

• .name ⇒ Object

  Returns the value of attribute name.

Instance Attribute Summary

• #command ⇒ Hash readonly

Instance Method Summary

• #call ⇒ Object

  Executes the command after receiving it.

• #initialize(command) ⇒ Base constructor

  A new instance of Base.

Constructor Details

#initialize(command) ⇒ Base

Returns a new instance of Base.

Parameters:

• command (Command) —

  command details (if any). Some commands may require extra details to work. They can be obtained from here.

# File 'lib/karafka/web/pro/commanding/commands/base.rb', line 48

def initialize(command)
  @command = command
end

Class Attribute Details

.name ⇒ Object

Returns the value of attribute name.

# File 'lib/karafka/web/pro/commanding/commands/base.rb', line 40

def name
  @name
end

Instance Attribute Details

#command ⇒ Hash (readonly)

Returns:

• (Hash)

# File 'lib/karafka/web/pro/commanding/commands/base.rb', line 44

def command
  @command
end

Instance Method Details

#call ⇒ Object

Executes the command after receiving it.

Raises:

• (NotImlementedError)

# File 'lib/karafka/web/pro/commanding/commands/base.rb', line 53

def call
  raise NotImlementedError, "Please implement in a subclass"
end