:mod:`socketpool`
=================

.. py:module:: socketpool

.. autoapi-nested-parse::

   The `socketpool` module provides sockets through a pool. The pools themselves
   act like CPython's `socket` module.



.. raw:: html

    <p>
    <details>
    <summary>Available on these boards</summary>
    <ul>
    <li> AITHinker ESP32-C3S_Kit
    <li> ATMegaZero ESP32-S2
    <li> Adafruit Feather ESP32-S2 TFT
    <li> Adafruit Feather ESP32S2
    <li> Adafruit FunHouse
    <li> Adafruit MagTag
    <li> Adafruit Metro ESP32S2
    <li> Adafruit QT Py ESP32S2
    <li> Artisense Reference Design RD00
    <li> BastWiFi
    <li> CrumpS2
    <li> ESP 12k NodeMCU
    <li> Feather ESP32S2 without PSRAM
    <li> FeatherS2
    <li> FeatherS2 Neo
    <li> FeatherS2 PreRelease
    <li> Franzininho WIFI w/Wroom
    <li> Franzininho WIFI w/Wrover
    <li> Gravitech Cucumber M
    <li> Gravitech Cucumber MS
    <li> Gravitech Cucumber R
    <li> Gravitech Cucumber RS
    <li> HMI-DevKit-1.1
    <li> Kaluga 1
    <li> LILYGO TTGO T8 ESP32-S2 w/Display
    <li> MORPHEANS MorphESP-240
    <li> MicroDev microC3
    <li> MicroDev microS2
    <li> Oak Dev Tech PixelWing ESP32S2
    <li> S2Mini
    <li> S2Pico
    <li> Saola 1 w/Wroom
    <li> Saola 1 w/Wrover
    <li> Targett Module Clip w/Wroom
    <li> Targett Module Clip w/Wrover
    <li> Thingz - Galaxia
    <li> TinyS2
    <li> nanoESP32-S2  w/Wrover
    <li> nanoESP32-S2 w/Wroom
    </ul>
    </details>
    </p>




.. py: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.

   .. py:method:: __enter__() -> Socket

      No-op used by Context Managers.


   .. py:method:: __exit__() -> None

      Automatically closes the Socket when exiting a context. See
      :ref:`lifetime-and-contextmanagers` for more info.


   .. py:method:: accept() -> 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)


   .. py:method:: bind(address: Tuple[str, int]) -> None

      Bind a socket to an address

      :param ~tuple address: tuple of (remote_address, remote_port)


   .. py:method:: close() -> None

      Closes this Socket and makes its resources available to its SocketPool.


   .. py:method:: connect(address: Tuple[str, int]) -> None

      Connect a socket to a remote address

      :param ~tuple address: tuple of (remote_address, remote_port)


   .. py:method:: listen(backlog: int) -> None

      Set socket to listen for incoming connections

      :param ~int backlog: length of backlog queue for waiting connetions


   .. py:method:: recvfrom_into(buffer: _typing.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


   .. py:method:: recv_into(buffer: _typing.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.


   .. py:method:: send(bytes: _typing.ReadableBuffer) -> int

      Send some bytes to the connected remote address.
      Suits sockets of type SOCK_STREAM

      :param ~bytes bytes: some bytes to send


   .. py:method:: sendto(bytes: _typing.ReadableBuffer, address: Tuple[str, int]) -> 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)


   .. py:method:: setblocking(flag: bool) -> Optional[int]

      Set the blocking behaviour of this socket.

      :param ~bool flag: False means non-blocking, True means block indefinitely.


   .. py:method:: settimeout(value: int) -> None

      Set the timeout value for this socket.

      :param ~int value: timeout in seconds.  0 means non-blocking.  None means block indefinitely.


   .. py:method:: __hash__() -> int

      Returns a hash for the Socket.



.. py:class:: SocketPool

   A pool of socket resources available for the given radio. Only one
   SocketPool can be created for each radio.

   SocketPool should be used in place of CPython's socket which provides
   a pool of sockets provided by the underlying OS.

   .. py:attribute:: AF_INET
      :annotation: :int

      

   .. py:attribute:: AF_INET6
      :annotation: :int

      

   .. py:attribute:: SOCK_STREAM
      :annotation: :int

      

   .. py:attribute:: SOCK_DGRAM
      :annotation: :int

      

   .. py:attribute:: SOCK_RAW
      :annotation: :int

      

   .. py:method:: socket(family: int = AF_INET, type: int = SOCK_STREAM) -> Socket

      Create a new socket

      :param ~int family: AF_INET or AF_INET6
      :param ~int type: SOCK_STREAM, SOCK_DGRAM or SOCK_RAW

      The ``proto`` (protocol) and ``fileno`` arguments available in ``socket.socket()``
      in CPython are not supported.



.. py:function:: getaddrinfo(host: str, port: int, family: int = 0, type: int = 0, proto: int = 0, flags: int = 0) -> Tuple[int, int, int, str, Tuple[str, int]]

   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.