https://github.com/danieloneill/quickjs-net

Basic low-level networking implementation for QuickJS
https://github.com/danieloneill/quickjs-net

Last synced: 15 days ago
JSON representation

Basic low-level networking implementation for QuickJS

• Host: GitHub
• URL: https://github.com/danieloneill/quickjs-net
• Owner: danieloneill
• License: mit
• Created: 2022-09-11T22:31:24.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2022-09-13T21:09:36.000Z (about 2 years ago)
• Last Synced: 2023-02-27T18:33:11.866Z (over 1 year ago)
• Language: C
• Size: 20.5 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# quickjs-net

Basic low-level networking implementation for [QuickJS](https://bellard.org/quickjs/).

**This code currently builds against QuickJS-2021-03-27**

## Building

Edit Makefile and point QJSPATH to your quickjs root then just build with *make*.

Now you should be able to run the examples:

 * echo-server.js

 * httpclient.js

 * httpserver.js

## Documentation

 * socket(domain, type) -> fd

   * domain should be 'inet' or 'inet6'. ('unix' and 'local' are recognised but likely not useful)

   * type should be 'stream', 'dgram', or 'raw'

 * resolve(hostname, domain) -> [ { 'family':'inet', 'type':'dgram', 'ip':'208.113.236.64' } ]

   * hostname such as "oneill.app" or "battle.net"

   * domain should be one of 'inet' or 'inet6'

 * connect(fd, domain, address, port) -> true/false

   * fd as allocated from socket

   * domain should be 'inet' or 'inet6'

   * address should be an ip as in a result object's ip trait as returned from resolve

   * port number in host byte order

 * bind(fd, domain, address, port) -> true/false

   * fd as allocated from socket

   * domain should be 'inet' or 'inet6'

   * address should be an ip as in "::1" or "127.0.0.1", depending on domain

   * port number in host byte order

 * listen(fd, backlog) -> true/false

   * same as man(3) listen almost exactly, but errors are Exceptions

 * accept(fd) -> { 'family':<'inet', 'inet6'>, 'ip':'1.2.3.4', 'port':54321, 'fd':5 }

   * fd is a socket as allocated by socket, bound with bind, and listening with listen

 * close(fd) -> true/false

 * shutdown(fd, how) -> true/false

   * where how is one of 'rd', 'wr', or 'rdwr'

The *resolve* method is synchronous and will block execution while it's running. I may add an async method at some point, but for my purposes it's not an issue (because I don't even use it).

See examples, or read the source. It's not very long, and pretty plain C.

Don't be shy about making an issue or PR, and thanks for your interest.

Also check out [my hashing module for QuickJS](https://github.com/danieloneill/quickjs-hash).