Nettle.Servers.Server

Contents

Description

Provides a simple, basic, and efficient server which provides methods to listen for new switches to connect, and to receive and send OpenFlow messages to switches. This server handles the initialization procedure with switches and handles echo requests from switches.

Synopsis

OpenFlow Server

data OpenFlowServer Source

Abstract type containing the state of the OpenFlow server.

type ServerPortNumber = Word16 Source

type HostName = String

Either a host name e.g., "haskell.org" or a numeric host address string consisting of a dotted decimal IPv4 address or an IPv6 address e.g., "192.168.0.1".

startOpenFlowServer :: Maybe HostName -> ServerPortNumber -> IO OpenFlowServer Source

Starts an OpenFlow server. The server socket will be bound to a wildcard IP address if the first argument is Nothing and will be bound to a particular address if the first argument is Just something. The HostName value can either be an IP address in dotted quad notation, like 10.1.30.127, or a host name, whose IP address will be looked up. The server port must be specified.

acceptSwitch :: OpenFlowServer -> IO (SwitchHandle, SwitchFeatures)Source

Blocks until a switch connects to the server and returns the switch handle.

closeServer :: OpenFlowServer -> IO ()Source

Closes the OpenFlow server.

Switch connection

data SwitchHandle Source

Abstract type managing the state of the switch connection.

handle2SwitchID :: SwitchHandle -> SwitchID Source

switchSockAddr :: SwitchHandle -> SockAddr Source

Returns the socket address of the switch connection.

receiveFromSwitch :: SwitchHandle -> IO (Maybe (TransactionID, SCMessage))Source

Blocks until a message is received from the switch or the connection is closed. Returns Nothing only if the connection is closed.

receiveBatch :: SwitchHandle -> IO [(TransactionID, SCMessage)]Source

sendToSwitch :: SwitchHandle -> (TransactionID, CSMessage) -> IO ()Source

Send a message to the switch.

sendBatch :: SwitchHandle -> Int -> [(TransactionID, CSMessage)] -> IO ()Source

sendBatches :: SwitchHandle -> Int -> [[(TransactionID, CSMessage)]] -> IO ()Source

sendToSwitchWithID :: OpenFlowServer -> SwitchID -> (TransactionID, CSMessage) -> IO ()Source

closeSwitchHandle :: SwitchHandle -> IO ()Source

Close a switch connection.

Utility

untilNothing :: IO (Maybe a) -> (a -> IO ()) -> IO ()Source

Repeatedly perform the first action, passing its result to the second action, until the result of the first action is Nothing, at which point the computation returns.