Merge pull request #40 from adafruit/main

Update from adafruit main

1 files changed, 123 insertions, 170 deletions

diff --git a/shared-bindings/socketpool/Socket.c b/shared-bindings/socketpool/Socket.c
index 0e6968d5f..27440487a 100644
--- a/shared-bindings/socketpool/Socket.c
+++ b/shared-bindings/socketpool/Socket.c
@@ -3,8 +3,8 @@
  *
  * 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
+ * Copyright (c) 2021 Lucian Copeland 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
@@ -64,94 +64,49 @@ STATIC mp_obj_t socketpool_socket___exit__(size_t n_args, const mp_obj_t *args)
 }
 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);
-//     // }
+//|     def accept(self) -> Tuple[Socket, Tuple[str, int]]:
+//|         """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) {
+    socketpool_socket_obj_t *self = MP_OBJ_TO_PTR(self_in);
+    uint8_t ip[4];
+    uint port;
 
-//     return mp_const_none;
-// }
-// STATIC MP_DEFINE_CONST_FUN_OBJ_2(socketpool_socket_listen_obj, socketpool_socket_listen);
+    socketpool_socket_obj_t * sock = common_hal_socketpool_socket_accept(self, ip, &port);
 
-// //|     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);
+    mp_obj_t tuple_contents[2];
+    tuple_contents[0] = MP_OBJ_FROM_PTR(sock);
+    tuple_contents[1] = netutils_format_inet_addr(ip, port, NETUTILS_BIG);
+    return mp_obj_new_tuple(2, tuple_contents);
+}
+STATIC MP_DEFINE_CONST_FUN_OBJ_1(socketpool_socket_accept_obj, socketpool_socket_accept);
 
-//     // // 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;
+//|     def bind(self, address: Tuple[str, int]) -> 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) {
+    socketpool_socket_obj_t *self = MP_OBJ_TO_PTR(self_in);
 
-//     // // 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);
-//     // }
+    mp_obj_t *addr_items;
+    mp_obj_get_array_fixed_n(addr_in, 2, &addr_items);
 
-//     // // new socket has valid state, so set the NIC to the same as parent
-//     // socket2->nic = self->nic;
-//     // socket2->nic_type = self->nic_type;
+    size_t hostlen;
+    const char* host = mp_obj_str_get_data(addr_items[0], &hostlen);
+    mp_int_t port = mp_obj_get_int(addr_items[1]);
 
-//     // // 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);
+    bool ok = common_hal_socketpool_socket_bind(self, host, hostlen, port);
+    if (!ok) {
+        mp_raise_ValueError(translate("Error: Failure to bind"));
+    }
 
-//     return mp_const_none;
-// }
-// STATIC MP_DEFINE_CONST_FUN_OBJ_1(socketpool_socket_accept_obj, socketpool_socket_accept);
+    return mp_const_none;
+}
+STATIC MP_DEFINE_CONST_FUN_OBJ_2(socketpool_socket_bind_obj, socketpool_socket_bind);
 
 //|     def close(self) -> None:
 //|         """Closes this Socket and makes its resources available to its SocketPool."""
@@ -169,7 +124,6 @@ STATIC MP_DEFINE_CONST_FUN_OBJ_1(socketpool_socket_close_obj, socketpool_socket_
 //|         :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) {
     socketpool_socket_obj_t *self = MP_OBJ_TO_PTR(self_in);
 
@@ -189,45 +143,47 @@ STATIC mp_obj_t socketpool_socket_connect(mp_obj_t self_in, mp_obj_t addr_in) {
 }
 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
+//|     def listen(self, backlog: int) -> None:
+//|         """Set socket to listen for incoming connections
 //|
-//|         :param ~bytes bytes: some bytes to send"""
+//|         :param ~int backlog: length of backlog queue for waiting connetions"""
 //|         ...
 //|
-
-STATIC mp_obj_t socketpool_socket_send(mp_obj_t self_in, mp_obj_t buf_in) {
+STATIC mp_obj_t socketpool_socket_listen(mp_obj_t self_in, mp_obj_t backlog_in) {
     socketpool_socket_obj_t *self = MP_OBJ_TO_PTR(self_in);
-    if (common_hal_socketpool_socket_get_closed(self)) {
-        // Bad file number.
-        mp_raise_OSError(MP_EBADF);
-    }
-    if (!common_hal_socketpool_socket_get_connected(self)) {
-        mp_raise_BrokenPipeError();
-    }
-    mp_buffer_info_t bufinfo;
-    mp_get_buffer_raise(buf_in, &bufinfo, MP_BUFFER_READ);
-    mp_int_t ret = common_hal_socketpool_socket_send(self, bufinfo.buf, bufinfo.len);
-    if (ret == -1) {
-        mp_raise_BrokenPipeError();
-    }
-    return mp_obj_new_int_from_uint(ret);
-}
-STATIC MP_DEFINE_CONST_FUN_OBJ_2(socketpool_socket_send_obj, socketpool_socket_send);
 
+    int backlog = mp_obj_get_int(backlog_in);
 
-// 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;
-// }
+    common_hal_socketpool_socket_listen(self, backlog);
+    return mp_const_none;
+}
+STATIC MP_DEFINE_CONST_FUN_OBJ_2(socketpool_socket_listen_obj, socketpool_socket_listen);
+
+//|     def recvfrom_into(self, buffer: WriteableBuffer) -> Tuple[int, Tuple[str, int]]:
+//|         """Reads some bytes from a remote address.
+//|
+//|         Returns a tuple containing
+//|         * the number of bytes received into the given buffer
+//|         * a remote_address, which is a tuple of ip address and port number
+//|
+//|         :param object buffer: buffer to read into"""
+//|         ...
+//|
+STATIC mp_obj_t socketpool_socket_recvfrom_into(mp_obj_t self_in, mp_obj_t data_in) {
+    socketpool_socket_obj_t *self = MP_OBJ_TO_PTR(self_in);
+    mp_buffer_info_t bufinfo;
+    mp_get_buffer_raise(data_in, &bufinfo, MP_BUFFER_WRITE);
 
+    byte ip[4];
+    mp_uint_t port;
+    mp_int_t ret = common_hal_socketpool_socket_recvfrom_into(self,
+        (byte*)bufinfo.buf, bufinfo.len, ip, &port);
+    mp_obj_t tuple_contents[2];
+    tuple_contents[0] = mp_obj_new_int_from_uint(ret);
+    tuple_contents[1] = netutils_format_inet_addr(ip, port, NETUTILS_BIG);
+    return mp_obj_new_tuple(2, tuple_contents);
+}
+STATIC MP_DEFINE_CONST_FUN_OBJ_2(socketpool_socket_recvfrom_into_obj, socketpool_socket_recvfrom_into);
 
 //|     def recv_into(self, buffer: WriteableBuffer, bufsize: int) -> int:
 //|         """Reads some bytes from the connected remote address, writing
@@ -243,17 +199,16 @@ STATIC MP_DEFINE_CONST_FUN_OBJ_2(socketpool_socket_send_obj, socketpool_socket_s
 //|         :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) {
     socketpool_socket_obj_t *self = MP_OBJ_TO_PTR(args[0]);
     if (common_hal_socketpool_socket_get_closed(self)) {
         // Bad file number.
         mp_raise_OSError(MP_EBADF);
     }
-    if (!common_hal_socketpool_socket_get_connected(self)) {
-        // not connected
-        mp_raise_OSError(MP_ENOTCONN);
-    }
+    // if (!common_hal_socketpool_socket_get_connected(self)) {
+    //     // 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;
@@ -276,6 +231,32 @@ STATIC mp_obj_t socketpool_socket_recv_into(size_t n_args, const mp_obj_t *args)
 }
 STATIC MP_DEFINE_CONST_FUN_OBJ_VAR_BETWEEN(socketpool_socket_recv_into_obj, 2, 3, socketpool_socket_recv_into);
 
+//|     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) {
+    socketpool_socket_obj_t *self = MP_OBJ_TO_PTR(self_in);
+    if (common_hal_socketpool_socket_get_closed(self)) {
+        // Bad file number.
+        mp_raise_OSError(MP_EBADF);
+    }
+    if (!common_hal_socketpool_socket_get_connected(self)) {
+        mp_raise_BrokenPipeError();
+    }
+    mp_buffer_info_t bufinfo;
+    mp_get_buffer_raise(buf_in, &bufinfo, MP_BUFFER_READ);
+    mp_int_t ret = common_hal_socketpool_socket_send(self, bufinfo.buf, bufinfo.len);
+    if (ret == -1) {
+        mp_raise_BrokenPipeError();
+    }
+    return mp_obj_new_int_from_uint(ret);
+}
+STATIC MP_DEFINE_CONST_FUN_OBJ_2(socketpool_socket_send_obj, socketpool_socket_send);
+
 //|     def sendto(self, bytes: ReadableBuffer, address: Tuple[str, int]) -> int:
 //|         """Send some bytes to a specific address.
 //|         Suits sockets of type SOCK_DGRAM
@@ -284,7 +265,6 @@ STATIC MP_DEFINE_CONST_FUN_OBJ_VAR_BETWEEN(socketpool_socket_recv_into_obj, 2, 3
 //|         :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) {
     socketpool_socket_obj_t *self = MP_OBJ_TO_PTR(self_in);
 
@@ -308,37 +288,28 @@ STATIC mp_obj_t socketpool_socket_sendto(mp_obj_t self_in, mp_obj_t data_in, mp_
 }
 STATIC MP_DEFINE_CONST_FUN_OBJ_3(socketpool_socket_sendto_obj, socketpool_socket_sendto);
 
-//|     def recvfrom_into(self, buffer: WriteableBuffer) -> Tuple[int, Tuple[str, int]]:
-//|         """Reads some bytes from a remote address.
+//|     def setblocking(self, flag: bool) -> Optional[int]:
+//|         """Set the blocking behaviour of this socket.
 //|
-//|         Returns a tuple containing
-//|         * the number of bytes received into the given buffer
-//|         * a remote_address, which is a tuple of ip address and port number
-//|
-//|         :param object buffer: buffer to read into"""
+//|         :param ~bool flag: False means non-blocking, True means block indefinitely."""
 //|         ...
 //|
-STATIC mp_obj_t socketpool_socket_recvfrom_into(mp_obj_t self_in, mp_obj_t data_in) {
+// method socket.setblocking(flag)
+STATIC mp_obj_t socketpool_socket_setblocking(mp_obj_t self_in, mp_obj_t blocking) {
     socketpool_socket_obj_t *self = MP_OBJ_TO_PTR(self_in);
-    mp_buffer_info_t bufinfo;
-    mp_get_buffer_raise(data_in, &bufinfo, MP_BUFFER_WRITE);
-
-    byte ip[4];
-    mp_uint_t port;
-    mp_int_t ret = common_hal_socketpool_socket_recvfrom_into(self,
-        (byte*)bufinfo.buf, bufinfo.len, ip, &port);
-    mp_obj_t tuple_contents[2];
-    tuple_contents[0] = mp_obj_new_int_from_uint(ret);
-    tuple_contents[1] = netutils_format_inet_addr(ip, port, NETUTILS_BIG);
-    return mp_obj_new_tuple(2, tuple_contents);
+    if (mp_obj_is_true(blocking)) {
+        common_hal_socketpool_socket_settimeout(self, -1);
+    } else {
+        common_hal_socketpool_socket_settimeout(self, 0);
+    }
+    return mp_const_none;
 }
-STATIC MP_DEFINE_CONST_FUN_OBJ_2(socketpool_socket_recvfrom_into_obj, socketpool_socket_recvfrom_into);
+STATIC MP_DEFINE_CONST_FUN_OBJ_2(socketpool_socket_setblocking_obj, socketpool_socket_setblocking);
 
 // //|     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]);
 
@@ -368,13 +339,13 @@ STATIC MP_DEFINE_CONST_FUN_OBJ_2(socketpool_socket_recvfrom_into_obj, socketpool
 // }
 // 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) {
     socketpool_socket_obj_t *self = MP_OBJ_TO_PTR(self_in);
     mp_uint_t timeout_ms;
@@ -392,24 +363,6 @@ STATIC mp_obj_t socketpool_socket_settimeout(mp_obj_t self_in, mp_obj_t timeout_
 }
 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);
-
 //|     def __hash__(self) -> int:
 //|         """Returns a hash for the Socket."""
 //|         ...
@@ -417,7 +370,7 @@ STATIC MP_DEFINE_CONST_FUN_OBJ_2(socketpool_socket_settimeout_obj, socketpool_so
 STATIC mp_obj_t socketpool_socket_unary_op(mp_unary_op_t op, mp_obj_t self_in) {
     switch (op) {
         case MP_UNARY_OP_HASH: {
-            return MP_OBJ_NEW_SMALL_INT(common_hal_socketpool_socket_get_hash(MP_OBJ_TO_PTR(self_in)));
+            return mp_obj_id(self_in);
         }
         default:
             return MP_OBJ_NULL; // op not supported
@@ -428,19 +381,19 @@ 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_accept), MP_ROM_PTR(&socketpool_socket_accept_obj) },
+    { MP_ROM_QSTR(MP_QSTR_bind), MP_ROM_PTR(&socketpool_socket_bind_obj) },
+    { MP_ROM_QSTR(MP_QSTR_close), MP_ROM_PTR(&socketpool_socket_close_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_listen), MP_ROM_PTR(&socketpool_socket_listen_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_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_setblocking), MP_ROM_PTR(&socketpool_socket_setblocking_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);