MPL › Standard Library › windows/ws2_32
Windows Winsock2 declarations for startup, sockets, byte order, address resolution, and overlapped I/O.
Constants
Address and socket selection
Socket options
Shutdown modes
I/O-control codes
Winsock status codes
Extension-function identifiers
Startup-data lengths
Schemas
For FN_ACCEPTEXRefFN_CONNECTEXRefFN_GETACCEPTEXSOCKADDRSRefWSAOVERLAPPED_COMPLETION_ROUTINERefNIL CodeNIL Code descriptors.
(lpOverlapped lpdwBytesReceived dwRemoteAddressLength dwLocalAddressLength dwReceiveDataLength lpOutputBuffer sAcceptSocket sListenSocket -- result) Defines the AcceptEx callback schema.
callback schema
Parameters
Outputs result: Int320 on failure or pending completion.
(lpOverlapped lpdwBytesSent dwSendDataLength lpSendBuffer namelen name s -- result) Defines the ConnectEx callback schema.
callback schema
Parameters
Outputs result: Int320 on failure or pending completion.
(RemoteSockaddrLength RemoteSockaddr LocalSockaddrLength LocalSockaddr dwRemoteAddressLength dwLocalAddressLength dwReceiveDataLength lpOutputBuffer --) Defines the GetAcceptExSockaddrs callback schema.
callback schema
Parameters
Pass the same lpOutputBuffer and the same three length values used for AcceptEx.
(dwFlags lpOverlapped cbTransferred dwError --) Defines the overlapped completion callback schema.
callback schema
Parameters
An OVERLAPPED
(-- WSABUF) Defines one overlapped buffer descriptor.
Dict schema
(-- WSADATA) Defines Winsock startup version, limits, vendor, and status data.
Dict schema
64-bit Windows
32-bit Windows
(-- addrinfo) Defines one address-resolution result record.
Dict schema
(-- fd_set) Defines one descriptor set for readiness queries.
Dict schema
(-- sockaddr) Defines the generic socket-address record.
Dict schema
(-- sockaddr_in) Defines the IPv4 socket-address record.
Dict schema
AF_INETInt32sin_family, for example AF_INET addr.sin_family cast @addr.!sin_family.
(-- timeval) Defines the timeout interval record used by
select.
Dict schema
Imported functions
Stack effects list a C function's parameters with the first parameter on top; see importFunction .
(-- result) Cleans up one successful Winsock initialization.
Inputs
Outputs result: Int32-1 on failure.
(-- result) Returns the calling thread's last Winsock error code.
Inputs
Outputs result: Int32
(lpdwFlags fWait lpcbTransfer lpOverlapped s -- result) Retrieves the result of one overlapped socket operation.
Inputs
lpdwFlags: Nat32ReffWait: Int320 to return without waiting.lpcbTransfer: Nat32ReflpOverlapped: OVERLAPPEDRefs: Natx
Outputs result: Int32
(lpCompletionRoutine lpOverlapped lpcbBytesReturned cbOutBuffer lpvOutBuffer cbInBuffer lpvInBuffer dwIoControlCode s -- result) Controls a socket and supports extension-function lookup.
Inputs
lpCompletionRoutine: WSAOVERLAPPED_COMPLETION_ROUTINERefNIL for none.lpOverlapped: OVERLAPPEDRefNIL OVERLAPPED Ref for synchronous I/O.lpcbBytesReturned: Nat32RefcbOutBuffer: Nat32lpvOutBuffer: Natx0nx for none.cbInBuffer: Nat32lpvInBuffer: Natx0nx for none.dwIoControlCode: Nat32s: Natx
Outputs result: Int32-1 on failure; an overlapped call can return -1 with WSA_IO_PENDINGRemarks
(lpCompletionRoutine lpOverlapped lpFlags lpNumberOfBytesRecvd dwBufferCount lpBuffers s -- result) Receives data from a socket, synchronously or with overlapped I/O.
Inputs
lpCompletionRoutine: WSAOVERLAPPED_COMPLETION_ROUTINERefNIL for none.lpOverlapped: OVERLAPPEDRefNIL OVERLAPPED Ref for synchronous I/O.lpFlags: Nat32ReflpNumberOfBytesRecvd: Nat32RefNat32 Ref may be NIL only when lpOverlapped is non-NIL.dwBufferCount: Nat32WSABUFlpBuffers: WSABUFRefs: Natx
Outputs result: Int32-1 on failure; an overlapped call can return -1 with WSA_IO_PENDING
(lpCompletionRoutine lpOverlapped dwFlags lpNumberOfBytesSent dwBufferCount lpBuffers s -- result) Sends data through a socket, synchronously or with overlapped I/O.
Inputs
lpCompletionRoutine: WSAOVERLAPPED_COMPLETION_ROUTINERefNIL for none.lpOverlapped: OVERLAPPEDRefNIL OVERLAPPED Ref for synchronous I/O.dwFlags: Nat320n32; see the Windows parameter documentation for the documented flag values.lpNumberOfBytesSent: Nat32RefNat32 Ref may be NIL only when lpOverlapped is non-NIL.dwBufferCount: Nat32WSABUFlpBuffers: WSABUFRefs: Natx
Outputs result: Int32-1 on failure; an overlapped call can return -1 with WSA_IO_PENDING
(iError --) Sets the calling thread's last Winsock error code.
Inputs iError: Int32Outputs
(lpWSAData wVersionRequested -- result) Initializes Winsock and fills startup data.
Inputs
lpWSAData: WSADATARefwVersionRequested: Nat16
Outputs result: Int32Remarks
(namelen name s -- result) Associates a socket with a local address.
Inputs
namelen: Int32name.name: Natxborrowed read-only local socket-address record.s: Natx
Outputs result: Int32-1 on failure.
(s -- result) Closes a socket.
Inputs s: NatxOutputs result: Int32-1 on failure.
(nameLen name s -- result) Connects a socket to a peer address.
Inputs
nameLen: Int32name.name: sockaddrRefs: Natx
Outputs result: Int32-1 on failure.
(pAddrInfo --) Releases an address-resolution result list.
Inputs pAddrInfo: addrinfoRefOutputs
(ppResult pHints pServiceName pNodeName -- result) Resolves a node and service into an address list.
Inputs
ppResult: Natxaddrinfo addressToReference and pass the reference to freeaddrinfopHints: addrinfoCrefai_addrlen, ai_canonname, ai_addr, and ai_next must be 0nx.pServiceName: Natx0nx for none.pNodeName: Natx0nx when pServiceName is provided.
Outputs result: Int32
(hostlong -- result) Converts a 32-bit value from host byte order to network byte order.
Inputs hostlong: Nat32Outputs result: Nat32
(hostshort -- result) Converts a 16-bit value from host byte order to network byte order.
Inputs hostshort: Nat16Outputs result: Nat16
(argp cmd s -- result) Controls socket I/O mode.
Inputs
argp: Natxcmd: Int32s: Natx
Outputs result: Int32-1 on failure.
(backlog s -- result) Places a socket in listening mode.
Inputs
backlog: Int32s: Natx
Outputs result: Int32-1 on failure.
(netlong -- result) Converts a 32-bit value from network byte order to host byte order.
Inputs netlong: Nat32Outputs result: Nat32
(netshort -- result) Converts a 16-bit value from network byte order to host byte order.
Inputs netshort: Nat16Outputs result: Nat16
(flags len buf s -- result) Receives bytes from a socket.
Inputs
flags: Int32len: Int32buf: Natxs: Natx
Outputs result: Int32-1 on failure (0 marks orderly peer shutdown for a stream socket).
(timeout exceptfds writefds readfds ndfs -- result) Tests descriptor sets for socket readiness.
Inputs
timeout: timevalRefexceptfds: fd_setRefwritefds: fd_setRefreadfds: fd_setRefndfs: Int32
Outputs result: Int32-1 on failure.
(flags len buf s -- result) Sends bytes through a socket.
Inputs
flags: Int32len: Int32buf: Natxs: Natx
Outputs result: Int32-1 on failure.
(optlen optval optname level s -- result) Sets one socket option.
Inputs
optlen: Int32optval: Natxoptname: Int32level: Int32s: Natx
Outputs result: Int32-1 on failure.
(how s -- result) Disables part or all of a socket connection.
Inputs
how: Int32s: Natx
Outputs result: Int32-1 on failure.
(protocol type af -- result) Creates a socket.
Inputs
protocol: Int32type: Int32af: Int32
Outputs
Notes
After a failure indication, WSAGetLastErrorWSAStartupgetaddrinfo
WSA_IO_PENDINGWSAGetLastErrorObtain a pending operation's final result through its completion notification or WSAGetOverlappedResultOVERLAPPED
Keep every byte buffer referenced by a pending WSARecvWSASend
For completion-port notification, pass a NIL completion routine.
Examples
Constant example
"control" use
"windows/ws2_32" use
{} () {} [
AF_INET printStack _:;
SOCK_STREAM printStack _:;
INVALID_SOCKET printStack _:;
WSAEWOULDBLOCK printStack _:;
SD_BOTH printStack _:;
] "main" exportFunctionExpected Output During Compilation
2
1
18446744073709551615nx
10035
2Signature examples
"control" use
"windows/ws2_32" use
{} Int32 {} [
@WSAStartup printStack _:;
@WSARecv printStack _:;
@socket printStack _:;
0
] "main" exportFunctionExpected Output During Compilation
{wVersionRequested: Nat16; lpWSAData: {wVersion: Nat16; wHighVersion: Nat16; iMaxSockets: Nat16; iMaxUdpDg: Nat16; lpVendorInfo: Nat8 Ref; szDescription: Nat8 257 array; szSystemStatus: Nat8 129 array;} Ref;} Int32 {convention: "";} codeRef
{s: Natx; lpBuffers: {len: Nat32; buf: Natx;} Ref; dwBufferCount: Nat32; lpNumberOfBytesRecvd: Nat32 Ref; lpFlags: Nat32 Ref; lpOverlapped: {Internal: Natx; InternalHigh: Natx; DUMMYUNIONNAME: Nat64; hEvent: Natx;} Ref; lpCompletionRoutine: {dwError: Nat32; cbTransferred: Nat32; lpOverlapped: {Internal: Natx; InternalHigh: Natx; DUMMYUNIONNAME: Nat64; hEvent: Natx;} Ref; dwFlags: Nat32;} () {convention: "";} codeRef;} Int32 {convention: "";} codeRef
{af: Int32; type: Int32; protocol: Int32;} Natx {convention: "";} codeRef
See also
windows/dispatcher : Windows completion-port dispatcher and callback posting helpers.windows/kernel32 : Kernel32 declarations for synchronization, process, thread, file, and timing helpers.linux/socket · macos/socket : Linux and macOS socket declarations, constants, address schemas, and imported functions.sync/sync : Cross-platform scheduling, sleep, time, IPv4 formatting, and TCP helpers.sync/TcpAcceptor : Listening TCP acceptor with address reporting and accepted connection creation.sync/TcpConnection : Connected TCP stream with buffered read, string read, write, and shutdown operations.