# Package com.h3c.of.ctl

Public API for the OpenFlow Controller.

See: Description

- Interface Summary
  Interface | Description
  --- | ---
  Alert | Represents an alert raised by the controller.
  AlertSink | A destination for alerts generated by the OpenFlow controller.
  CheckpointEvent | An OpenFlow Controller Checkpoint event.
  ConnectionDetails | Represents information about a specific "OpenFlow connection" (a network connection to a datapath, with a given auxiliary id), as part of an "OpenFlow channel" (the set of all connections to a given datapath).
  ControllerMx | Provides a management API to the OpenFlow Core Controller.
  ControllerService | Provides the public API to the SDN OpenFlow Controller — a one-stop-shop for SDN applications interacting with the controller.
  ControllerStats | Represents statistics about the number of OpenFlow messages handled by the controller.
  DataPathDetails | Extends `DataPathInfo` to provide additional information about an OpenFlow datapath; specifically, details of the currently available network connections.
  DataPathEvent | An OpenFlow Controller DataPath event.
  DataPathListener | A listener interested in hearing about OpenFlow datapath events.
  ErrorEvent | An OpenFlow Controller Error event.
  ListenerEvent | An OpenFlow Controller Listener event.
  MessageEvent | An OpenFlow Controller Message event.
  MessageListener | A listener interested in hearing about OpenFlow message events.
  MessageSender | Defines the API for sending OpenFlow messages to datapaths.
  OpenflowEvent | An OpenFlow Controller event.
  OpenflowListener<E extends OpenflowEvent> | The super-interface for listeners interested in hearing about OpenFlow Controller events.
  QueueEvent | An OpenFlow Controller Queue event.
  RegistrationListener | A listener interested in hearing about OpenFlow listener events.
  RoleAdvisor | Provides an abstraction of the "Role Service".
  SubComponentListener | Implemented by classes that interact with a controller `sub-component`, to be notified when datapath or message events occur.
  SubComponentService | Defines an API that may be implemented by controller sub-components to allow "helper" classes to interact with them.
  TxRxControl | Message transmission recording control API.
  TxRxTrigger | Defines the trigger condition for starting to record the TX/RX messages flowing through the controller.

- Class Summary
  Class | Description
  --- | ---
  ControllerParams | Encapsulates controller runtime parameters which may be of interest to "external" parties.
  ControllerParams.Builder | Builds instances of ControllerParams.
  ControllerServiceAdapter | An adapter for the `ControllerService` API, provided specifically for unit tests to use, to insulate themselves from changes in the API.
  ControllerStatsAdapter | An adapter for the `ControllerStats` API, provided specifically for unit tests to use, to insulate themselves from changes in the API.

- Enum Summary
  Enum | Description
  --- | ---
  Alert.Severity | Designates the severity of the alert.
  CheckpointEvent.Code | Designates the checkpoint code.
  OpenflowEventType | Designates the different OpenFlow Controller events that can occur.

## Package com.h3c.of.ctl Description

Public API for the OpenFlow Controller.

Copyright © 2014. All Rights Reserved.