Idris2Doc : System.UV.Raw.Handle

System.UV.Raw.Handle

(source)

Definitions

uv_handle_type_name : Int -> String
  Returns the name of the handle type.
record CloseCB : Type
Totality: total
Visibility: export
Constructor: 
CC : AnyPtr -> CloseCB

Projection: 
.ptr : CloseCB -> AnyPtr

Hints:
UVLoop => CloseCB
CloseCB => Resource (Ptr Tcp)
CloseCB => Resource (Ptr Stream)
CloseCB => Resource (Ptr Pipe)
CloseCB => Resource (Ptr Idle)
CloseCB => Resource (Ptr Check)
CloseCB => Resource (Ptr Prepare)
CloseCB => Resource (Ptr Signal)
Resource CloseCB
CloseCB => Resource (Ptr Timer)
freeCloseCB : HasIO io => CloseCB -> io ()
Totality: total
Visibility: export
uv_is_active : HasIO io => {auto 0 _ : PCast t Handle} -> Ptr t -> io Int32
Totality: total
Visibility: export
uv_is_closing : HasIO io => {auto 0 _ : PCast t Handle} -> Ptr t -> io Int32
Totality: total
Visibility: export
uv_close : HasIO io => {auto 0 _ : PCast t Handle} -> Ptr t -> CloseCB -> io ()
  Request a handle to be closed.

This *must* be called before releasing the handle from memory,
which can be done from within the callback or after the callback
has returned.

Totality: total
Visibility: export
uv_ref : HasIO io => {auto 0 _ : PCast t Handle} -> Ptr t -> io ()
  Reference a handle.

This is an idempotent action, so calling it several times has no
additional effect.

Totality: total
Visibility: export
uv_unref : HasIO io => {auto 0 _ : PCast t Handle} -> Ptr t -> io ()
  Un-reference a handle.

This is an idempotent action, so calling it several times has no
additional effect.

Totality: total
Visibility: export
uv_has_ref : HasIO io => {auto 0 _ : PCast t Handle} -> Ptr t -> io Bool
  Returns `True` is the handle is currently referenced.

Totality: total
Visibility: export
uv_handle_get_data : HasIO io => {auto 0 _ : PCast t Handle} -> Ptr t -> io AnyPtr
  Returns a pointer to the data associated with a handle.

Totality: total
Visibility: export
uv_handle_set_data : HasIO io => {auto 0 _ : PCast t Handle} -> Ptr t -> AnyPtr -> io ()
  Sets the data associated with a handle

Totality: total
Visibility: export
uv_handle_type : HasIO io => {auto 0 _ : PCast t Handle} -> Ptr t -> io Int
  Returns the type the current handle.

Totality: total
Visibility: export
freeHandle : HasIO io => {auto 0 _ : PCast t Handle} -> Ptr t -> io ()
Totality: total
Visibility: export
freeHandleWithoutUnlocking : HasIO io => {auto 0 _ : PCast t Handle} -> Ptr t -> io ()
Totality: total
Visibility: export
closeCB : HasIO io => (Ptr Handle -> IO ()) -> io CloseCB
  Allocates and locks a callback for closing handles.

The callback will run any custom operations given in the
`handler` argument before freeing the `Ptr Handle` from memory.

Totality: total
Visibility: export
defaultClose : HasIO io => io CloseCB
Totality: total
Visibility: export
closeWithoutUnlockingCB : HasIO io => io CloseCB
Totality: total
Visibility: export