Class PosixSocket

provides access to most of the POSIX socket API. It can be listened to with poll (libuv poll) not available on windows

Hierarchy

PosixSocket

Index

Constructors

constructor

new PosixSocket(domain, type, protocol): PosixSocket
Parameters
- domain: number
- type: number
- protocol: number
Returns PosixSocket

Properties

`Readonly` info

info: {
    socket?: {
        domain: number;
        protocol: number;
        type: number;
    };
}

Type declaration

Optional socket?: {
    domain: number;
    protocol: number;
    type: number;
}
- domain: number
- protocol: number
- type: number

`Static` `Readonly` defines

defines: {
    AF_INET: number;
    AF_INET6: number;
    AF_NETLINK: number;
    AF_PACKET: number;
    SOCK_DGRAM: number;
    SOCK_RAW: number;
    SOCK_RDM: number;
    SOCK_SEQPACKET: number;
    SOCK_STREAM: number;
    SOL_NETLINK: number;
    SOL_PACKET: number;
    SOL_SOCKET: number;
    SO_BROADCAST: number;
    SO_BSDCOMPAT: number;
    SO_DEBUG: number;
    SO_DONTROUTE: number;
    SO_ERROR: number;
    SO_KEEPALIVE: number;
    SO_LINGER: number;
    SO_NO_CHECK: number;
    SO_OOBINLINE: number;
    SO_PRIORITY: number;
    SO_RCVBUF: number;
    SO_RCVBUFFORCE: number;
    SO_RCVTIMEO: number;
    SO_REUSEADDR: number;
    SO_REUSEPORT: number;
    SO_SNDBUF: number;
    SO_SNDBUFFORCE: number;
    SO_SNDTIMEO: number;
    SO_TYPE: number;
}

Type declaration

AF_INET: number
AF_INET6: number
AF_NETLINK: number
AF_PACKET: number
SOCK_DGRAM: number
SOCK_RAW: number
SOCK_RDM: number
SOCK_SEQPACKET: number
SOCK_STREAM: number
SOL_NETLINK: number
SOL_PACKET: number
SOL_SOCKET: number
SO_BROADCAST: number
SO_BSDCOMPAT: number
SO_DEBUG: number
SO_DONTROUTE: number
SO_ERROR: number
SO_KEEPALIVE: number
SO_LINGER: number
SO_NO_CHECK: number
SO_OOBINLINE: number
SO_PRIORITY: number
SO_RCVBUF: number
SO_RCVBUFFORCE: number
SO_RCVTIMEO: number
SO_REUSEADDR: number
SO_REUSEPORT: number
SO_SNDBUF: number
SO_SNDBUFFORCE: number
SO_SNDTIMEO: number
SO_TYPE: number

`Static` `Readonly` pollEvents

pollEvents: {
    DISCONNECT: number;
    PRIORITIZED: number;
    READABLE: number;
    WRITABLE: number;
}

Type declaration

DISCONNECT: number
PRIORITIZED: number
READABLE: number
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
- Optional 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);
  }
  - Optional all?: ((events) => void)
    - (events): void
      
      Parameters
      
      events: number
      
      Returns void
  - Optional disconnect?: ((events) => void)
    - (events): void
      
      Parameters
      
      events: number
      
      Returns void
  - Optional error?: ((errcode) => void)
    - (errcode): void
      
      Parameters
      
      errcode: number
      
      Returns void
  - Optional prioritized?: ((events) => void)
    - (events): void
      
      Parameters
      
      events: number
      
      Returns void
  - Optional read?: ((events) => void)
    - (events): void
      
      Parameters
      
      events: number
      
      Returns void
  - Optional write?: ((events) => void)
    - (events): void
      
      Parameters
      
      events: number
      
      Returns void
Returns void

read

read(size): Uint8Array
Parameters
- size: number
Returns Uint8Array

recv

recv(size): Uint8Array
Parameters
- size: number
Returns Uint8Array

recvmsg

recvmsg(size): {
addr: Uint8Array;
data: Uint8Array;
}
Parameters
- size: number
Returns {
addr: Uint8Array;
data: Uint8Array;
}
- addr: Uint8Array
- data: Uint8Array
recvmsg(size, controllen): {
    addr: Uint8Array;
    control: Uint8Array;
    data: Uint8Array;
}
Parameters
- size: number
- controllen: number
Returns {
    addr: Uint8Array;
    control: Uint8Array;
    data: Uint8Array;
}
- addr: Uint8Array
- control: Uint8Array
- data: Uint8Array

sendmsg

sendmsg(addr, control, flags, ...data): number
Parameters
- addr: Uint8Array
- control: Uint8Array
- flags: number
- Rest ...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

`Static` checksum

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

`Static` createFromFD

createFromFD(fd): PosixSocket
Parameters
- fd: number
Returns PosixSocket

`Static` createSockaddrIn

createSockaddrIn(ip, port): Uint8Array
Parameters
- ip: string
- port: number
Returns Uint8Array

`Static` indextoname

indextoname(index): string
Parameters
- index: number
Returns string

`Static` ip4ToBuf

ip4ToBuf(ipstr): Uint8Array
Parameters
- ipstr: string
Returns Uint8Array

`Static` nametoindex

nametoindex(name): number
Parameters
- name: string
Returns number

Class PosixSocket

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

domain: number

type: number

protocol: number

Returns PosixSocket

Properties

Readonly info

Type declaration

Optional socket?: { domain: number; protocol: number; type: number; }

domain: number

protocol: number

type: number

Static Readonly defines

Type declaration

AF_INET: number

AF_INET6: number

AF_NETLINK: number

AF_PACKET: number

SOCK_DGRAM: number

SOCK_RAW: number

SOCK_RDM: number

SOCK_SEQPACKET: number

SOCK_STREAM: number

SOL_NETLINK: number

SOL_PACKET: number

SOL_SOCKET: number

SO_BROADCAST: number

SO_BSDCOMPAT: number

SO_DEBUG: number

SO_DONTROUTE: number

SO_ERROR: number

SO_KEEPALIVE: number

SO_LINGER: number

SO_NO_CHECK: number

SO_OOBINLINE: number

SO_PRIORITY: number

SO_RCVBUF: number

SO_RCVBUFFORCE: number

SO_RCVTIMEO: number

SO_REUSEADDR: number

SO_REUSEPORT: number

SO_SNDBUF: number

SO_SNDBUFFORCE: number

SO_SNDTIMEO: number

SO_TYPE: number

Static Readonly pollEvents

Type declaration

DISCONNECT: number

PRIORITIZED: number

READABLE: number

WRITABLE: number

Methods

accept

Returns PosixSocket

bind

Parameters

addr: Uint8Array

Returns void

close

Returns void

connect

Parameters

addr: Uint8Array

Returns void

getopt

Parameters

level: number

name: number

Optional size: number

Returns Uint8Array

listen

Parameters

`Readonly` info

`Optional` socket?: {
domain: number;
protocol: number;
type: number;
}

`Static` `Readonly` defines

`Static` `Readonly` pollEvents

`Optional` size: number

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

`Optional` all?: ((events) => void)

`Optional` disconnect?: ((events) => void)

`Optional` error?: ((errcode) => void)

`Optional` prioritized?: ((events) => void)

`Optional` read?: ((events) => void)

`Optional` write?: ((events) => void)

Returns {
addr: Uint8Array;
data: Uint8Array;
}

Returns {
addr: Uint8Array;
control: Uint8Array;
data: Uint8Array;
}

`Rest` ...data: Uint8Array[]