ControllerConfig (sdn-apidoc 2.6.8 API)

java.lang.Object
- com.hp.of.ctl.ControllerConfig

```
public class ControllerConfig
extends Object
```
Encapsulates the run-time configuration parameters for the Openflow Controller. Instances of this class are immutable.
The values (with defaults shown in square brackets) are:
- addresses: the set of interface addresses to listen on; null (or the empty set) denotes listening on all available interfaces. [null]
- listenPort: the OpenFlow listen port for non-secure connections. [6633]
- tlsListenPort: the OpenFlow listen port for secure (TLS) connections. [6634]
- udpPort: the OpenFlow port for UDP. [6635]
- securityContext: the security context for secure communications. [null]
- suppressSetConfig: the SetConfig behavior suppression flag. A value of false means that the controller will send a SetConfig message to a datapath, soon after it completes its handshake. A value of true means this behavior is suppressed (i.e. no SetConfig message is sent). [false]
- rcvBufSize: the receive buffer size for TCP or TLS connection oriented transport. [1048576]
- udpRcvBufSize: the receive buffer size for UDP connectionless transport. [1024]
- workerCount: number of I/O workers. [16]
- idleCheckMs: milliseconds between checks for idle connections. [500]
- maxIdleMs: milliseconds to consider connection to be idle. [5000]
- maxEchoMs: milliseconds between echo requests on idle connections. [5000]
- maxEchoAttempts: number of attempts to wake idle connections. [5]
- strictMessageParsing: a value of true will cause the MessageFactory to employ strict parsing of OpenFlow messages. [false]
- enforcementLevel: enforcement level of flow mod compliance against prior flow mod class registrations. ["weak"]
- hybridMode: a value of true will allow controlled switch to decide primary packet flow. [true]
- suppressFlowFailures: a value of true will suppress datapath errors for certain performance test platforms that cannot handle the setting of flow mods. [false]
This class uses the builder pattern. For example, to create an instance where we supply a security context and also set strict message parsing in the OpenFlow Message Library, the following code might be used:
```
 ControllerConfig cfg = new ControllerConfig.Builder()
         .securityContext(secCtx).strictMessageParsing().build();
 
```
Note that all other parameters will have default values.
Author:

Scott Simes, Simon Hunt, Sudheer Duggisetty, Thomas Vachuska

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ControllerConfig.Builder
Builds instances of ControllerConfig.

Nested Classes
Modifier and Type	Class and Description
`static class`	`ControllerConfig.Builder` Builds instances of ControllerConfig.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`DEF_ENFORCEMENT_LEVEL` Default flow mod enforcement level.
`static boolean`	`DEF_HYBRID_MODE` Default setting for hybrid mode.
`static int`	`DEF_IDLE_CHECK_MS` Default number of milliseconds between idle connection checks.
`static int`	`DEF_MAX_ECHO_ATTEMPTS` Default number of attempts to wake idle connection with echo requests.
`static int`	`DEF_MAX_ECHO_MS` Default number of milliseconds between idle connection echo requests.
`static int`	`DEF_MAX_IDLE_MS` Default number of milliseconds to consider connections idle.
`static int`	`DEF_PORT` The default OpenFlow listen port (6633).
`static int`	`DEF_RCV_BUF_SIZE` The default buffer size for TCP / TLS connections.
`static boolean`	`DEF_SUPPRESS_FLOW_FAILURES` Default setting for suppressFlowFailures.
`static int`	`DEF_TLS_PORT` The default OpenFlow TLS listen port (6634).
`static int`	`DEF_UDP_PORT` The default OpenFlow UDP port (6635).
`static int`	`DEF_UDP_RCV_BUF_SIZE` The default buffer size for UDP connections.
`static int`	`DEF_WORKER_COUNT` The default I/O loop worker count.
`static String`	`ENFORCEMENT_LEVEL_NONE` No flow mod enforcement level.
`static String`	`ENFORCEMENT_LEVEL_STRICT` Strict flow mod enforcement level.

Method Summary

Methods
Modifier and Type	Method and Description
`Set<IpAddress>`	`addresses()` Returns the set of addresses to listen on.
`boolean`	`bounceRequired(ControllerConfig old)` Predicate that returns true if the difference between this (newer) controller configuration and the specified (older) configuration would require the controller to be bounced for the configuration changes to take effect.
`FlowClassAdministrator.EnforcementLevel`	`enforcementLevel()` Returns enforcement level for flow mod compliance against flow class registrations.
`boolean`	`hybridMode()` Returns true if Hybrid Mode is enabled.
`int`	`idleCheckMs()` Returns the period of idle connection detection.
`int`	`listenPort()` Returns the OpenFlow listen port for non-secure connections.
`int`	`maxEchoAttempts()` Returns the number of tries to wake idle connections.
`int`	`maxEchoMs()` Returns the period of echo requests on idle connections.
`int`	`maxIdleMs()` Returns the milliseconds before connections are considered idle.
`int`	`rcvBufSize()` Returns the TCP or TLS receive buffer size.
`SecurityContext`	`securityContext()` Returns the security context for the secure (TLS) connection.
`boolean`	`strictMessageParsing()` Returns true if the message factory will use strict parsing of OpenFlow messages.
`boolean`	`suppressFlowFailures()` Returns the value of suppressFlowFailures which needs to be tweaked when running tools that can't handle flow mods.
`boolean`	`suppressSetConfig()` Returns the SetConfig behavior suppression flag.
`int`	`tlsListenPort()` Returns the OpenFlow listen port for secure (TLS) connections.
`String`	`toString()`
`int`	`udpPort()` Returns the OpenFlow UDP port.
`int`	`udpRcvBufSize()` Returns the UDP receive buffer size.
`int`	`workerCount()` Returns the I/O loop worker count.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - DEF_PORT
```
public static final int DEF_PORT
```
    The default OpenFlow listen port (6633).
    
    See Also:
    Constant Field Values
  - DEF_TLS_PORT
```
public static final int DEF_TLS_PORT
```
    The default OpenFlow TLS listen port (6634).
    
    See Also:
    Constant Field Values
  - DEF_UDP_PORT
```
public static final int DEF_UDP_PORT
```
    The default OpenFlow UDP port (6635).
    
    See Also:
    Constant Field Values
  - DEF_RCV_BUF_SIZE
```
public static final int DEF_RCV_BUF_SIZE
```
    The default buffer size for TCP / TLS connections.
    
    See Also:
    Constant Field Values
  - DEF_UDP_RCV_BUF_SIZE
```
public static final int DEF_UDP_RCV_BUF_SIZE
```
    The default buffer size for UDP connections.
    
    See Also:
    Constant Field Values
  - DEF_WORKER_COUNT
```
public static final int DEF_WORKER_COUNT
```
    The default I/O loop worker count.
    
    See Also:
    Constant Field Values
  - DEF_IDLE_CHECK_MS
```
public static final int DEF_IDLE_CHECK_MS
```
    Default number of milliseconds between idle connection checks.
    
    See Also:
    Constant Field Values
  - DEF_MAX_IDLE_MS
```
public static final int DEF_MAX_IDLE_MS
```
    Default number of milliseconds to consider connections idle.
    
    See Also:
    Constant Field Values
  - DEF_MAX_ECHO_ATTEMPTS
```
public static final int DEF_MAX_ECHO_ATTEMPTS
```
    Default number of attempts to wake idle connection with echo requests.
    
    See Also:
    Constant Field Values
  - DEF_MAX_ECHO_MS
```
public static final int DEF_MAX_ECHO_MS
```
    Default number of milliseconds between idle connection echo requests.
    
    See Also:
    Constant Field Values
  - DEF_ENFORCEMENT_LEVEL
```
public static final String DEF_ENFORCEMENT_LEVEL
```
    Default flow mod enforcement level.
    
    See Also:
    Constant Field Values
  - ENFORCEMENT_LEVEL_STRICT
```
public static final String ENFORCEMENT_LEVEL_STRICT
```
    Strict flow mod enforcement level.
    
    See Also:
    Constant Field Values
  - ENFORCEMENT_LEVEL_NONE
```
public static final String ENFORCEMENT_LEVEL_NONE
```
    No flow mod enforcement level.
    
    See Also:
    Constant Field Values
  - DEF_HYBRID_MODE
```
public static final boolean DEF_HYBRID_MODE
```
    Default setting for hybrid mode.
    
    See Also:
    Constant Field Values
  - DEF_SUPPRESS_FLOW_FAILURES
```
public static final boolean DEF_SUPPRESS_FLOW_FAILURES
```
    Default setting for suppressFlowFailures.
    
    See Also:
    Constant Field Values
- Method Detail
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - addresses
```
public Set<IpAddress> addresses()
```
    Returns the set of addresses to listen on. May be null, or an empty set, which indicates all available interfaces.
    
    Returns:
    the set of addresses
  - listenPort
```
public int listenPort()
```
    Returns the OpenFlow listen port for non-secure connections.
    
    Returns:
    the OpenFlow listen port
  - tlsListenPort
```
public int tlsListenPort()
```
    Returns the OpenFlow listen port for secure (TLS) connections.
    
    Returns:
    the OpenFlow TLS listen port
  - udpPort
```
public int udpPort()
```
    Returns the OpenFlow UDP port.
    
    Returns:
    the OpenFlow UDP port
  - securityContext
```
public SecurityContext securityContext()
```
    Returns the security context for the secure (TLS) connection.
    
    Returns:
    the security context
  - suppressSetConfig
```
public boolean suppressSetConfig()
```
    Returns the SetConfig behavior suppression flag.
    A value of false means that the controller will send a SetConfig message to a datapath, soon after it completes its handshake. A value of true means this behavior is suppressed (i.e. no SetConfig message is sent).
    
    Returns:
    the SetConfig suppression flag
  - rcvBufSize
```
public int rcvBufSize()
```
    Returns the TCP or TLS receive buffer size.
    
    Returns:
    the TCP or TLS receive buffer size
  - udpRcvBufSize
```
public int udpRcvBufSize()
```
    Returns the UDP receive buffer size.
    
    Returns:
    the UDP receive buffer size
  - workerCount
```
public int workerCount()
```
    Returns the I/O loop worker count.
    
    Returns:
    number of I/O loop workers
  - idleCheckMs
```
public int idleCheckMs()
```
    Returns the period of idle connection detection.
    
    Returns:
    milliseconds between idle connection checks
  - maxIdleMs
```
public int maxIdleMs()
```
    Returns the milliseconds before connections are considered idle.
    
    Returns:
    milliseconds before connection is considered idle
  - maxEchoMs
```
public int maxEchoMs()
```
    Returns the period of echo requests on idle connections.
    
    Returns:
    milliseconds between echo requests on idle connections
  - maxEchoAttempts
```
public int maxEchoAttempts()
```
    Returns the number of tries to wake idle connections.
    
    Returns:
    number of attempts allowed to wake idle connections
  - strictMessageParsing
```
public boolean strictMessageParsing()
```
    Returns true if the message factory will use strict parsing of OpenFlow messages. Generally speaking, this means that the parser will throw an exception if 1-bits are discovered in non-spec-defined areas of bitmasks, amongst other items.
    
    Returns:
    true if message factory is to employ strict parsing
  - enforcementLevel
```
public FlowClassAdministrator.EnforcementLevel enforcementLevel()
```
    Returns enforcement level for flow mod compliance against flow class registrations.
    
    Returns:
    flow mod enforcement level
  - hybridMode
```
public boolean hybridMode()
```
    Returns true if Hybrid Mode is enabled. Hybrid Mode allows the switch to decide packet forwarding.
    
    Returns:
    true if hybrid mode is enabled
  - suppressFlowFailures
```
public boolean suppressFlowFailures()
```
    Returns the value of suppressFlowFailures which needs to be tweaked when running tools that can't handle flow mods.
    
    Returns:
    the value of suppressFlowFailures
  - bounceRequired
```
public boolean bounceRequired(ControllerConfig old)
```
    Predicate that returns true if the difference between this (newer) controller configuration and the specified (older) configuration would require the controller to be bounced for the configuration changes to take effect.
    Currently, this will return true if:
    - the set of IP addresses on which to bind has changed
    - any of the listen ports have changed
    - the security context has changed
    - any receive buffer sizes have changed
    - the worker count has changed
    - the idle check period has changed
    - the flow class enforcement level has changed
    - hybrid mode has changed
    Parameters:
    old - the old configuration to compare with
    
    Returns:
    true, if the controller should be bounced

Class ControllerConfig

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEF_PORT

DEF_TLS_PORT

DEF_UDP_PORT

DEF_RCV_BUF_SIZE

DEF_UDP_RCV_BUF_SIZE

DEF_WORKER_COUNT

DEF_IDLE_CHECK_MS

DEF_MAX_IDLE_MS

DEF_MAX_ECHO_ATTEMPTS

DEF_MAX_ECHO_MS

DEF_ENFORCEMENT_LEVEL

ENFORCEMENT_LEVEL_STRICT

ENFORCEMENT_LEVEL_NONE

DEF_HYBRID_MODE

DEF_SUPPRESS_FLOW_FAILURES

Method Detail

toString

addresses

listenPort

tlsListenPort

udpPort

securityContext

suppressSetConfig

rcvBufSize

udpRcvBufSize

workerCount

idleCheckMs

maxIdleMs

maxEchoMs

maxEchoAttempts

strictMessageParsing

enforcementLevel

hybridMode

suppressFlowFailures

bounceRequired