-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/


-- | Box websockets
--   
--   Websockets built with the box library.
@package box-socket
@version 0.3.0


-- | Websocket components built with <a>Box</a>es.
module Box.Socket

-- | Socket configuration
--   
--   <pre>
--   &gt;&gt;&gt; defaultSocketConfig
--   SocketConfig {host = "127.0.0.1", port = 9160, path = "/"}
--   </pre>
data SocketConfig
SocketConfig :: Text -> Int -> Text -> SocketConfig
[host] :: SocketConfig -> Text
[port] :: SocketConfig -> Int
[path] :: SocketConfig -> Text

-- | official default
defaultSocketConfig :: SocketConfig

-- | Run a client app.
runClient :: MonadIO m => SocketConfig -> ClientApp () -> m ()

-- | Run a server app.
runServer :: MonadIO m => SocketConfig -> ServerApp -> m ()

-- | Connection continuation.
connect :: (MonadIO m, MonadConc m) => PendingConnection -> Codensity m Connection

-- | A simple client app for a box with Left debug messages.
clientApp :: (MonadIO m, MonadConc m) => Box m (Either Text Text) Text -> Connection -> m ()

-- | Canned response function.
responderApp :: (Text -> Either Text Text) -> PendingConnection -> IO ()

-- | Standard server app for a box.
serverApp :: (MonadConc m, MonadIO m) => Box m Text Text -> PendingConnection -> m ()

-- | default websocket receiver with messages Lefts are info/debug
receiver' :: MonadIO m => Committer m (Either Text Text) -> Connection -> m Bool

-- | Receiver that only commits.
receiver :: MonadIO m => Committer m Text -> Connection -> m ()

-- | Sender that only emits.
sender :: (MonadIO m, WebSocketsData a, Show a) => Box m Text a -> Connection -> m ()

-- | A receiver that responds based on received Text. lefts are quit
--   signals. Rights are response text.
responder :: MonadIO m => (Text -> Either Text Text) -> Committer m Text -> Connection -> m ()
instance GHC.Generics.Generic Box.Socket.SocketConfig
instance GHC.Classes.Eq Box.Socket.SocketConfig
instance GHC.Show.Show Box.Socket.SocketConfig

module Box.Socket.Example
serverIO :: IO ()
clientIO :: IO ()
q' :: IO a -> IO (Either () a)
cancelQ :: Emitter IO Text -> IO ()

-- | test of clientApp via a cRef committer and a canned list of Text
tClient :: [Text] -> IO [Either Text Text]
tClientIO :: [Text] -> IO ()

-- | main test run of client-server functionality the code starts a server
--   in a thread, starts the client in the main thread, and cancels the
--   server on completion. &gt;&gt;&gt; testRun [Left "receiver: received:
--   echo:1",Right "echo:1",Left "receiver: received: echo:2",Right
--   "echo:2",Left "receiver: received: echo:3",Right "echo:3",Left
--   "receiver: received: close: 1000 "received close signal: responder
--   closed.""]
testRun :: IO [Either Text Text]


-- | TCP Boxes.
module Box.TCP

-- | TCP configuration
--   
--   <pre>
--   &gt;&gt;&gt; defaultTCPConfig
--   TCPConfig {host = "127.0.0.1", port = "3566"}
--   </pre>
data TCPConfig
TCPConfig :: Text -> Text -> TCPConfig
[host] :: TCPConfig -> Text
[port] :: TCPConfig -> Text

-- | default
defaultTCPConfig :: TCPConfig

-- | An active TCP environment
data Env
Env :: Socket -> SockAddr -> Maybe (Async ()) -> Maybe (Async ()) -> Env
[socket] :: Env -> Socket
[sockaddr] :: Env -> SockAddr

-- | A screen dump thread
[ascreendump] :: Env -> Maybe (Async ())

-- | A file dump thread
[afiledump] :: Env -> Maybe (Async ())

-- | Connects to a server with no screen or file dump.
new :: TCPConfig -> IO Env

-- | close an Env
close :: Env -> IO ()

-- | Emits from a <a>Socket</a>
tcpEmitter :: Socket -> Emitter IO ByteString

-- | Commits to a <a>Socket</a>
tcpCommitter :: Socket -> Committer IO ByteString

-- | <a>Box</a> connection for a <a>Socket</a>
tcpBox :: Socket -> Box IO ByteString ByteString

-- | TCP server <a>Box</a>
tcpServer :: TCPConfig -> Box IO ByteString ByteString -> IO ()

-- | A server that explicitly responds to client messages.
tcpResponder :: TCPConfig -> (ByteString -> IO ByteString) -> IO ()

-- | A server independent of incoming messages.
tcpSender :: TCPConfig -> Emitter IO ByteString -> IO ()

-- | A TCP client connected to stdin
tcpStdClient :: TCPConfig -> IO ()

-- | test harness wrapping an action with a "q" escape.
testHarness :: IO () -> IO ()

-- | <tt>"echo: " &lt;&gt;</tt> Responder
testResponder :: IO ()

-- | Test server.
testServerSender :: IO ()
instance GHC.Generics.Generic Box.TCP.TCPConfig
instance GHC.Classes.Eq Box.TCP.TCPConfig
instance GHC.Show.Show Box.TCP.TCPConfig