Skip to main content

Class: PosixSocket

Constructors

Constructor

new PosixSocket(domain, type, protocol): PosixSocket

Parameters

domain

number

type

number

protocol

number

Returns

PosixSocket

Properties

fileno

readonly fileno: number


info

readonly info: object

socket?

optional socket: object

socket.domain

domain: number

socket.protocol

protocol: number

socket.type

type: number


polling

readonly polling: boolean


defines

readonly static defines: object

AF_INET

AF_INET: number

AF_INET6

AF_INET6: number

AF_NETLINK: number

only on platforms supporting AF_NETLINK

AF_PACKET

AF_PACKET: number

only on platforms supporting AF_PACKET

AF_UNIX

AF_UNIX: number

only on platforms supporting AF_UNIX

IPPROTO_ICMP

IPPROTO_ICMP: number

IPPROTO_IP

IPPROTO_IP: number

IPPROTO_IPV6

IPPROTO_IPV6: number

IPPROTO_TCP

IPPROTO_TCP: number

IPPROTO_UDP

IPPROTO_UDP: number

SO_BROADCAST

SO_BROADCAST: number

SO_BSDCOMPAT

SO_BSDCOMPAT: number

SO_DEBUG

SO_DEBUG: number

SO_DONTROUTE

SO_DONTROUTE: number

SO_ERROR

SO_ERROR: number

SO_KEEPALIVE

SO_KEEPALIVE: number

SO_LINGER

SO_LINGER: number

SO_NO_CHECK

SO_NO_CHECK: number

SO_OOBINLINE

SO_OOBINLINE: number

SO_PRIORITY

SO_PRIORITY: number

SO_RCVBUF

SO_RCVBUF: number

SO_RCVBUFFORCE

SO_RCVBUFFORCE: number

SO_RCVTIMEO

SO_RCVTIMEO: number

SO_REUSEADDR

SO_REUSEADDR: number

SO_REUSEPORT

SO_REUSEPORT: number

SO_SNDBUF

SO_SNDBUF: number

SO_SNDBUFFORCE

SO_SNDBUFFORCE: number

SO_SNDTIMEO

SO_SNDTIMEO: number

SO_TYPE

SO_TYPE: number

SOCK_DGRAM

SOCK_DGRAM: number

SOCK_RAW

SOCK_RAW: number

SOCK_RDM

SOCK_RDM: number

SOCK_SEQPACKET

SOCK_SEQPACKET: number

SOCK_STREAM

SOCK_STREAM: number

SOL_NETLINK: number

SOL_PACKET

SOL_PACKET: number

SOL_SOCKET

SOL_SOCKET: number


pollEvents

readonly static pollEvents: object

DISCONNECT

DISCONNECT: number

PRIORITIZED

PRIORITIZED: number

READABLE

READABLE: number

WRITABLE

WRITABLE: number

Methods

accept()

accept(): PosixSocket

Returns

PosixSocket


bind()

bind(addr): void

Parameters

addr

Uint8Array

Returns

void


close()

close(): void

Returns

void


connect()

connect(addr): void

Parameters

addr

Uint8Array

Returns

void


getopt()

getopt(level, name, size?): Uint8Array

By default 128byte are reserved for the option, provide size argument for larger buffer or to save memory.

Parameters

level

number

name

number

size?

number

Returns

Uint8Array


listen()

listen(backlog): void

Parameters

backlog

number

Returns

void


poll()

poll(cbs): void

Parameters

cbs
all?

(events) => void

disconnect?

(events) => void

error?

(errcode) => void

prioritized?

(events) => void

read?

(events) => void

write?

(events) => void

Returns

void


read()

read(size): Uint8Array

Parameters

size

number

Returns

Uint8Array


recv()

recv(size): Uint8Array

Parameters

size

number

Returns

Uint8Array


recvmsg()

Call Signature

recvmsg(size): object

Parameters
size

number

Returns

object

addr

addr: Uint8Array

data

data: Uint8Array

Call Signature

recvmsg(size, controllen): object

Parameters
size

number

controllen

number

Returns

object

addr

addr: Uint8Array

control

control: Uint8Array

data

data: Uint8Array


sendmsg()

sendmsg(addr, control, flags, ...data): number

Parameters

addr

Uint8Array

control

Uint8Array

flags

number

data

...Uint8Array[]

Returns

number


setopt()

setopt(level, name, value): void

Parameters

level

number

name

number

value

Uint8Array

Returns

void


stopPoll()

stopPoll(): void

Returns

void


write()

write(data): number

Parameters

data

Uint8Array

Returns

number


checksum()

static checksum(buf): 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...

Parameters

buf

Uint8Array

Returns

number


createFromFD()

static createFromFD(fd): PosixSocket

Parameters

fd

number

Returns

PosixSocket


createSockaddrIn()

static createSockaddrIn(ip, port): Uint8Array

Parameters

ip

string

port

number

Returns

Uint8Array


indextoname()

static indextoname(index): string

Parameters

index

number

Returns

string


ip4ToBuf()

static ip4ToBuf(ipstr): Uint8Array

Parameters

ipstr

string

Returns

Uint8Array


nametoindex()

static nametoindex(name): number

Parameters

name

string

Returns

number