Idris2Doc : Node.Net.Socket

Node.Net.Socket

(source)

Reexports

import public Node.Error
import public Node.Net.Socket.Address
import public Node.Net.Socket.Connect
import public Node.Net.Socket.Type
import public Node.Stream

Definitions

socketOnClose : HasIO io => s -> (Bool -> IO ()) -> io ()
Visibility: export
socketOnConnect : HasIO io => s -> IO () -> io ()
Visibility: export
socketOnError : HasIO io => s -> (Error -> IO ()) -> io ()
Visibility: export
socketOnLookup : HasIO io => s -> (Maybe Error -> String -> Maybe String -> String -> IO ()) -> io ()
Visibility: export
socketOnReady : HasIO io => s -> IO () -> io ()
Visibility: export
socketOnTimeout : HasIO io => s -> IO () -> io ()
Visibility: export
socketAddress : HasIO io => s -> io (Maybe Address)
Visibility: export
socketConnect : HasIO io => s -> {auto t : SocketType} -> options t -> io s
Visibility: export
socketDestroy : HasIO io => s -> Maybe Error -> io s
Visibility: export
socketRef : HasIO io => s -> io s
Visibility: export
socketResetAndDestroy : HasIO io => s -> io s
Visibility: export
socketSetKeepAlive : HasIO io => s -> Maybe Int -> io s
Visibility: export
socketSetNoDelay : HasIO io => s -> Bool -> io s
Visibility: export
socketSetTimeout : HasIO io => s -> Maybe Int -> io s
Visibility: export
socketTimeout : HasIO io => s -> io (Maybe Int)
Visibility: export
socketUnref : HasIO io => s -> io s
Visibility: export
interface SocketClass : SocketType -> Type -> Type
Parameters: t, s
Constraints: ReadableClass d Error s, WriteableClass d Error s
Methods:
.onClose : HasIO io => s -> (Bool -> IO ()) -> io ()
.onConnect : HasIO io => s -> IO () -> io ()
.onError : HasIO io => s -> (Error -> IO ()) -> io ()
.onLookup : HasIO io => s -> (Maybe Error -> String -> Maybe String -> String -> IO ()) -> io ()
.onReady : HasIO io => s -> IO () -> io ()
.onTimeout : HasIO io => s -> IO () -> io ()
.address : HasIO io => s -> io (Maybe Address)
.bytesRead : HasIO io => s -> io Int
.bytesWritten : HasIO io => s -> io Int
.connect : HasIO io => s -> options t -> io s
.connecting : HasIO io => s -> io Bool
.destroy : HasIO io => s -> Maybe Error -> io s
.destroyed : HasIO io => s -> io Bool
.localAddress : HasIO io => s -> io (Maybe String)
.localPort : HasIO io => s -> io (Maybe Int)
.pending : HasIO io => s -> io Bool
.ref : HasIO io => s -> io s
.remoteAddress : HasIO io => s -> io (Maybe String)
.remoteFamily : HasIO io => s -> io (Maybe String)
.remotePort : HasIO io => s -> io (Maybe Int)
.resetAndDestroy : HasIO io => s -> io s
.setKeepAlive : HasIO io => s -> Maybe Int -> io s
.setNoDelay : HasIO io => s -> Bool -> io s
.setTimeout : HasIO io => s -> Maybe Int -> io s
.timeout : HasIO io => s -> io (Maybe Int)
.unref : HasIO io => s -> io s
.readyState : HasIO io => s -> io String

Implementations:
SocketClass TCP (Socket TCP)
SocketClass IPC (Socket IPC)
.onClose : SocketClass t s => HasIO io => s -> (Bool -> IO ()) -> io ()
Visibility: public export
.onConnect : SocketClass t s => HasIO io => s -> IO () -> io ()
Visibility: public export
.onError : SocketClass t s => HasIO io => s -> (Error -> IO ()) -> io ()
Visibility: public export
.onLookup : SocketClass t s => HasIO io => s -> (Maybe Error -> String -> Maybe String -> String -> IO ()) -> io ()
Visibility: public export
.onReady : SocketClass t s => HasIO io => s -> IO () -> io ()
Visibility: public export
.onTimeout : SocketClass t s => HasIO io => s -> IO () -> io ()
Visibility: public export
.address : SocketClass t s => HasIO io => s -> io (Maybe Address)
Visibility: public export
.bytesRead : SocketClass t s => HasIO io => s -> io Int
Visibility: public export
.bytesWritten : SocketClass t s => HasIO io => s -> io Int
Visibility: public export
.connect : SocketClass t s => HasIO io => s -> options t -> io s
Visibility: public export
.connecting : SocketClass t s => HasIO io => s -> io Bool
Visibility: public export
.destroy : SocketClass t s => HasIO io => s -> Maybe Error -> io s
Visibility: public export
.destroyed : SocketClass t s => HasIO io => s -> io Bool
Visibility: public export
.localAddress : SocketClass t s => HasIO io => s -> io (Maybe String)
Visibility: public export
.localPort : SocketClass t s => HasIO io => s -> io (Maybe Int)
Visibility: public export
.pending : SocketClass t s => HasIO io => s -> io Bool
Visibility: public export
.ref : SocketClass t s => HasIO io => s -> io s
Visibility: public export
.remoteAddress : SocketClass t s => HasIO io => s -> io (Maybe String)
Visibility: public export
.remoteFamily : SocketClass t s => HasIO io => s -> io (Maybe String)
Visibility: public export
.remotePort : SocketClass t s => HasIO io => s -> io (Maybe Int)
Visibility: public export
.resetAndDestroy : SocketClass t s => HasIO io => s -> io s
Visibility: public export
.setKeepAlive : SocketClass t s => HasIO io => s -> Maybe Int -> io s
Visibility: public export
.setNoDelay : SocketClass t s => HasIO io => s -> Bool -> io s
Visibility: public export
.setTimeout : SocketClass t s => HasIO io => s -> Maybe Int -> io s
Visibility: public export
.timeout : SocketClass t s => HasIO io => s -> io (Maybe Int)
Visibility: public export
.unref : SocketClass t s => HasIO io => s -> io s
Visibility: public export
.readyState : SocketClass t s => HasIO io => s -> io String
Visibility: public export
data Socket : SocketType -> Type
Totality: total
Visibility: export
Hints:
ReadableClass d Error (Socket t)
SocketClass TCP (Socket TCP)
SocketClass IPC (Socket IPC)
WriteableClass d Error (Socket t)
record Options : Type
Totality: total
Visibility: public export
Constructor: 
MkOptions : Maybe Int -> Maybe Bool -> Maybe Bool -> Maybe Bool -> Options

Projections:
.allowHalfOpen : Options -> Maybe Bool
.fd : Options -> Maybe Int
.readable : Options -> Maybe Bool
.writeable : Options -> Maybe Bool
.fd : Options -> Maybe Int
Visibility: public export
fd : Options -> Maybe Int
Visibility: public export
.allowHalfOpen : Options -> Maybe Bool
Visibility: public export
allowHalfOpen : Options -> Maybe Bool
Visibility: public export
.readable : Options -> Maybe Bool
Visibility: public export
readable : Options -> Maybe Bool
Visibility: public export
.writeable : Options -> Maybe Bool
Visibility: public export
writeable : Options -> Maybe Bool
Visibility: public export
defaultOptions : Options
Visibility: export
convertOptions : Options -> Node Options
Visibility: export