summaryrefslogtreecommitdiff
path: root/shared-bindings/socketpool
diff options
context:
space:
mode:
authorScott Shawcroft <scott@tannewt.org>2020-08-11 16:04:55 -0700
committerScott Shawcroft <scott@tannewt.org>2020-08-19 14:22:13 -0700
commitc9ece21c2846d57f3c32b364be1209d884e388b1 (patch)
tree016224844c7465f98397a6f2bfd498ca27cad86c /shared-bindings/socketpool
parent7bdd243bf6f3cd84ddfd9cf6f35a2d6d8a6a415f (diff)
SocketPool stubbed out
Diffstat (limited to 'shared-bindings/socketpool')
-rw-r--r--shared-bindings/socketpool/Socket.c473
-rw-r--r--shared-bindings/socketpool/Socket.h38
-rw-r--r--shared-bindings/socketpool/SocketPool.c164
-rw-r--r--shared-bindings/socketpool/SocketPool.h48
-rw-r--r--shared-bindings/socketpool/__init__.c586
-rw-r--r--shared-bindings/socketpool/__init__.h34
6 files changed, 775 insertions, 568 deletions
diff --git a/shared-bindings/socketpool/Socket.c b/shared-bindings/socketpool/Socket.c
new file mode 100644
index 000000000..e4d79616a
--- /dev/null
+++ b/shared-bindings/socketpool/Socket.c
@@ -0,0 +1,473 @@
+/*
+ * This file is part of the MicroPython project, http://micropython.org/
+ *
+ * The MIT License (MIT)
+ *
+ * SPDX-FileCopyrightText: Copyright (c) 2014 Damien P. George
+ * 2018 Nick Moore for Adafruit Industries
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+
+#include "shared-bindings/socketpool/Socket.h"
+
+#include <stdio.h>
+#include <string.h>
+
+#include "lib/utils/context_manager_helpers.h"
+#include "py/objtuple.h"
+#include "py/objlist.h"
+#include "py/runtime.h"
+#include "py/mperrno.h"
+
+//| class Socket:
+//| """TCP, UDP and RAW socket. Cannot be created directly. Instead, call
+//| `SocketPool.socket()`.
+//|
+//| Provides a subset of CPython's `socket.socket` API. It only implements the versions of
+//| recv that do not allocate bytes objects."""
+//|
+
+//| def __enter__(self) -> Socket:
+//| """No-op used by Context Managers."""
+//| ...
+//|
+// Provided by context manager helper.
+
+//| def __exit__(self) -> None:
+//| """Automatically closes the Socket when exiting a context. See
+//| :ref:`lifetime-and-contextmanagers` for more info."""
+//| ...
+//|
+STATIC mp_obj_t socketpool_socket___exit__(size_t n_args, const mp_obj_t *args) {
+ (void)n_args;
+ // common_hal_pulseio_pwmout_deinit(args[0]);
+ return mp_const_none;
+}
+STATIC MP_DEFINE_CONST_FUN_OBJ_VAR_BETWEEN(socketpool_socket___exit___obj, 4, 4, socketpool_socket___exit__);
+
+//| def bind(self, address: tuple) -> None:
+//| """Bind a socket to an address
+//|
+//| :param ~tuple address: tuple of (remote_address, remote_port)"""
+//| ...
+//|
+
+STATIC mp_obj_t socketpool_socket_bind(mp_obj_t self_in, mp_obj_t addr_in) {
+ // mod_network_socket_obj_t *self = MP_OBJ_TO_PTR(self_in);
+
+ // // get address
+ // uint8_t ip[MOD_NETWORK_IPADDR_BUF_SIZE];
+ // mp_uint_t port = netutils_parse_inet_addr(addr_in, ip, NETUTILS_BIG);
+
+ // // check if we need to select a NIC
+ // socket_select_nic(self, ip);
+
+ // // call the NIC to bind the socket
+ // int _errno;
+ // if (self->nic_type->bind(self, ip, port, &_errno) != 0) {
+ // mp_raise_OSError(_errno);
+ // }
+
+ return mp_const_none;
+}
+STATIC MP_DEFINE_CONST_FUN_OBJ_2(socketpool_socket_bind_obj, socketpool_socket_bind);
+
+//| def listen(self, backlog: int) -> None:
+//| """Set socket to listen for incoming connections
+//|
+//| :param ~int backlog: length of backlog queue for waiting connetions"""
+//| ...
+//|
+
+STATIC mp_obj_t socketpool_socket_listen(mp_obj_t self_in, mp_obj_t backlog) {
+ // mod_network_socket_obj_t *self = MP_OBJ_TO_PTR(self_in);
+
+ // if (self->nic == MP_OBJ_NULL) {
+ // // not connected
+ // // TODO I think we can listen even if not bound...
+ // mp_raise_OSError(MP_ENOTCONN);
+ // }
+
+ // int _errno;
+ // if (self->nic_type->listen(self, mp_obj_get_int(backlog), &_errno) != 0) {
+ // mp_raise_OSError(_errno);
+ // }
+
+ return mp_const_none;
+}
+STATIC MP_DEFINE_CONST_FUN_OBJ_2(socketpool_socket_listen_obj, socketpool_socket_listen);
+
+//| def accept(self) -> tuple:
+//| """Accept a connection on a listening socket of type SOCK_STREAM,
+//| creating a new socket of type SOCK_STREAM.
+//| Returns a tuple of (new_socket, remote_address)"""
+//|
+
+STATIC mp_obj_t socketpool_socket_accept(mp_obj_t self_in) {
+ // mod_network_socket_obj_t *self = MP_OBJ_TO_PTR(self_in);
+
+ // // create new socket object
+ // // starts with empty NIC so that finaliser doesn't run close() method if accept() fails
+ // mod_network_socket_obj_t *socket2 = m_new_obj_with_finaliser(mod_network_socket_obj_t);
+ // socket2->base.type = &socket_type;
+ // socket2->nic = MP_OBJ_NULL;
+ // socket2->nic_type = NULL;
+
+ // // accept incoming connection
+ // uint8_t ip[MOD_NETWORK_IPADDR_BUF_SIZE];
+ // mp_uint_t port;
+ // int _errno;
+ // if (self->nic_type->accept(self, socket2, ip, &port, &_errno) != 0) {
+ // mp_raise_OSError(_errno);
+ // }
+
+ // // new socket has valid state, so set the NIC to the same as parent
+ // socket2->nic = self->nic;
+ // socket2->nic_type = self->nic_type;
+
+ // // make the return value
+ // mp_obj_tuple_t *client = MP_OBJ_TO_PTR(mp_obj_new_tuple(2, NULL));
+ // client->items[0] = MP_OBJ_FROM_PTR(socket2);
+ // client->items[1] = netutils_format_inet_addr(ip, port, NETUTILS_BIG);
+
+ return mp_const_none;
+}
+STATIC MP_DEFINE_CONST_FUN_OBJ_1(socketpool_socket_accept_obj, socketpool_socket_accept);
+
+//| def close(self) -> None:
+//| """Closes this Socket and makes its resources available to its SocketPool."""
+//|
+STATIC mp_obj_t socketpool_socket_close(mp_obj_t self_in) {
+ // mod_network_socket_obj_t *self = MP_OBJ_TO_PTR(self_in);
+
+ // // create new socket object
+ // // starts with empty NIC so that finaliser doesn't run close() method if accept() fails
+ // mod_network_socket_obj_t *socket2 = m_new_obj_with_finaliser(mod_network_socket_obj_t);
+ // socket2->base.type = &socket_type;
+ // socket2->nic = MP_OBJ_NULL;
+ // socket2->nic_type = NULL;
+
+ // // accept incoming connection
+ // uint8_t ip[MOD_NETWORK_IPADDR_BUF_SIZE];
+ // mp_uint_t port;
+ // int _errno;
+ // if (self->nic_type->accept(self, socket2, ip, &port, &_errno) != 0) {
+ // mp_raise_OSError(_errno);
+ // }
+
+ // // new socket has valid state, so set the NIC to the same as parent
+ // socket2->nic = self->nic;
+ // socket2->nic_type = self->nic_type;
+
+ // // make the return value
+ // mp_obj_tuple_t *client = MP_OBJ_TO_PTR(mp_obj_new_tuple(2, NULL));
+ // client->items[0] = MP_OBJ_FROM_PTR(socket2);
+ // client->items[1] = netutils_format_inet_addr(ip, port, NETUTILS_BIG);
+
+ return mp_const_none;
+}
+STATIC MP_DEFINE_CONST_FUN_OBJ_1(socketpool_socket_close_obj, socketpool_socket_close);
+
+//| def connect(self, address: tuple) -> None:
+//| """Connect a socket to a remote address
+//|
+//| :param ~tuple address: tuple of (remote_address, remote_port)"""
+//| ...
+//|
+
+STATIC mp_obj_t socketpool_socket_connect(mp_obj_t self_in, mp_obj_t addr_in) {
+ // mod_network_socket_obj_t *self = MP_OBJ_TO_PTR(self_in);
+
+ // // get address
+ // uint8_t ip[MOD_NETWORK_IPADDR_BUF_SIZE];
+ // mp_uint_t port = netutils_parse_inet_addr(addr_in, ip, NETUTILS_BIG);
+
+ // // check if we need to select a NIC
+ // socket_select_nic(self, ip);
+
+ // // call the NIC to connect the socket
+ // int _errno;
+ // if (self->nic_type->connect(self, ip, port, &_errno) != 0) {
+ // mp_raise_OSError(_errno);
+ // }
+
+ return mp_const_none;
+}
+STATIC MP_DEFINE_CONST_FUN_OBJ_2(socketpool_socket_connect_obj, socketpool_socket_connect);
+
+//| def send(self, bytes: ReadableBuffer) -> int:
+//| """Send some bytes to the connected remote address.
+//| Suits sockets of type SOCK_STREAM
+//|
+//| :param ~bytes bytes: some bytes to send"""
+//| ...
+//|
+
+STATIC mp_obj_t socketpool_socket_send(mp_obj_t self_in, mp_obj_t buf_in) {
+ mp_int_t ret = 0;
+ // mod_network_socket_obj_t *self = MP_OBJ_TO_PTR(self_in);
+ // if (self->nic == MP_OBJ_NULL) {
+ // // not connected
+ // mp_raise_OSError(MP_EPIPE);
+ // }
+ // mp_buffer_info_t bufinfo;
+ // mp_get_buffer_raise(buf_in, &bufinfo, MP_BUFFER_READ);
+ // int _errno;
+ // mp_int_t ret = self->nic_type->send(self, bufinfo.buf, bufinfo.len, &_errno);
+ // if (ret == -1) {
+ // mp_raise_OSError(_errno);
+ // }
+ return mp_obj_new_int_from_uint(ret);
+}
+STATIC MP_DEFINE_CONST_FUN_OBJ_2(socketpool_socket_send_obj, socketpool_socket_send);
+
+
+// helper function for socket_recv and socket_recv_into to handle common operations of both
+// STATIC mp_int_t _socket_recv_into(mod_network_socket_obj_t *sock, byte *buf, mp_int_t len) {
+// mp_int_t ret = 0;
+// // int _errno;
+// // mp_int_t ret = sock->nic_type->recv(sock, buf, len, &_errno);
+// // if (ret == -1) {
+// // mp_raise_OSError(_errno);
+// // }
+// return ret;
+// }
+
+
+//| def recv_into(self, buffer: WriteableBuffer, bufsize: int) -> int:
+//| """Reads some bytes from the connected remote address, writing
+//| into the provided buffer. If bufsize <= len(buffer) is given,
+//| a maximum of bufsize bytes will be read into the buffer. If no
+//| valid value is given for bufsize, the default is the length of
+//| the given buffer.
+//|
+//| Suits sockets of type SOCK_STREAM
+//| Returns an int of number of bytes read.
+//|
+//| :param bytearray buffer: buffer to receive into
+//| :param int bufsize: optionally, a maximum number of bytes to read."""
+//| ...
+//|
+
+STATIC mp_obj_t socketpool_socket_recv_into(size_t n_args, const mp_obj_t *args) {
+ // mod_network_socket_obj_t *self = MP_OBJ_TO_PTR(args[0]);
+ // if (self->nic == MP_OBJ_NULL) {
+ // // not connected
+ // mp_raise_OSError(MP_ENOTCONN);
+ // }
+ // mp_buffer_info_t bufinfo;
+ // mp_get_buffer_raise(args[1], &bufinfo, MP_BUFFER_WRITE);
+ // mp_int_t len = bufinfo.len;
+ // if (n_args == 3) {
+ // mp_int_t given_len = mp_obj_get_int(args[2]);
+ // if (given_len < len) {
+ // len = given_len;
+ // }
+ // }
+
+ // mp_int_t ret = _socket_recv_into(self, (byte*)bufinfo.buf, len);
+ mp_int_t ret = 0;
+ return mp_obj_new_int_from_uint(ret);
+}
+STATIC MP_DEFINE_CONST_FUN_OBJ_VAR_BETWEEN(socketpool_socket_recv_into_obj, 2, 3, socketpool_socket_recv_into);
+
+//| def sendto(self, bytes: ReadableBuffer, address: tuple) -> int:
+//| """Send some bytes to a specific address.
+//| Suits sockets of type SOCK_DGRAM
+//|
+//| :param ~bytes bytes: some bytes to send
+//| :param ~tuple address: tuple of (remote_address, remote_port)"""
+//| ...
+//|
+
+STATIC mp_obj_t socketpool_socket_sendto(mp_obj_t self_in, mp_obj_t data_in, mp_obj_t addr_in) {
+ // mod_network_socket_obj_t *self = MP_OBJ_TO_PTR(self_in);
+
+ // // get the data
+ // mp_buffer_info_t bufinfo;
+ // mp_get_buffer_raise(data_in, &bufinfo, MP_BUFFER_READ);
+
+ // // get address
+ // uint8_t ip[MOD_NETWORK_IPADDR_BUF_SIZE];
+ // mp_uint_t port = netutils_parse_inet_addr(addr_in, ip, NETUTILS_BIG);
+
+ // // check if we need to select a NIC
+ // socket_select_nic(self, ip);
+
+ // // call the NIC to sendto
+ // int _errno;
+ // mp_int_t ret = self->nic_type->sendto(self, bufinfo.buf, bufinfo.len, ip, port, &_errno);
+ // if (ret == -1) {
+ // mp_raise_OSError(_errno);
+ // }
+ mp_int_t ret = 0;
+
+ return mp_obj_new_int(ret);
+}
+STATIC MP_DEFINE_CONST_FUN_OBJ_3(socketpool_socket_sendto_obj, socketpool_socket_sendto);
+
+//| def recvfrom(self, bufsize: int) -> Tuple[bytes, tuple]:
+//| """Reads some bytes from the connected remote address.
+//| Suits sockets of type SOCK_STREAM
+//|
+//| Returns a tuple containing
+//| * a bytes() of length <= bufsize
+//| * a remote_address, which is a tuple of ip address and port number
+//|
+//| :param ~int bufsize: maximum number of bytes to receive"""
+//| ...
+//|
+
+STATIC mp_obj_t socketpool_socket_recvfrom_into(mp_obj_t self_in, mp_obj_t len_in) {
+ // mod_network_socket_obj_t *self = MP_OBJ_TO_PTR(self_in);
+ // if (self->nic == MP_OBJ_NULL) {
+ // // not connected
+ // mp_raise_OSError(MP_ENOTCONN);
+ // }
+ // vstr_t vstr;
+ // vstr_init_len(&vstr, mp_obj_get_int(len_in));
+ // byte ip[4];
+ // mp_uint_t port;
+ // int _errno;
+ // mp_int_t ret = self->nic_type->recvfrom(self, (byte*)vstr.buf, vstr.len, ip, &port, &_errno);
+ // if (ret == -1) {
+ // mp_raise_OSError(_errno);
+ // }
+ mp_obj_t tuple[2];
+ // if (ret == 0) {
+ // tuple[0] = mp_const_empty_bytes;
+ // } else {
+ // vstr.len = ret;
+ // tuple[0] = mp_obj_new_str_from_vstr(&mp_type_bytes, &vstr);
+ // }
+ // tuple[1] = netutils_format_inet_addr(ip, port, NETUTILS_BIG);
+ return mp_obj_new_tuple(2, tuple);
+}
+STATIC MP_DEFINE_CONST_FUN_OBJ_2(socketpool_socket_recvfrom_into_obj, socketpool_socket_recvfrom_into);
+
+//| def setsockopt(self, level: int, optname: int, value: int) -> None:
+//| """Sets socket options"""
+//| ...
+//|
+
+STATIC mp_obj_t socketpool_socket_setsockopt(size_t n_args, const mp_obj_t *args) {
+ // mod_network_socket_obj_t *self = MP_OBJ_TO_PTR(args[0]);
+
+ // mp_int_t level = mp_obj_get_int(args[1]);
+ // mp_int_t opt = mp_obj_get_int(args[2]);
+
+ // const void *optval;
+ // mp_uint_t optlen;
+ // mp_int_t val;
+ // if (mp_obj_is_integer(args[3])) {
+ // val = mp_obj_get_int_truncated(args[3]);
+ // optval = &val;
+ // optlen = sizeof(val);
+ // } else {
+ // mp_buffer_info_t bufinfo;
+ // mp_get_buffer_raise(args[3], &bufinfo, MP_BUFFER_READ);
+ // optval = bufinfo.buf;
+ // optlen = bufinfo.len;
+ // }
+
+ // int _errno;
+ // if (self->nic_type->setsockopt(self, level, opt, optval, optlen, &_errno) != 0) {
+ // mp_raise_OSError(_errno);
+ // }
+
+ return mp_const_none;
+}
+STATIC MP_DEFINE_CONST_FUN_OBJ_VAR_BETWEEN(socketpool_socket_setsockopt_obj, 4, 4, socketpool_socket_setsockopt);
+
+//| def settimeout(self, value: int) -> None:
+//| """Set the timeout value for this socket.
+//|
+//| :param ~int value: timeout in seconds. 0 means non-blocking. None means block indefinitely."""
+//| ...
+//|
+
+STATIC mp_obj_t socketpool_socket_settimeout(mp_obj_t self_in, mp_obj_t timeout_in) {
+ // mod_network_socket_obj_t *self = MP_OBJ_TO_PTR(self_in);
+ // if (self->nic == MP_OBJ_NULL) {
+ // // not connected
+ // mp_raise_OSError(MP_ENOTCONN);
+ // }
+ // mp_uint_t timeout;
+ // if (timeout_in == mp_const_none) {
+ // timeout = -1;
+ // } else {
+ // #if MICROPY_PY_BUILTINS_FLOAT
+ // timeout = 1000 * mp_obj_get_float(timeout_in);
+ // #else
+ // timeout = 1000 * mp_obj_get_int(timeout_in);
+ // #endif
+ // }
+ // int _errno;
+ // if (self->nic_type->settimeout(self, timeout, &_errno) != 0) {
+ // mp_raise_OSError(_errno);
+ // }
+ return mp_const_none;
+}
+STATIC MP_DEFINE_CONST_FUN_OBJ_2(socketpool_socket_settimeout_obj, socketpool_socket_settimeout);
+
+//| def setblocking(self, flag: bool) -> Optional[int]:
+//| """Set the blocking behaviour of this socket.
+//|
+//| :param ~bool flag: False means non-blocking, True means block indefinitely."""
+//| ...
+//|
+
+// method socket.setblocking(flag)
+STATIC mp_obj_t socketpool_socket_setblocking(mp_obj_t self_in, mp_obj_t blocking) {
+ // if (mp_obj_is_true(blocking)) {
+ // return socket_settimeout(self_in, mp_const_none);
+ // } else {
+ // return socket_settimeout(self_in, MP_OBJ_NEW_SMALL_INT(0));
+ // }
+ return mp_const_none;
+}
+STATIC MP_DEFINE_CONST_FUN_OBJ_2(socketpool_socket_setblocking_obj, socketpool_socket_setblocking);
+
+STATIC const mp_rom_map_elem_t socketpool_socket_locals_dict_table[] = {
+ { MP_ROM_QSTR(MP_QSTR___enter__), MP_ROM_PTR(&default___enter___obj) },
+ { MP_ROM_QSTR(MP_QSTR___exit__), MP_ROM_PTR(&socketpool_socket___exit___obj) },
+ { MP_ROM_QSTR(MP_QSTR___del__), MP_ROM_PTR(&socketpool_socket_close_obj) },
+ { MP_ROM_QSTR(MP_QSTR_close), MP_ROM_PTR(&socketpool_socket_close_obj) },
+
+ { MP_ROM_QSTR(MP_QSTR_bind), MP_ROM_PTR(&socketpool_socket_bind_obj) },
+ { MP_ROM_QSTR(MP_QSTR_listen), MP_ROM_PTR(&socketpool_socket_listen_obj) },
+ { MP_ROM_QSTR(MP_QSTR_accept), MP_ROM_PTR(&socketpool_socket_accept_obj) },
+ { MP_ROM_QSTR(MP_QSTR_connect), MP_ROM_PTR(&socketpool_socket_connect_obj) },
+ { MP_ROM_QSTR(MP_QSTR_send), MP_ROM_PTR(&socketpool_socket_send_obj) },
+ { MP_ROM_QSTR(MP_QSTR_sendto), MP_ROM_PTR(&socketpool_socket_sendto_obj) },
+ { MP_ROM_QSTR(MP_QSTR_recvfrom_into), MP_ROM_PTR(&socketpool_socket_recvfrom_into_obj) },
+ { MP_ROM_QSTR(MP_QSTR_recv_into), MP_ROM_PTR(&socketpool_socket_recv_into_obj) },
+ { MP_ROM_QSTR(MP_QSTR_setsockopt), MP_ROM_PTR(&socketpool_socket_setsockopt_obj) },
+ { MP_ROM_QSTR(MP_QSTR_settimeout), MP_ROM_PTR(&socketpool_socket_settimeout_obj) },
+ { MP_ROM_QSTR(MP_QSTR_setblocking), MP_ROM_PTR(&socketpool_socket_setblocking_obj) },
+};
+
+STATIC MP_DEFINE_CONST_DICT(socketpool_socket_locals_dict, socketpool_socket_locals_dict_table);
+
+const mp_obj_type_t socketpool_socket_type = {
+ { &mp_type_type },
+ .name = MP_QSTR_Socket,
+ .locals_dict = (mp_obj_dict_t*)&socketpool_socket_locals_dict,
+};
diff --git a/shared-bindings/socketpool/Socket.h b/shared-bindings/socketpool/Socket.h
new file mode 100644
index 000000000..bbe6227ef
--- /dev/null
+++ b/shared-bindings/socketpool/Socket.h
@@ -0,0 +1,38 @@
+/*
+ * This file is part of the MicroPython project, http://micropython.org/
+ *
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2020 Scott Shawcroft for Adafruit Industries
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+
+#ifndef MICROPY_INCLUDED_SHARED_BINDINGS_SOCKETPOOL_SOCKET_H
+#define MICROPY_INCLUDED_SHARED_BINDINGS_SOCKETPOOL_SOCKET_H
+
+#include "common-hal/socketpool/Socket.h"
+
+extern const mp_obj_type_t socketpool_socket_type;
+
+// mp_obj_t common_hal_ipaddress_new_ipv4address(uint32_t value);
+// void common_hal_ipaddress_ipv4address_construct(ipaddress_ipv4address_obj_t* self, uint8_t* buf, size_t len);
+// mp_obj_t common_hal_ipaddress_ipv4address_get_packed(ipaddress_ipv4address_obj_t* self);
+
+#endif // MICROPY_INCLUDED_SHARED_BINDINGS_SOCKETPOOL_SOCKET_H
diff --git a/shared-bindings/socketpool/SocketPool.c b/shared-bindings/socketpool/SocketPool.c
new file mode 100644
index 000000000..ed5ff8275
--- /dev/null
+++ b/shared-bindings/socketpool/SocketPool.c
@@ -0,0 +1,164 @@
+/*
+ * This file is part of the MicroPython project, http://micropython.org/
+ *
+ * The MIT License (MIT)
+ *
+ * SPDX-FileCopyrightText: Copyright (c) 2014 Damien P. George
+ * 2018 Nick Moore for Adafruit Industries
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+
+#include <stdio.h>
+#include <string.h>
+
+#include "py/objtuple.h"
+#include "py/objlist.h"
+#include "py/runtime.h"
+#include "py/mperrno.h"
+
+#include "shared-bindings/socketpool/Socket.h"
+#include "shared-bindings/socketpool/SocketPool.h"
+
+//| class SocketPool:
+//|
+
+STATIC mp_obj_t socketpool_socketpool_make_new(const mp_obj_type_t *type, size_t n_args, const mp_obj_t *args, mp_map_t *kw_args) {
+ mp_arg_check_num(n_args, kw_args, 0, 4, false);
+
+ socketpool_socketpool_obj_t *s = m_new_obj_with_finaliser(socketpool_socketpool_obj_t);
+ s->base.type = &socketpool_socketpool_type;
+
+ return MP_OBJ_FROM_PTR(s);
+}
+
+
+//| def socket(self, family: int, type: int, proto: int) -> None:
+//| """Create a new socket
+//|
+//| :param ~int family: AF_INET or AF_INET6
+//| :param ~int type: SOCK_STREAM, SOCK_DGRAM or SOCK_RAW
+//| :param ~int proto: IPPROTO_TCP, IPPROTO_UDP or IPPROTO_RAW (ignored)"""
+//| ...
+//|
+STATIC mp_obj_t socketpool_socketpool_socket(size_t n_args, const mp_obj_t *pos_args, mp_map_t *kw_args) {
+ mp_arg_check_num(n_args, kw_args, 0, 4, false);
+
+ // create socket object (not bound to any NIC yet)
+ socketpool_socket_obj_t *s = m_new_obj_with_finaliser(socketpool_socket_obj_t);
+ s->base.type = &socketpool_socket_type;
+ // s->nic = MP_OBJ_NULL;
+ // s->nic_type = NULL;
+ // s->u_param.domain = MOD_NETWORK_AF_INET;
+ // s->u_param.type = MOD_NETWORK_SOCK_STREAM;
+ // s->u_param.fileno = -1;
+ // if (n_args >= 1) {
+ // s->u_param.domain = mp_obj_get_int(args[0]);
+ // if (n_args >= 2) {
+ // s->u_param.type = mp_obj_get_int(args[1]);
+ // if (n_args >= 4) {
+ // s->u_param.fileno = mp_obj_get_int(args[3]);
+ // }
+ // }
+ // }
+
+ return MP_OBJ_FROM_PTR(s);
+}
+MP_DEFINE_CONST_FUN_OBJ_KW(socketpool_socketpool_socket_obj, 1, socketpool_socketpool_socket);
+
+//| def getaddrinfo(host: str, port: int) -> tuple:
+//| """Gets the address information for a hostname and port
+//|
+//| Returns the appropriate family, socket type, socket protocol and
+//| address information to call socket.socket() and socket.connect() with,
+//| as a tuple."""
+//| ...
+//|
+
+STATIC mp_obj_t socketpool_socketpool_getaddrinfo(mp_obj_t host_in, mp_obj_t port_in) {
+ // size_t hlen;
+ // const char *host = mp_obj_str_get_data(host_in, &hlen);
+ // mp_int_t port = mp_obj_get_int(port_in);
+ // uint8_t out_ip[MOD_NETWORK_IPADDR_BUF_SIZE];
+ // bool have_ip = false;
+
+ // if (hlen > 0) {
+ // // check if host is already in IP form
+ // nlr_buf_t nlr;
+ // if (nlr_push(&nlr) == 0) {
+ // netutils_parse_ipv4_addr(host_in, out_ip, NETUTILS_BIG);
+ // have_ip = true;
+ // nlr_pop();
+ // } else {
+ // // swallow exception: host was not in IP form so need to do DNS lookup
+ // }
+ // }
+
+ // if (!have_ip) {
+ // // find a NIC that can do a name lookup
+ // for (mp_uint_t i = 0; i < MP_STATE_PORT(mod_network_nic_list).len; i++) {
+ // mp_obj_t nic = MP_STATE_PORT(mod_network_nic_list).items[i];
+ // mod_network_nic_type_t *nic_type = (mod_network_nic_type_t*)mp_obj_get_type(nic);
+ // if (nic_type->gethostbyname != NULL) {
+ // int ret = nic_type->gethostbyname(nic, host, hlen, out_ip);
+ // if (ret != 0) {
+ // mp_raise_OSError(ret);
+ // }
+ // have_ip = true;
+ // break;
+ // }
+ // }
+ // }
+
+ // if (!have_ip) {
+ // nlr_raise(mp_obj_new_exception_msg(&mp_type_OSError, translate("no available NIC")));
+ // }
+
+ // mp_obj_tuple_t *tuple = MP_OBJ_TO_PTR(mp_obj_new_tuple(5, NULL));
+ // tuple->items[0] = MP_OBJ_NEW_SMALL_INT(MOD_NETWORK_AF_INET);
+ // tuple->items[1] = MP_OBJ_NEW_SMALL_INT(MOD_NETWORK_SOCK_STREAM);
+ // tuple->items[2] = MP_OBJ_NEW_SMALL_INT(0);
+ // tuple->items[3] = MP_OBJ_NEW_QSTR(MP_QSTR_);
+ // tuple->items[4] = netutils_format_inet_addr(out_ip, port, NETUTILS_BIG);
+ // return mp_obj_new_list(1, (mp_obj_t*)&tuple);
+ return mp_const_none;
+}
+STATIC MP_DEFINE_CONST_FUN_OBJ_2(socketpool_socketpool_getaddrinfo_obj, socketpool_socketpool_getaddrinfo);
+
+STATIC const mp_rom_map_elem_t socketpool_socketpool_locals_dict_table[] = {
+ { MP_ROM_QSTR(MP_QSTR_socket), MP_ROM_PTR(&socketpool_socketpool_socket_obj) },
+ { MP_ROM_QSTR(MP_QSTR_getaddrinfo), MP_ROM_PTR(&socketpool_socketpool_getaddrinfo_obj) },
+
+ // class constants
+ { MP_ROM_QSTR(MP_QSTR_AF_INET), MP_ROM_INT(SOCKETPOOL_AF_INET) },
+ { MP_ROM_QSTR(MP_QSTR_AF_INET6), MP_ROM_INT(SOCKETPOOL_AF_INET6) },
+
+ { MP_ROM_QSTR(MP_QSTR_SOCK_STREAM), MP_ROM_INT(SOCKETPOOL_SOCK_STREAM) },
+ { MP_ROM_QSTR(MP_QSTR_SOCK_DGRAM), MP_ROM_INT(SOCKETPOOL_SOCK_DGRAM) },
+ { MP_ROM_QSTR(MP_QSTR_SOCK_RAW), MP_ROM_INT(SOCKETPOOL_SOCK_RAW) },
+};
+
+STATIC MP_DEFINE_CONST_DICT(socketpool_socketpool_locals_dict, socketpool_socketpool_locals_dict_table);
+
+const mp_obj_type_t socketpool_socketpool_type = {
+ { &mp_type_type },
+ .name = MP_QSTR_SocketPool,
+ .make_new = socketpool_socketpool_make_new,
+ .locals_dict = (mp_obj_dict_t*)&socketpool_socketpool_locals_dict,
+};
diff --git a/shared-bindings/socketpool/SocketPool.h b/shared-bindings/socketpool/SocketPool.h
new file mode 100644
index 000000000..1852cc168
--- /dev/null
+++ b/shared-bindings/socketpool/SocketPool.h
@@ -0,0 +1,48 @@
+/*
+ * This file is part of the MicroPython project, http://micropython.org/
+ *
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2020 Scott Shawcroft for Adafruit Industries
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+
+#ifndef MICROPY_INCLUDED_SHARED_BINDINGS_SOCKETPOOL_SOCKETPOOL_H
+#define MICROPY_INCLUDED_SHARED_BINDINGS_SOCKETPOOL_SOCKETPOOL_H
+
+#include "common-hal/socketpool/SocketPool.h"
+
+extern const mp_obj_type_t socketpool_socketpool_type;
+
+// mp_obj_t common_hal_ipaddress_new_ipv4address(uint32_t value);
+// void common_hal_ipaddress_ipv4address_construct(ipaddress_ipv4address_obj_t* self, uint8_t* buf, size_t len);
+// mp_obj_t common_hal_ipaddress_ipv4address_get_packed(ipaddress_ipv4address_obj_t* self);
+typedef enum {
+ SOCKETPOOL_SOCK_STREAM,
+ SOCKETPOOL_SOCK_DGRAM,
+ SOCKETPOOL_SOCK_RAW
+} socketpool_socketpool_sock_t;
+
+typedef enum {
+ SOCKETPOOL_AF_INET,
+ SOCKETPOOL_AF_INET6
+} socketpool_socketpool_af_t;
+
+#endif // MICROPY_INCLUDED_SHARED_BINDINGS_SOCKETPOOL_SOCKETPOOL_H
diff --git a/shared-bindings/socketpool/__init__.c b/shared-bindings/socketpool/__init__.c
index 53ac57d11..06d5be5cd 100644
--- a/shared-bindings/socketpool/__init__.c
+++ b/shared-bindings/socketpool/__init__.c
@@ -3,8 +3,7 @@
*
* The MIT License (MIT)
*
- * SPDX-FileCopyrightText: Copyright (c) 2014 Damien P. George
- * 2018 Nick Moore for Adafruit Industries
+ * Copyright (c) 2020 Scott Shawcroft for Adafruit Industries
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
@@ -25,579 +24,30 @@
* THE SOFTWARE.
*/
-#include <stdio.h>
-#include <string.h>
-
-#include "py/objtuple.h"
-#include "py/objlist.h"
+#include "py/objexcept.h"
+#include "py/objstr.h"
+#include "py/parsenum.h"
#include "py/runtime.h"
-#include "py/stream.h"
-#include "py/mperrno.h"
-#include "lib/netutils/netutils.h"
-
-#include "shared-module/network/__init__.h"
-
-//| """TCP, UDP and RAW socket support
-//|
-//| .. warning:: This module is disabled in 6.x and will removed in 7.x. Please use networking
-//| libraries instead. (Native networking will provide a socket compatible class.)
-//|
-//| Create TCP, UDP and RAW sockets for communicating over the Internet."""
-//|
-
-STATIC const mp_obj_type_t socket_type;
-
-//| class socket:
-//|
-//| def __init__(self, family: int, type: int, proto: int) -> None:
-//| """Create a new socket
-//|
-//| :param ~int family: AF_INET or AF_INET6
-//| :param ~int type: SOCK_STREAM, SOCK_DGRAM or SOCK_RAW
-//| :param ~int proto: IPPROTO_TCP, IPPROTO_UDP or IPPROTO_RAW (ignored)"""
-//| ...
-//|
-
-STATIC mp_obj_t socket_make_new(const mp_obj_type_t *type, size_t n_args, const mp_obj_t *args, mp_map_t *kw_args) {
- mp_arg_check_num(n_args, kw_args, 0, 4, false);
-
- // create socket object (not bound to any NIC yet)
- mod_network_socket_obj_t *s = m_new_obj_with_finaliser(mod_network_socket_obj_t);
- s->base.type = &socket_type;
- s->nic = MP_OBJ_NULL;
- s->nic_type = NULL;
- s->u_param.domain = MOD_NETWORK_AF_INET;
- s->u_param.type = MOD_NETWORK_SOCK_STREAM;
- s->u_param.fileno = -1;
- if (n_args >= 1) {
- s->u_param.domain = mp_obj_get_int(args[0]);
- if (n_args >= 2) {
- s->u_param.type = mp_obj_get_int(args[1]);
- if (n_args >= 4) {
- s->u_param.fileno = mp_obj_get_int(args[3]);
- }
- }
- }
-
- return MP_OBJ_FROM_PTR(s);
-}
-
-STATIC void socket_select_nic(mod_network_socket_obj_t *self, const byte *ip) {
- if (self->nic == MP_OBJ_NULL) {
- // select NIC based on IP
- self->nic = network_module_find_nic(ip);
- self->nic_type = (mod_network_nic_type_t*)mp_obj_get_type(self->nic);
-
- // call the NIC to open the socket
- int _errno;
- if (self->nic_type->socket(self, &_errno) != 0) {
- mp_raise_OSError(_errno);
- }
- }
-}
-
-//| def bind(self, address: tuple) -> None:
-//| """Bind a socket to an address
-//|
-//| :param ~tuple address: tuple of (remote_address, remote_port)"""
-//| ...
-//|
-
-STATIC mp_obj_t socket_bind(mp_obj_t self_in, mp_obj_t addr_in) {
- mod_network_socket_obj_t *self = MP_OBJ_TO_PTR(self_in);
-
- // get address
- uint8_t ip[MOD_NETWORK_IPADDR_BUF_SIZE];
- mp_uint_t port = netutils_parse_inet_addr(addr_in, ip, NETUTILS_BIG);
-
- // check if we need to select a NIC
- socket_select_nic(self, ip);
-
- // call the NIC to bind the socket
- int _errno;
- if (self->nic_type->bind(self, ip, port, &_errno) != 0) {
- mp_raise_OSError(_errno);
- }
-
- return mp_const_none;
-}
-STATIC MP_DEFINE_CONST_FUN_OBJ_2(socket_bind_obj, socket_bind);
-
-//| def listen(self, backlog: int) -> None:
-//| """Set socket to listen for incoming connections
-//|
-//| :param ~int backlog: length of backlog queue for waiting connetions"""
-//| ...
-//|
-
-STATIC mp_obj_t socket_listen(mp_obj_t self_in, mp_obj_t backlog) {
- mod_network_socket_obj_t *self = MP_OBJ_TO_PTR(self_in);
-
- if (self->nic == MP_OBJ_NULL) {
- // not connected
- // TODO I think we can listen even if not bound...
- mp_raise_OSError(MP_ENOTCONN);
- }
-
- int _errno;
- if (self->nic_type->listen(self, mp_obj_get_int(backlog), &_errno) != 0) {
- mp_raise_OSError(_errno);
- }
-
- return mp_const_none;
-}
-STATIC MP_DEFINE_CONST_FUN_OBJ_2(socket_listen_obj, socket_listen);
-
-//| def accept(self) -> tuple:
-//| """Accept a connection on a listening socket of type SOCK_STREAM,
-//| creating a new socket of type SOCK_STREAM.
-//| Returns a tuple of (new_socket, remote_address)"""
-//|
-
-STATIC mp_obj_t socket_accept(mp_obj_t self_in) {
- mod_network_socket_obj_t *self = MP_OBJ_TO_PTR(self_in);
-
- // create new socket object
- // starts with empty NIC so that finaliser doesn't run close() method if accept() fails
- mod_network_socket_obj_t *socket2 = m_new_obj_with_finaliser(mod_network_socket_obj_t);
- socket2->base.type = &socket_type;
- socket2->nic = MP_OBJ_NULL;
- socket2->nic_type = NULL;
-
- // accept incoming connection
- uint8_t ip[MOD_NETWORK_IPADDR_BUF_SIZE];
- mp_uint_t port;
- int _errno;
- if (self->nic_type->accept(self, socket2, ip, &port, &_errno) != 0) {
- mp_raise_OSError(_errno);
- }
-
- // new socket has valid state, so set the NIC to the same as parent
- socket2->nic = self->nic;
- socket2->nic_type = self->nic_type;
-
- // make the return value
- mp_obj_tuple_t *client = MP_OBJ_TO_PTR(mp_obj_new_tuple(2, NULL));
- client->items[0] = MP_OBJ_FROM_PTR(socket2);
- client->items[1] = netutils_format_inet_addr(ip, port, NETUTILS_BIG);
-
- return MP_OBJ_FROM_PTR(client);
-}
-STATIC MP_DEFINE_CONST_FUN_OBJ_1(socket_accept_obj, socket_accept);
-
-//| def connect(self, address: tuple) -> None:
-//| """Connect a socket to a remote address
-//|
-//| :param ~tuple address: tuple of (remote_address, remote_port)"""
-//| ...
-//|
-
-STATIC mp_obj_t socket_connect(mp_obj_t self_in, mp_obj_t addr_in) {
- mod_network_socket_obj_t *self = MP_OBJ_TO_PTR(self_in);
-
- // get address
- uint8_t ip[MOD_NETWORK_IPADDR_BUF_SIZE];
- mp_uint_t port = netutils_parse_inet_addr(addr_in, ip, NETUTILS_BIG);
-
- // check if we need to select a NIC
- socket_select_nic(self, ip);
-
- // call the NIC to connect the socket
- int _errno;
- if (self->nic_type->connect(self, ip, port, &_errno) != 0) {
- mp_raise_OSError(_errno);
- }
-
- return mp_const_none;
-}
-STATIC MP_DEFINE_CONST_FUN_OBJ_2(socket_connect_obj, socket_connect);
-
-//| def send(self, bytes: ReadableBuffer) -> int:
-//| """Send some bytes to the connected remote address.
-//| Suits sockets of type SOCK_STREAM
-//|
-//| :param ~bytes bytes: some bytes to send"""
-//| ...
-//|
-
-STATIC mp_obj_t socket_send(mp_obj_t self_in, mp_obj_t buf_in) {
- mod_network_socket_obj_t *self = MP_OBJ_TO_PTR(self_in);
- if (self->nic == MP_OBJ_NULL) {
- // not connected
- mp_raise_OSError(MP_EPIPE);
- }
- mp_buffer_info_t bufinfo;
- mp_get_buffer_raise(buf_in, &bufinfo, MP_BUFFER_READ);
- int _errno;
- mp_int_t ret = self->nic_type->send(self, bufinfo.buf, bufinfo.len, &_errno);
- if (ret == -1) {
- mp_raise_OSError(_errno);
- }
- return mp_obj_new_int_from_uint(ret);
-}
-STATIC MP_DEFINE_CONST_FUN_OBJ_2(socket_send_obj, socket_send);
-
-
-// helper function for socket_recv and socket_recv_into to handle common operations of both
-STATIC mp_int_t _socket_recv_into(mod_network_socket_obj_t *sock, byte *buf, mp_int_t len) {
- int _errno;
- mp_int_t ret = sock->nic_type->recv(sock, buf, len, &_errno);
- if (ret == -1) {
- mp_raise_OSError(_errno);
- }
- return ret;
-}
-
-
-//| def recv_into(self, buffer: WriteableBuffer, bufsize: int) -> int:
-//| """Reads some bytes from the connected remote address, writing
-//| into the provided buffer. If bufsize <= len(buffer) is given,
-//| a maximum of bufsize bytes will be read into the buffer. If no
-//| valid value is given for bufsize, the default is the length of
-//| the given buffer.
-//|
-//| Suits sockets of type SOCK_STREAM
-//| Returns an int of number of bytes read.
-//|
-//| :param bytearray buffer: buffer to receive into
-//| :param int bufsize: optionally, a maximum number of bytes to read."""
-//| ...
-//|
-
-STATIC mp_obj_t socket_recv_into(size_t n_args, const mp_obj_t *args) {
- mod_network_socket_obj_t *self = MP_OBJ_TO_PTR(args[0]);
- if (self->nic == MP_OBJ_NULL) {
- // not connected
- mp_raise_OSError(MP_ENOTCONN);
- }
- mp_buffer_info_t bufinfo;
- mp_get_buffer_raise(args[1], &bufinfo, MP_BUFFER_WRITE);
- mp_int_t len = bufinfo.len;
- if (n_args == 3) {
- mp_int_t given_len = mp_obj_get_int(args[2]);
- if (given_len < len) {
- len = given_len;
- }
- }
-
- mp_int_t ret = _socket_recv_into(self, (byte*)bufinfo.buf, len);
- return mp_obj_new_int_from_uint(ret);
-}
-STATIC MP_DEFINE_CONST_FUN_OBJ_VAR_BETWEEN(socket_recv_into_obj, 2, 3, socket_recv_into);
-
-//| def recv(self, bufsize: int) -> bytes:
-//| """Reads some bytes from the connected remote address.
-//| Suits sockets of type SOCK_STREAM
-//| Returns a bytes() of length <= bufsize
-//|
-//| :param ~int bufsize: maximum number of bytes to receive"""
-//| ...
-//|
-
-STATIC mp_obj_t socket_recv(mp_obj_t self_in, mp_obj_t len_in) {
- mod_network_socket_obj_t *self = MP_OBJ_TO_PTR(self_in);
- if (self->nic == MP_OBJ_NULL) {
- // not connected
- mp_raise_OSError(MP_ENOTCONN);
- }
- mp_int_t len = mp_obj_get_int(len_in);
- vstr_t vstr;
- vstr_init_len(&vstr, len);
- mp_int_t ret = _socket_recv_into(self, (byte*)vstr.buf, len);
- if (ret == 0) {
- return mp_const_empty_bytes;
- }
- vstr.len = ret;
- return mp_obj_new_str_from_vstr(&mp_type_bytes, &vstr);
-}
-STATIC MP_DEFINE_CONST_FUN_OBJ_2(socket_recv_obj, socket_recv);
-
-//| def sendto(self, bytes: ReadableBuffer, address: tuple) -> int:
-//| """Send some bytes to a specific address.
-//| Suits sockets of type SOCK_DGRAM
-//|
-//| :param ~bytes bytes: some bytes to send
-//| :param ~tuple address: tuple of (remote_address, remote_port)"""
-//| ...
-//|
-
-STATIC mp_obj_t socket_sendto(mp_obj_t self_in, mp_obj_t data_in, mp_obj_t addr_in) {
- mod_network_socket_obj_t *self = MP_OBJ_TO_PTR(self_in);
-
- // get the data
- mp_buffer_info_t bufinfo;
- mp_get_buffer_raise(data_in, &bufinfo, MP_BUFFER_READ);
+#include "shared-bindings/socketpool/__init__.h"
+#include "shared-bindings/socketpool/Socket.h"
+#include "shared-bindings/socketpool/SocketPool.h"
- // get address
- uint8_t ip[MOD_NETWORK_IPADDR_BUF_SIZE];
- mp_uint_t port = netutils_parse_inet_addr(addr_in, ip, NETUTILS_BIG);
-
- // check if we need to select a NIC
- socket_select_nic(self, ip);
-
- // call the NIC to sendto
- int _errno;
- mp_int_t ret = self->nic_type->sendto(self, bufinfo.buf, bufinfo.len, ip, port, &_errno);
- if (ret == -1) {
- mp_raise_OSError(_errno);
- }
-
- return mp_obj_new_int(ret);
-}
-STATIC MP_DEFINE_CONST_FUN_OBJ_3(socket_sendto_obj, socket_sendto);
-
-//| def recvfrom(self, bufsize: int) -> Tuple[bytes, tuple]:
-//| """Reads some bytes from the connected remote address.
-//| Suits sockets of type SOCK_STREAM
-//|
-//| Returns a tuple containing
-//| * a bytes() of length <= bufsize
-//| * a remote_address, which is a tuple of ip address and port number
-//|
-//| :param ~int bufsize: maximum number of bytes to receive"""
-//| ...
-//|
-
-STATIC mp_obj_t socket_recvfrom(mp_obj_t self_in, mp_obj_t len_in) {
- mod_network_socket_obj_t *self = MP_OBJ_TO_PTR(self_in);
- if (self->nic == MP_OBJ_NULL) {
- // not connected
- mp_raise_OSError(MP_ENOTCONN);
- }
- vstr_t vstr;
- vstr_init_len(&vstr, mp_obj_get_int(len_in));
- byte ip[4];
- mp_uint_t port;
- int _errno;
- mp_int_t ret = self->nic_type->recvfrom(self, (byte*)vstr.buf, vstr.len, ip, &port, &_errno);
- if (ret == -1) {
- mp_raise_OSError(_errno);
- }
- mp_obj_t tuple[2];
- if (ret == 0) {
- tuple[0] = mp_const_empty_bytes;
- } else {
- vstr.len = ret;
- tuple[0] = mp_obj_new_str_from_vstr(&mp_type_bytes, &vstr);
- }
- tuple[1] = netutils_format_inet_addr(ip, port, NETUTILS_BIG);
- return mp_obj_new_tuple(2, tuple);
-}
-STATIC MP_DEFINE_CONST_FUN_OBJ_2(socket_recvfrom_obj, socket_recvfrom);
-
-//| def setsockopt(self, level: int, optname: int, value: int) -> None:
-//| """Sets socket options"""
-//| ...
+//| """
+//| The `ipaddress` module provides types for IP addresses. It is a subset of CPython's ipaddress
+//| module.
+//| """
//|
-STATIC mp_obj_t socket_setsockopt(size_t n_args, const mp_obj_t *args) {
- mod_network_socket_obj_t *self = MP_OBJ_TO_PTR(args[0]);
-
- mp_int_t level = mp_obj_get_int(args[1]);
- mp_int_t opt = mp_obj_get_int(args[2]);
-
- const void *optval;
- mp_uint_t optlen;
- mp_int_t val;
- if (mp_obj_is_integer(args[3])) {
- val = mp_obj_get_int_truncated(args[3]);
- optval = &val;
- optlen = sizeof(val);
- } else {
- mp_buffer_info_t bufinfo;
- mp_get_buffer_raise(args[3], &bufinfo, MP_BUFFER_READ);
- optval = bufinfo.buf;
- optlen = bufinfo.len;
- }
-
- int _errno;
- if (self->nic_type->setsockopt(self, level, opt, optval, optlen, &_errno) != 0) {
- mp_raise_OSError(_errno);
- }
-
- return mp_const_none;
-}
-STATIC MP_DEFINE_CONST_FUN_OBJ_VAR_BETWEEN(socket_setsockopt_obj, 4, 4, socket_setsockopt);
-
-//| def settimeout(self, value: int) -> None:
-//| """Set the timeout value for this socket.
-//|
-//| :param ~int value: timeout in seconds. 0 means non-blocking. None means block indefinitely."""
-//| ...
-//|
-
-STATIC mp_obj_t socket_settimeout(mp_obj_t self_in, mp_obj_t timeout_in) {
- mod_network_socket_obj_t *self = MP_OBJ_TO_PTR(self_in);
- if (self->nic == MP_OBJ_NULL) {
- // not connected
- mp_raise_OSError(MP_ENOTCONN);
- }
- mp_uint_t timeout;
- if (timeout_in == mp_const_none) {
- timeout = -1;
- } else {
- #if MICROPY_PY_BUILTINS_FLOAT
- timeout = 1000 * mp_obj_get_float(timeout_in);
- #else
- timeout = 1000 * mp_obj_get_int(timeout_in);
- #endif
- }
- int _errno;
- if (self->nic_type->settimeout(self, timeout, &_errno) != 0) {
- mp_raise_OSError(_errno);
- }
- return mp_const_none;
-}
-STATIC MP_DEFINE_CONST_FUN_OBJ_2(socket_settimeout_obj, socket_settimeout);
-
-//| def setblocking(self, flag: bool) -> Optional[int]:
-//| """Set the blocking behaviour of this socket.
-//|
-//| :param ~bool flag: False means non-blocking, True means block indefinitely."""
-//| ...
-//|
-
-// method socket.setblocking(flag)
-STATIC mp_obj_t socket_setblocking(mp_obj_t self_in, mp_obj_t blocking) {
- if (mp_obj_is_true(blocking)) {
- return socket_settimeout(self_in, mp_const_none);
- } else {
- return socket_settimeout(self_in, MP_OBJ_NEW_SMALL_INT(0));
- }
-}
-STATIC MP_DEFINE_CONST_FUN_OBJ_2(socket_setblocking_obj, socket_setblocking);
-
-STATIC const mp_rom_map_elem_t socket_locals_dict_table[] = {
- { MP_ROM_QSTR(MP_QSTR___del__), MP_ROM_PTR(&mp_stream_close_obj) },
- { MP_ROM_QSTR(MP_QSTR_close), MP_ROM_PTR(&mp_stream_close_obj) },
- { MP_ROM_QSTR(MP_QSTR_bind), MP_ROM_PTR(&socket_bind_obj) },
- { MP_ROM_QSTR(MP_QSTR_listen), MP_ROM_PTR(&socket_listen_obj) },
- { MP_ROM_QSTR(MP_QSTR_accept), MP_ROM_PTR(&socket_accept_obj) },
- { MP_ROM_QSTR(MP_QSTR_connect), MP_ROM_PTR(&socket_connect_obj) },
- { MP_ROM_QSTR(MP_QSTR_send), MP_ROM_PTR(&socket_send_obj) },
- { MP_ROM_QSTR(MP_QSTR_recv), MP_ROM_PTR(&socket_recv_obj) },
- { MP_ROM_QSTR(MP_QSTR_sendto), MP_ROM_PTR(&socket_sendto_obj) },
- { MP_ROM_QSTR(MP_QSTR_recvfrom), MP_ROM_PTR(&socket_recvfrom_obj) },
- { MP_ROM_QSTR(MP_QSTR_recv_into), MP_ROM_PTR(&socket_recv_into_obj) },
- { MP_ROM_QSTR(MP_QSTR_setsockopt), MP_ROM_PTR(&socket_setsockopt_obj) },
- { MP_ROM_QSTR(MP_QSTR_settimeout), MP_ROM_PTR(&socket_settimeout_obj) },
- { MP_ROM_QSTR(MP_QSTR_setblocking), MP_ROM_PTR(&socket_setblocking_obj) },
-};
-
-STATIC MP_DEFINE_CONST_DICT(socket_locals_dict, socket_locals_dict_table);
-
-mp_uint_t socket_ioctl(mp_obj_t self_in, mp_uint_t request, uintptr_t arg, int *errcode) {
- mod_network_socket_obj_t *self = MP_OBJ_TO_PTR(self_in);
- if (request == MP_STREAM_CLOSE) {
- if (self->nic != MP_OBJ_NULL) {
- self->nic_type->close(self);
- self->nic = MP_OBJ_NULL;
- }
- return 0;
- }
- return self->nic_type->ioctl(self, request, arg, errcode);
-}
-
-STATIC const mp_stream_p_t socket_stream_p = {
- MP_PROTO_IMPLEMENT(MP_QSTR_protocol_stream)
- .ioctl = socket_ioctl,
- .is_text = false,
-};
-
-STATIC const mp_obj_type_t socket_type = {
- { &mp_type_type },
- .name = MP_QSTR_socket,
- .make_new = socket_make_new,
- .protocol = &socket_stream_p,
- .locals_dict = (mp_obj_dict_t*)&socket_locals_dict,
-};
-
-//| def getaddrinfo(host: str, port: int) -> tuple:
-//| """Gets the address information for a hostname and port
-//|
-//| Returns the appropriate family, socket type, socket protocol and
-//| address information to call socket.socket() and socket.connect() with,
-//| as a tuple."""
-//| ...
-//|
-
-STATIC mp_obj_t socket_getaddrinfo(mp_obj_t host_in, mp_obj_t port_in) {
- size_t hlen;
- const char *host = mp_obj_str_get_data(host_in, &hlen);
- mp_int_t port = mp_obj_get_int(port_in);
- uint8_t out_ip[MOD_NETWORK_IPADDR_BUF_SIZE];
- bool have_ip = false;
-
- if (hlen > 0) {
- // check if host is already in IP form
- nlr_buf_t nlr;
- if (nlr_push(&nlr) == 0) {
- netutils_parse_ipv4_addr(host_in, out_ip, NETUTILS_BIG);
- have_ip = true;
- nlr_pop();
- } else {
- // swallow exception: host was not in IP form so need to do DNS lookup
- }
- }
-
- if (!have_ip) {
- // find a NIC that can do a name lookup
- for (mp_uint_t i = 0; i < MP_STATE_PORT(mod_network_nic_list).len; i++) {
- mp_obj_t nic = MP_STATE_PORT(mod_network_nic_list).items[i];
- mod_network_nic_type_t *nic_type = (mod_network_nic_type_t*)mp_obj_get_type(nic);
- if (nic_type->gethostbyname != NULL) {
- int ret = nic_type->gethostbyname(nic, host, hlen, out_ip);
- if (ret != 0) {
- mp_raise_OSError(ret);
- }
- have_ip = true;
- break;
- }
- }
- }
-
- if (!have_ip) {
- nlr_raise(mp_obj_new_exception_msg(&mp_type_OSError, translate("no available NIC")));
- }
-
- mp_obj_tuple_t *tuple = MP_OBJ_TO_PTR(mp_obj_new_tuple(5, NULL));
- tuple->items[0] = MP_OBJ_NEW_SMALL_INT(MOD_NETWORK_AF_INET);
- tuple->items[1] = MP_OBJ_NEW_SMALL_INT(MOD_NETWORK_SOCK_STREAM);
- tuple->items[2] = MP_OBJ_NEW_SMALL_INT(0);
- tuple->items[3] = MP_OBJ_NEW_QSTR(MP_QSTR_);
- tuple->items[4] = netutils_format_inet_addr(out_ip, port, NETUTILS_BIG);
- return mp_obj_new_list(1, (mp_obj_t*)&tuple);
-}
-STATIC MP_DEFINE_CONST_FUN_OBJ_2(socket_getaddrinfo_obj, socket_getaddrinfo);
-
-STATIC const mp_rom_map_elem_t socket_globals_table[] = {
- { MP_ROM_QSTR(MP_QSTR___name__), MP_ROM_QSTR(MP_QSTR_usocket) },
-
- { MP_ROM_QSTR(MP_QSTR_socket), MP_ROM_PTR(&socket_type) },
- { MP_ROM_QSTR(MP_QSTR_getaddrinfo), MP_ROM_PTR(&socket_getaddrinfo_obj) },
-
- // class constants
- { MP_ROM_QSTR(MP_QSTR_AF_INET), MP_ROM_INT(MOD_NETWORK_AF_INET) },
- { MP_ROM_QSTR(MP_QSTR_AF_INET6), MP_ROM_INT(MOD_NETWORK_AF_INET6) },
-
- { MP_ROM_QSTR(MP_QSTR_SOCK_STREAM), MP_ROM_INT(MOD_NETWORK_SOCK_STREAM) },
- { MP_ROM_QSTR(MP_QSTR_SOCK_DGRAM), MP_ROM_INT(MOD_NETWORK_SOCK_DGRAM) },
- { MP_ROM_QSTR(MP_QSTR_SOCK_RAW), MP_ROM_INT(MOD_NETWORK_SOCK_RAW) },
+STATIC const mp_rom_map_elem_t socketpool_globals_table[] = {
+ { MP_ROM_QSTR(MP_QSTR___name__), MP_ROM_QSTR(MP_QSTR_socketpool) },
- /*
- { MP_ROM_QSTR(MP_QSTR_IPPROTO_IP), MP_ROM_INT(MOD_NETWORK_IPPROTO_IP) },
- { MP_ROM_QSTR(MP_QSTR_IPPROTO_ICMP), MP_ROM_INT(MOD_NETWORK_IPPROTO_ICMP) },
- { MP_ROM_QSTR(MP_QSTR_IPPROTO_IPV4), MP_ROM_INT(MOD_NETWORK_IPPROTO_IPV4) },
- { MP_ROM_QSTR(MP_QSTR_IPPROTO_TCP), MP_ROM_INT(MOD_NETWORK_IPPROTO_TCP) },
- { MP_ROM_QSTR(MP_QSTR_IPPROTO_UDP), MP_ROM_INT(MOD_NETWORK_IPPROTO_UDP) },
- { MP_ROM_QSTR(MP_QSTR_IPPROTO_IPV6), MP_ROM_INT(MOD_NETWORK_IPPROTO_IPV6) },
- { MP_ROM_QSTR(MP_QSTR_IPPROTO_RAW), MP_ROM_INT(MOD_NETWORK_IPPROTO_RAW) },
- */
+ { MP_ROM_QSTR(MP_QSTR_SocketPool), MP_ROM_PTR(&socketpool_socketpool_type) },
+ { MP_ROM_QSTR(MP_QSTR_Socket), MP_ROM_PTR(&socketpool_socket_type) },
};
-STATIC MP_DEFINE_CONST_DICT(socket_globals, socket_globals_table);
+STATIC MP_DEFINE_CONST_DICT(socketpool_globals, socketpool_globals_table);
-const mp_obj_module_t socket_module = {
+const mp_obj_module_t socketpool_module = {
.base = { &mp_type_module },
- .globals = (mp_obj_dict_t*)&socket_globals,
+ .globals = (mp_obj_dict_t*)&socketpool_globals,
};
diff --git a/shared-bindings/socketpool/__init__.h b/shared-bindings/socketpool/__init__.h
new file mode 100644
index 000000000..76d8bfa76
--- /dev/null
+++ b/shared-bindings/socketpool/__init__.h
@@ -0,0 +1,34 @@
+/*
+ * This file is part of the MicroPython project, http://micropython.org/
+ *
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2020 Scott Shawcroft for Adafruit Industries
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+
+#ifndef MICROPY_INCLUDED_SHARED_BINDINGS_IPADDRESS___INIT___H
+#define MICROPY_INCLUDED_SHARED_BINDINGS_IPADDRESS___INIT___H
+
+#include "shared-module/ipaddress/__init__.h"
+
+mp_obj_t common_hal_ipaddress_new_ipv4address(uint32_t value);
+
+#endif // MICROPY_INCLUDED_SHARED_BINDINGS_IPADDRESS___INIT___H