Z.IO.UV.UVStream

This module provides UVStream handle type.

uv_stream abstraction

initUVStream :: HasCallStack => (Ptr UVLoop -> Ptr UVHandle -> IO ()) -> UVManager -> Resource UVStream

Safely lock an uv manager and perform uv_handle initialization.

Initialization an UV stream usually take two step:

• allocate an uv_stream struct with proper size
• lock a particular uv_loop from a uv manager, and perform custom initialization, such as uv_tcp_init.

And this is what initUVStream do, all you need to do is to provide the manager you want to hook the handle onto(usually the one on the same capability, i.e. the one obtained by getUVManager), and provide a custom initialization function (which should throw an exception if failed).

data UVStream

A haskell data type wrap an uv_stream_t inside

UVStream DO NOT provide thread safety! Use UVStream concurrently in multiple threads will lead to undefined behavior.

Constructors

UVStream

Fields

• uvsHandle :: !(Ptr UVHandle)
• uvsSlot :: !UVSlot
• uvsManager :: UVManager
• uvsClosed :: !(IORef Bool)

Instances

Show UVStream

Defined in Z.IO.UV.UVStream

Methods

showsPrec :: Int -> UVStream -> ShowS

show :: UVStream -> String

showList :: [UVStream] -> ShowS

Print UVStream

Defined in Z.IO.UV.UVStream

Methods

toUTF8BuilderP :: Int -> UVStream -> Builder ()

Output UVStream

Defined in Z.IO.UV.UVStream

Methods

writeOutput :: UVStream -> Ptr Word8 -> Int -> IO ()

Input UVStream

Defined in Z.IO.UV.UVStream

Methods

readInput :: UVStream -> Ptr Word8 -> Int -> IO Int

getUVStreamFD :: HasCallStack => UVStream -> IO FD

Get stream fd

closeUVStream :: UVStream -> IO ()

Manually close a uv stream.

shutdownUVStream :: HasCallStack => UVStream -> IO ()

Shutdown the outgoing (write) side of a duplex stream. It waits for pending write requests to complete.

Futher writing will throw ResourceVanished(EPIPE).

helloWorld :: UVStream -> IO ()

Write "hello world" to a UVStream.

echo :: UVStream -> IO ()

Echo whatever received bytes.