djsundog
/
circuitpython
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Document socketpool.SocketPool.__init__()

This commit is contained in:
Alec Delaney 2022-09-01 19:44:08 -04:00
parent b1371ceb62
commit 85f0206fa4
1 changed files with 12 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
shared-bindings/socketpool/SocketPool.c
View File

@ -38,11 +38,20 @@
//| class SocketPool: //| class SocketPool:
//| """A pool of socket resources available for the given radio. Only one //| """A pool of socket resources available for the given radio. Only one
//| SocketPool can be created for each radio. //| SocketPool can be created for each radio.
//| //|
//| SocketPool should be used in place of CPython's socket which provides //| SocketPool should be used in place of CPython's socket which provides
//| a pool of sockets provided by the underlying OS.""" //| a pool of sockets provided by the underlying OS.
//| """
//| //|
//| def __init__(self, radio: wifi.Radio) -> None:
//| """Create a new SocketPool object for the provided radio
//|
//| :param wifi.Radio radio: The (connected) network hardware to associate
//| with this SocketPool; currently, this will always be the object
//| returned by :py:attr:`wifi.radio`
//| """
//| ...
STATIC mp_obj_t socketpool_socketpool_make_new(const mp_obj_type_t *type, size_t n_args, size_t n_kw, const mp_obj_t *args) { STATIC mp_obj_t socketpool_socketpool_make_new(const mp_obj_type_t *type, size_t n_args, size_t n_kw, const mp_obj_t *args) {
mp_arg_check_num(n_args, n_kw, 1, 1, false); mp_arg_check_num(n_args, n_kw, 1, 1, false);