Close #

Closes the socket. If this side has just written data and the peer has not read it yet, prefer `CloseGracefully()`. On Windows loopback, closing first can discard what was just written -- see that method and `docs/windows_loopback_sockets.md`.

method : public : Close() ~ Nil

CloseGracefully #

Closes the socket after letting the peer read what was written and hang up first. On Windows over loopback, a peer that writes and then immediately closes can have the data it just sent **discarded**: the reader gets a connection reset and zero bytes rather than a short read, even though every byte was accepted and had arrived. The race is between this side's teardown and the peer's read, so the remedy is to not be the side that closes first. It is a platform behaviour, not something a socket option can turn off -- seven candidate fixes were measured and none worked (`docs/windows_loopback_sockets.md`). This reads and discards anything still arriving until the peer closes, which is the point of the call, and then closes. Use it wherever a server writes a response and is finished with the connection: Bounded on both sides, so it cannot park a thread: it gives up after `timeout_ms` of silence, and after 16 reads of a peer that keeps sending instead of closing. In the ordinary case -- the peer reads the response and hangs up -- it returns as soon as that happens, and costs nothing. `Close()` stays correct when the peer has already closed, or when this side is the one being told to hang up. Linux and real network interfaces are unaffected either way; this matters on Windows loopback.

method : public : CloseGracefully(timeout_ms:Int) ~ Nil

Parameters

Example

socket->WriteString(response);
socket->CloseGracefully();

Flush #

Flushes the output buffer. This is a no-opt given this socket is not backed by an output buffer.

method : public : Flush() ~ Nil

GetAddress #

Returns the connected network address

method : public : GetAddress() ~ String

Return

GetLastError # function

Get the last error

function : GetLastError() ~ String

Return

GetPort #

Returns the connected network port

method : public : GetPort() ~ Int

Return

HostName # function

Reads the host name

function : HostName() ~ System.String

Return

IsOpen #

Returns rather the socket is open

method : public : IsOpen() ~ Bool

Return

New # constructor

Default constructor

New(address:System.String, port:Int)

Parameters

New # constructor

Constructor with connect timeout

New(address:System.String, port:Int, connect_timeout:Int)

Parameters

ReadBuffer #

Reads bytes into a byte buffer

method : public : ReadBuffer(offset:Int, num:Int, buffer:Byte[]) ~ Int

Parameters

Return

ReadBuffer #

Reads bytes into a character buffer

method : public : ReadBuffer(offset:Int, num:Int, buffer:Char[]) ~ Int

Parameters

Return

ReadByte #

Reads a byte

method : public : ReadByte() ~ Byte

Return

ReadLine #

Reads a string until a newline or character return is detected

method : public : ReadLine() ~ System.String

Return

Resolve # function

List of resolved IP addresses

function : Resolve(n:System.String) ~ System.String[]

Parameters

Return

Select #

Checks if read/write data is available

method : public : Select(is_write:Bool) ~ Int

Parameters

Return

SetConnectTimeout #

Sets the connect timeout for the next connection attempt. Must be called before New() or before reconnecting.

method : public : SetConnectTimeout(ms:Int) ~ Nil

Parameters

SetKeepAlive #

Sets the TCP keep-alive option

method : public : SetKeepAlive(enable:Bool) ~ Bool

Parameters

Return

SetNoDelay #

Disables Nagle's algorithm (TCP_NODELAY) for low-latency sends

method : public : SetNoDelay(enable:Bool) ~ Bool

Parameters

Return

SetRecvBufferSize #

Sets the receive buffer size

method : public : SetRecvBufferSize(bytes:Int) ~ Bool

Parameters

Return

SetRecvTimeout #

Sets the receive timeout

method : public : SetRecvTimeout(ms:Int) ~ Bool

Parameters

Return

SetSendBufferSize #

Sets the send buffer size

method : public : SetSendBufferSize(bytes:Int) ~ Bool

Parameters

Return

SetSendTimeout #

Sets the send timeout

method : public : SetSendTimeout(ms:Int) ~ Bool

Parameters

Return

WriteBuffer #

Writes bytes from a byte buffer

method : public : WriteBuffer(buffer:Byte[]) ~ Int

Parameters

Return

WriteBuffer #

Writes bytes from a byte buffer

method : public : WriteBuffer(offset:Int, num:Int, buffer:Byte[]) ~ Int

Parameters

Return

WriteBuffer #

Writes characters from a byte buffer

method : public : WriteBuffer(buffer:Char[]) ~ Int

Parameters

Return

WriteBuffer #

Writes characters from a character buffer

method : public : WriteBuffer(offset:Int, num:Int, buffer:Char[]) ~ Int

Parameters

Return

WriteByte #

Writes a byte

method : public : WriteByte(b:Int) ~ Bool

Parameters

Return

WriteString #

Writes a character string

method : public : WriteString(str:System.String) ~ Nil

Parameters