Class: RFlow::Configuration::Connection

Inherits:
ConfigurationItem show all
Includes:
ActiveModel::Validations
Defined in:
lib/rflow/configuration/connection.rb

Overview

Represents a component-to-component connection in the SQLite database.

Direct Known Subclasses

BrokeredZMQConnection, ZMQConnection

Defined Under Namespace

Classes: ConnectionInvalid

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#input_port ⇒ InputPort

The InputPort to which this RFlow::Configuration::Connection delivers messages.

Returns:



22
 
# File 'lib/rflow/configuration/connection.rb', line 22

belongs_to :input_port, :primary_key => 'uuid', :foreign_key => 'input_port_uuid'

#options ⇒ Hash

Open-ended Hash of component options, serialized via YAML to a single column.

Returns:

  • (Hash) 


17
 
# File 'lib/rflow/configuration/connection.rb', line 17

serialize :options, Hash

#output_port ⇒ OutputPort

The OutputPort from which this RFlow::Configuration::Connection receives messages.

Returns:



27
 
# File 'lib/rflow/configuration/connection.rb', line 27

belongs_to :output_port,:primary_key => 'uuid', :foreign_key => 'output_port_uuid'

Class Method Details

.default_options ⇒ Hash

Should return a hash of default options, where the keys are the option names and the values are either default option values or Procs that take a single connection argument. This allow defaults to use other parameters in the connection to construct the appropriate default value. To be overridden by subclasses.

Returns:

  • (Hash) 


65
 
# File 'lib/rflow/configuration/connection.rb', line 65

def self.default_options; {}; end

.required_options ⇒ Array<String>

Should return a list of require option names which will be used in validations. To be overridden by subclasses.

Returns:

  • (Array<String>) 


56
 
# File 'lib/rflow/configuration/connection.rb', line 56

def self.required_options; []; end

Instance Method Details

#brokers ⇒ Array<Broker>

By default, no broker processes are required to manage a connection. To be overridden by subclasses.

Returns:



70
 
# File 'lib/rflow/configuration/connection.rb', line 70

def brokers; []; end