def Std.Internal.UV.TCP.Socket : Type

Represents a TCP socket.

Equations

• Std.Internal.UV.TCP.Socket = Std.Internal.UV.TCP.SocketImpl✝.type

instance Std.Internal.UV.TCP.instNonemptySocket : Nonempty Socket

@[extern lean_uv_tcp_new]

opaque Std.Internal.UV.TCP.Socket.new : IO Socket

Creates a new TCP socket.

@[extern lean_uv_tcp_connect]

opaque Std.Internal.UV.TCP.Socket.connect (socket : Socket) (addr : Net.SocketAddress) : IO (IO.Promise (Except IO.Error Unit))

Connects a TCP socket to the specified address.

@[extern lean_uv_tcp_send]

opaque Std.Internal.UV.TCP.Socket.send (socket : Socket) (data : ByteArray) : IO (IO.Promise (Except IO.Error Unit))

Sends data through a TCP socket.

@[extern lean_uv_tcp_recv]

opaque Std.Internal.UV.TCP.Socket.recv? (socket : Socket) (size : UInt64) : IO (IO.Promise (Except IO.Error (Option ByteArray)))

Receives data from a TCP socket with a maximum size of size bytes. The promise resolves when data is available or an error occurs. If data is received, it’s wrapped in .some. If EOF is reached, the result is .none, indicating no more data is available. Receiving data in parallel on the same socket is not supported. Instead, we recommend binding multiple sockets to the same address. Furthermore calling this function in parallel with waitReadable is not supported.

@[extern lean_uv_tcp_wait_readable]

opaque Std.Internal.UV.TCP.Socket.waitReadable (socket : Socket) : IO (IO.Promise (Except IO.Error Bool))

Returns an IO.Promise that resolves to true once socket has data available for reading, or to false if socket is closed before that. Calling this function twice on the same Socket or in parallel with recv? is not supported.

@[extern lean_uv_tcp_cancel_recv]

opaque Std.Internal.UV.TCP.Socket.cancelRecv (socket : Socket) : IO Unit

Cancels a receive operation in the form of recv? or waitReadable if there is currently one pending. This resolves their returned IO.Promise to none. This function is considered dangerous, as improper use can cause data loss, and is therefore not exposed to the top-level API.

Note that this function is idempotent and as such can be called multiple times on the same socket without causing errors, in particular also without a receive running in the first place.

@[extern lean_uv_tcp_bind]

opaque Std.Internal.UV.TCP.Socket.bind (socket : Socket) (addr : Net.SocketAddress) : IO Unit

Binds a TCP socket to a specific address.

@[extern lean_uv_tcp_listen]

opaque Std.Internal.UV.TCP.Socket.listen (socket : Socket) (backlog : UInt32) : IO Unit

Starts listening for incoming connections on a TCP socket.

@[extern lean_uv_tcp_accept]

opaque Std.Internal.UV.TCP.Socket.accept (socket : Socket) : IO (IO.Promise (Except IO.Error Socket))

Accepts an incoming connection on a listening TCP socket.

@[extern lean_uv_tcp_shutdown]

opaque Std.Internal.UV.TCP.Socket.shutdown (socket : Socket) : IO (IO.Promise (Except IO.Error Unit))

Shuts down an incoming connection on a listening TCP socket.

@[extern lean_uv_tcp_getpeername]

opaque Std.Internal.UV.TCP.Socket.getPeerName (socket : Socket) : IO Net.SocketAddress

Gets the remote address of a connected TCP socket.

@[extern lean_uv_tcp_getsockname]

opaque Std.Internal.UV.TCP.Socket.getSockName (socket : Socket) : IO Net.SocketAddress

Gets the local address of a bound TCP socket.

@[extern lean_uv_tcp_nodelay]

opaque Std.Internal.UV.TCP.Socket.noDelay (socket : Socket) : IO Unit

Enables the Nagle algorithm for a TCP socket.

@[extern lean_uv_tcp_keepalive]

opaque Std.Internal.UV.TCP.Socket.keepAlive (socket : Socket) (enable : Int8) (delay : UInt32) : IO Unit

Enables TCP keep-alive for a socket. If delay is less than 1 then UV_EINVAL is returned.