Class: Sonic::Channels::Base

Inherits:

Object

• Object
• Sonic::Channels::Base

Defined in:

lib/sonic/channels/base.rb

Direct Known Subclasses

Control, Ingest, Search

Instance Attribute Summary

• #connection ⇒ Object readonly

  Returns the value of attribute connection.

Instance Method Summary

• #help(manual) ⇒ Object
• #initialize(connection) ⇒ Base constructor

  A new instance of Base.

• #ping ⇒ Object
• #quit ⇒ Object

Constructor Details

#initialize(connection) ⇒ Base

# File 'lib/sonic/channels/base.rb', line 6

def initialize(connection)
  @connection = connection
end

Instance Attribute Details

#connection ⇒ Object (readonly)

Returns the value of attribute connection.

# File 'lib/sonic/channels/base.rb', line 4

def connection
  @connection
end

Instance Method Details

#help(manual) ⇒ Object

# File 'lib/sonic/channels/base.rb', line 14

def help(manual)
  execute('HELP', manual)
end

#ping ⇒ Object

# File 'lib/sonic/channels/base.rb', line 10

def ping
  execute('PING')
end

#quit ⇒ Object

# File 'lib/sonic/channels/base.rb', line 18

def quit
  execute('QUIT')
  connection.disconnect
end