Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

posix-socket: move out of core to a module #584

Merged
merged 1 commit into from
Jul 4, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
posix-socket: move out of core to a module
  • Loading branch information
saghul committed Jul 4, 2024
commit f9d2ab6db680db0f7c48a4b25bc1ef9cc1977d50
2 changes: 1 addition & 1 deletion CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ add_library(tjs STATIC
deps/quickjs/cutils.c
)

if(NOT MINGW)
if(UNIX)
target_sources(tjs PUBLIC src/posix-socket.c)
endif()

Expand Down
1 change: 1 addition & 0 deletions docs/types/index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
/// <reference path="./hashing.d.ts" />
/// <reference path="./ipaddr.d.ts" />
/// <reference path="./path.d.ts" />
/// <reference path="./posix-socket.d.ts" />
/// <reference path="./sqlite.d.ts" />
/// <reference path="./uuid.d.ts" />

Expand Down
112 changes: 112 additions & 0 deletions docs/types/posix-socket.d.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,112 @@
/**
* Provides access to most of the POSIX socket API.
* It can be listened to with poll (libuv poll).
*
* NOTE: Not available on Windows.
*
* @module tjs:posix-socket
*/
declare module 'tjs:posix-socket' {
export class PosixSocket {
constructor(domain: number, type: number, protocol: number);

readonly info: {
socket?: {domain: number, type: number, protocol: number}
};
readonly fileno: number;
readonly polling: boolean;

bind(addr: Uint8Array): void;
connect(addr: Uint8Array): void;
listen(backlog: number): void;
accept(): PosixSocket;
sendmsg(addr: Uint8Array|undefined, control: Uint8Array|undefined, flags: number, ...data: Uint8Array[]): number;
recv(size: number): Uint8Array;
recvmsg(size: number): {data: Uint8Array, addr: Uint8Array};
recvmsg(size: number, controllen: number): {data: Uint8Array, addr: Uint8Array, control: Uint8Array};
close(): void;
setopt(level: number, name: number, value: Uint8Array): void;
/**
* By default 128byte are reserved for the option, provide size argument for larger buffer or to save memory.
*/
getopt(level: number, name: number, size?: number): Uint8Array;
read(size: number): Uint8Array;
write(data: Uint8Array): number;

poll(cbs: {
all?: (events: number) => void,
read?: (events: number) => void,
write?: (events: number) => void,
disconnect?: (events: number) => void,
prioritized?: (events: number) => void,
error?: (errcode: number) => void,
}): void;
stopPoll(): void;

static readonly defines: {
AF_INET: number,
AF_INET6: number,
/** only on platforms supporting AF_NETLINK */
AF_NETLINK: number,
/** only on platforms supporting AF_PACKET */
AF_PACKET: number,
/** only on platforms supporting AF_UNIX */
AF_UNIX: number,

SOCK_STREAM: number,
SOCK_DGRAM: number,
SOCK_RAW: number,
SOCK_SEQPACKET: number,
SOCK_RDM: number,

SOL_SOCKET: number,
SOL_PACKET: number,
SOL_NETLINK: number,

SO_REUSEADDR: number,
SO_KEEPALIVE: number,
SO_LINGER: number,
SO_BROADCAST: number,
SO_OOBINLINE: number,
SO_RCVBUF: number,
SO_SNDBUF: number,
SO_RCVTIMEO: number,
SO_SNDTIMEO: number,
SO_ERROR: number,
SO_TYPE: number,
SO_DEBUG: number,
SO_DONTROUTE: number,
SO_SNDBUFFORCE: number,
SO_RCVBUFFORCE: number,
SO_NO_CHECK: number,
SO_PRIORITY: number,
SO_BSDCOMPAT: number,
SO_REUSEPORT: number,

IPPROTO_IP: number,
IPPROTO_IPV6: number,
IPPROTO_ICMP: number,
IPPROTO_TCP: number,
IPPROTO_UDP: number,
};
static createFromFD(fd: number): PosixSocket;
static ip4ToBuf(ipstr: string): Uint8Array;
static createSockaddrIn(ip: string, port: number): Uint8Array;
static readonly pollEvents: {
READABLE: number,
WRITABLE: number,
DISCONNECT: number,
PRIORITIZED: number,
};

static indextoname(index: number): string;
static nametoindex(name: string): number;

/**
* Caculates internet checksum: the 16-bit ones' complement of the ones' complement sum of all 16-bit words in the buffer.
* Used in ipv4, udp, tcp, icmp...
* @param buf
*/
static checksum(buf: Uint8Array): number;
}
}
109 changes: 0 additions & 109 deletions docs/types/txikijs.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -945,115 +945,6 @@ declare global {
* Returns an estimate of the default amount of parallelism a program should use.
*/
function availableParallelism(): number;

/**
* provides access to most of the POSIX socket API.
* It can be listened to with poll (libuv poll)
* *not available on windows*
*/
class PosixSocket{
constructor(domain: number, type: number, protocol: number);

readonly info: {
socket?: {domain: number, type: number, protocol: number}
};
readonly fileno: number;
readonly polling: boolean;

static readonly defines: {
AF_INET: number,
AF_INET6: number,
/** only on platforms supporting AF_NETLINK */
AF_NETLINK: number,
/** only on platforms supporting AF_PACKET */
AF_PACKET: number,
/** only on platforms supporting AF_UNIX */
AF_UNIX: number,

SOCK_STREAM: number,
SOCK_DGRAM: number,
SOCK_RAW: number,
SOCK_SEQPACKET: number,
SOCK_RDM: number,

SOL_SOCKET: number,
SOL_PACKET: number,
SOL_NETLINK: number,

SO_REUSEADDR: number,
SO_KEEPALIVE: number,
SO_LINGER: number,
SO_BROADCAST: number,
SO_OOBINLINE: number,
SO_RCVBUF: number,
SO_SNDBUF: number,
SO_RCVTIMEO: number,
SO_SNDTIMEO: number,
SO_ERROR: number,
SO_TYPE: number,
SO_DEBUG: number,
SO_DONTROUTE: number,
SO_SNDBUFFORCE: number,
SO_RCVBUFFORCE: number,
SO_NO_CHECK: number,
SO_PRIORITY: number,
SO_BSDCOMPAT: number,
SO_REUSEPORT: number,

IPPROTO_IP: number,
IPPROTO_IPV6: number,
IPPROTO_ICMP: number,
IPPROTO_TCP: number,
IPPROTO_UDP: number,
};
static createFromFD(fd: number): PosixSocket;

bind(addr: Uint8Array): void;
connect(addr: Uint8Array): void;
listen(backlog: number): void;
accept(): PosixSocket;
sendmsg(addr: Uint8Array|undefined, control: Uint8Array|undefined, flags: number, ...data: Uint8Array[]): number;
recv(size: number): Uint8Array;
recvmsg(size: number): {data: Uint8Array, addr: Uint8Array};
recvmsg(size: number, controllen: number): {data: Uint8Array, addr: Uint8Array, control: Uint8Array};
close(): void;
setopt(level: number, name: number, value: Uint8Array): void;
/**
* By default 128byte are reserved for the option, provide size argument for larger buffer or to save memory.
*/
getopt(level: number, name: number, size?: number): Uint8Array;
read(size: number): Uint8Array;
write(data: Uint8Array): number;

poll(cbs: {
all?: (events: number) => void,
read?: (events: number) => void,
write?: (events: number) => void,
disconnect?: (events: number) => void,
prioritized?: (events: number) => void,
error?: (errcode: number) => void,
}): void;
stopPoll(): void;

static ip4ToBuf(ipstr: string): Uint8Array;
static createSockaddrIn(ip: string, port: number): Uint8Array;
static readonly pollEvents: {
READABLE: number,
WRITABLE: number,
DISCONNECT: number,
PRIORITIZED: number,
};

static indextoname(index: number): string;
static nametoindex(name: string): number;

/**
* Caculates internet checksum: the 16-bit ones' complement of the ones' complement sum of all 16-bit words in the buffer.
* Used in ipv4, udp, tcp, icmp...
* @param buf
*/
static checksum(buf: Uint8Array): number;
}
}

interface ConsolePrinterOptions {
Expand Down
2 changes: 2 additions & 0 deletions src/builtins.c
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@
#include "bundles/c/stdlib/hashing.c"
#include "bundles/c/stdlib/ipaddr.c"
#include "bundles/c/stdlib/path.c"
#include "bundles/c/stdlib/posix-socket.c"
#include "bundles/c/stdlib/sqlite.c"
#include "bundles/c/stdlib/uuid.c"
#include "private.h"
Expand All @@ -46,6 +47,7 @@ static tjs_builtin_t builtins[] = {
{ "tjs:hashing", tjs__hashing, tjs__hashing_size },
{ "tjs:ipaddr", tjs__ipaddr, tjs__ipaddr_size },
{ "tjs:path", tjs__path, tjs__path_size },
{ "tjs:posix-socket", tjs__posix_socket, tjs__posix_socket_size },
{ "tjs:sqlite", tjs__sqlite, tjs__sqlite_size },
{ "tjs:uuid", tjs__uuid, tjs__uuid_size },
{ NULL, NULL, 0 },
Expand Down
Loading
Loading