Network.Socket.Wait

Simple Wait Api

wait

Arguments

:: String

Host

-> Int

Port

-> IO ()

wait will attempt to connect to the given host and port repeated every 10 milliseconds until it is successful. It will throw an IOError if the host cannot be resolved.

A typical use case is to call wait in test code to wait for a server to start before trying to connect. For example:

   void $ forkIO $ Warp.run 7000 app
   -- Wait for the server to start listening on the socket
   wait "127.0.0.1" 7000
   -- Communicate with the server

If you would like to control the delay or understand how many connection attempts were made use waitWith.

Since 0.0.0.1

Advanced Wait Api

waitWith

Arguments

:: EventHandlers IO

A record of IO actions that are called during sp

-> Int

Microseconds to delay

-> String

Host

-> Int

Port

-> IO ()

Advanced usage. In most situations calling wait will suffice. This allows one to customize the delay between retries and debug the behavior of the function. wait is defined as

   wait = waitWith mempty defaultDelay

Since 0.0.0.1

data EventHandlers m

The EventHandlers is a record of IO actions that are called when interesting events occur in the lifecycle of the waitWith loop. One can pass in custom EventHandlers values to implement logging and other forms of instrumentation.

For example for debug one could print out each step using:

   printHandlers = EventHandlers
     { acting     = putStrLn "acting"
     , delaying   = putStrLn "delaying"
     , restarting = putStrLn "restarting"
     }

Constructors

EventHandlers

Fields

• connecting :: m ()

  Called before the socket is created for connection

• delaying :: m ()

  Called after a failed attempt to connect before the thread is put to sleep.

• restarting :: m ()

  Called before a recursive call to restart the connection attempt

Instances

Semigroup (m ()) => Semigroup (EventHandlers m)

Defined in Network.Socket.Wait.Internal

Methods

(<>) :: EventHandlers m -> EventHandlers m -> EventHandlers m

sconcat :: NonEmpty (EventHandlers m) -> EventHandlers m

stimes :: Integral b => b -> EventHandlers m -> EventHandlers m

Monoid (m ()) => Monoid (EventHandlers m)

Defined in Network.Socket.Wait.Internal

Methods

mempty :: EventHandlers m

mappend :: EventHandlers m -> EventHandlers m -> EventHandlers m

mconcat :: [EventHandlers m] -> EventHandlers m

defaultDelay :: Int

The default delay between retries is 10000 microseconds (10 ms)