ConnectionConfig (Vertigo Core 0.7.0-beta2 API)

All Superinterfaces:

Config<ConnectionConfig>, JsonSerializable

All Known Implementing Classes:

DefaultConnectionConfig
```
public interface ConnectionConfig
extends Config<ConnectionConfig>
```
A connection represents a link between two components within a network.
When a connection is created, each instance of the source component will be setup to send messages to each instance of the target component. How messages are routed to multiple target instances can be configured using selectors.

Author:

Jordan Halterman

Nested Class Summary

Nested Classes
Modifier and Type Interface and Description

static interface ConnectionConfig.Source
Connection source.

static interface ConnectionConfig.Target
Connection target.

Nested Classes
Modifier and Type	Interface and Description
`static interface`	`ConnectionConfig.Source` Connection source.
`static interface`	`ConnectionConfig.Target` Connection target.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`CONNECTION_HOOKS` `hooks` is an array defining connection hooks.
`static String`	`CONNECTION_SELECTOR` `selector` is an object defining the connection selector.
`static String`	`CONNECTION_SOURCE` `source` is an object defining the connection source.
`static String`	`CONNECTION_TARGET` `target` is an object defining the connection target.

Method Summary

Methods
Modifier and Type	Method and Description
`ConnectionConfig`	`addHook(IOHook hook)` Adds an input/output hook to the connection.
`ConnectionConfig`	`allSelect()` Sets an all selector on the connection.
`ConnectionConfig`	`customSelect(Selector selector)` Sets a custom selector on the connection.
`ConnectionConfig`	`fairSelect()` Sets a fair selector on the connection.
`List<IOHook>`	`getHooks()` Returns a list of connection hooks.
`Selector`	`getSelector()` Returns the connection selector.
`ConnectionConfig.Source`	`getSource()` Returns the connection source.
`ConnectionConfig.Target`	`getTarget()` Returns the connection target.
`ConnectionConfig`	`hashSelect()` Sets a mod-hash based selector on the connection.
`ConnectionConfig`	`randomSelect()` Sets a random selector on the connection.
`ConnectionConfig`	`roundSelect()` Sets a round-robin selector on the connection.
`ConnectionConfig`	`setSelector(Selector selector)` Sets the connection selector.

- Field Detail
  - CONNECTION_SOURCE
```
static final String CONNECTION_SOURCE
```
    source is an object defining the connection source. See the ConnectionConfig.Source documentation for details on the source structure.
    
    See Also:
    Constant Field Values
  - CONNECTION_TARGET
```
static final String CONNECTION_TARGET
```
    target is an object defining the connection target. See the ConnectionConfig.Target documentation for details on the target structure.
    
    See Also:
    Constant Field Values
  - CONNECTION_HOOKS
```
static final String CONNECTION_HOOKS
```
    hooks is an array defining connection hooks. Each element in the array must be an object containing a hook field which indicates the hook class name.
    
    See Also:
    Constant Field Values
  - CONNECTION_SELECTOR
```
static final String CONNECTION_SELECTOR
```
    selector is an object defining the connection selector. The selector definition should contain a type which indicates the selector type, e.g. round-robin, random, hash, fair, all, or custom. If a custom selector is indicated then an additional selector field must be provided which indicates the custom selector class.
    
    See Also:
    Constant Field Values
- Method Detail
  - getSource
```
ConnectionConfig.Source getSource()
```
    Returns the connection source.
    
    Returns:
    The connection source info.
  - getTarget
```
ConnectionConfig.Target getTarget()
```
    Returns the connection target.
    
    Returns:
    The connection target info.
  - addHook
```
ConnectionConfig addHook(IOHook hook)
```
    Adds an input/output hook to the connection.
    
    Parameters:
    hook - The hook to add.
    
    Returns:
    The connection configuration.
  - getHooks
```
List<IOHook> getHooks()
```
    Returns a list of connection hooks.
    
    Returns:
    A list of hooks for the connection.
  - getSelector
```
Selector getSelector()
```
    Returns the connection selector.
    
    Returns:
    The connection selector.
  - setSelector
```
ConnectionConfig setSelector(Selector selector)
```
    Sets the connection selector.
    
    Parameters:
    selector - The selector with which to select individual connections.
    
    Returns:
    The connection configuration.
  - roundSelect
```
ConnectionConfig roundSelect()
```
    Sets a round-robin selector on the connection.
    
    Returns:
    The connection configuration.
  - randomSelect
```
ConnectionConfig randomSelect()
```
    Sets a random selector on the connection.
    
    Returns:
    The connection configuration.
  - hashSelect
```
ConnectionConfig hashSelect()
```
    Sets a mod-hash based selector on the connection.
    
    Returns:
    The connection configuration.
  - fairSelect
```
ConnectionConfig fairSelect()
```
    Sets a fair selector on the connection.
    
    Returns:
    The connection configuration.
  - allSelect
```
ConnectionConfig allSelect()
```
    Sets an all selector on the connection.
    
    Returns:
    The connection configuration.
  - customSelect
```
ConnectionConfig customSelect(Selector selector)
```
    Sets a custom selector on the connection.
    
    Parameters:
    selector - The custom selector to set.
    
    Returns:
    The connection configuration.

Interface ConnectionConfig

Nested Class Summary

Field Summary

Method Summary

Field Detail

CONNECTION_SOURCE

CONNECTION_TARGET

CONNECTION_HOOKS

CONNECTION_SELECTOR

Method Detail

getSource

getTarget

addHook

getHooks

getSelector

setSelector

roundSelect

randomSelect

hashSelect

fairSelect

allSelect

customSelect