# {py:mod}`arelle.SocketUtils`

```{py:module} arelle.SocketUtils
```

```{autodoc2-docstring} arelle.SocketUtils
:allowtitles:
```

## Module Contents

### Classes

````{list-table}
:class: autosummary longtable
:align: left

* - {py:obj}`WarnSocket <arelle.SocketUtils.WarnSocket>`
  - ```{autodoc2-docstring} arelle.SocketUtils.WarnSocket
    :summary:
    ```
````

### Functions

````{list-table}
:class: autosummary longtable
:align: left

* - {py:obj}`warnSocket <arelle.SocketUtils.warnSocket>`
  - ```{autodoc2-docstring} arelle.SocketUtils.warnSocket
    :summary:
    ```
````

### Data

````{list-table}
:class: autosummary longtable
:align: left

* - {py:obj}`INTERNET_CONNECTIVITY <arelle.SocketUtils.INTERNET_CONNECTIVITY>`
  - ```{autodoc2-docstring} arelle.SocketUtils.INTERNET_CONNECTIVITY
    :summary:
    ```
* - {py:obj}`OFFLINE <arelle.SocketUtils.OFFLINE>`
  - ```{autodoc2-docstring} arelle.SocketUtils.OFFLINE
    :summary:
    ```
````

### API

````{py:data} INTERNET_CONNECTIVITY
:canonical: arelle.SocketUtils.INTERNET_CONNECTIVITY
:value: >
   'internetConnectivity'

```{autodoc2-docstring} arelle.SocketUtils.INTERNET_CONNECTIVITY
```

````

````{py:data} OFFLINE
:canonical: arelle.SocketUtils.OFFLINE
:value: >
   'offline'

```{autodoc2-docstring} arelle.SocketUtils.OFFLINE
```

````

`````{py:class} WarnSocket(family: int = -1, type: int = -1, proto: int = -1, fileno: int | None = None)
:canonical: arelle.SocketUtils.WarnSocket

Bases: {py:obj}`socket.socket`

```{autodoc2-docstring} arelle.SocketUtils.WarnSocket
```

```{rubric} Initialization
```

```{autodoc2-docstring} arelle.SocketUtils.WarnSocket.__init__
```

````{py:method} bind()
:canonical: arelle.SocketUtils.WarnSocket.bind

````

````{py:method} close()
:canonical: arelle.SocketUtils.WarnSocket.close

````

````{py:method} connect()
:canonical: arelle.SocketUtils.WarnSocket.connect

````

````{py:method} connect_ex()
:canonical: arelle.SocketUtils.WarnSocket.connect_ex

````

````{py:method} detach()
:canonical: arelle.SocketUtils.WarnSocket.detach

````

```{py:class} family
:canonical: arelle.SocketUtils.WarnSocket.family

```

````{py:method} fileno()
:canonical: arelle.SocketUtils.WarnSocket.fileno

````

````{py:method} getblocking()
:canonical: arelle.SocketUtils.WarnSocket.getblocking

````

````{py:method} getpeername()
:canonical: arelle.SocketUtils.WarnSocket.getpeername

````

````{py:method} getsockname()
:canonical: arelle.SocketUtils.WarnSocket.getsockname

````

````{py:method} getsockopt()
:canonical: arelle.SocketUtils.WarnSocket.getsockopt

````

````{py:method} gettimeout()
:canonical: arelle.SocketUtils.WarnSocket.gettimeout

````

````{py:method} listen()
:canonical: arelle.SocketUtils.WarnSocket.listen

````

```{py:class} proto
:canonical: arelle.SocketUtils.WarnSocket.proto

```

````{py:method} recv()
:canonical: arelle.SocketUtils.WarnSocket.recv

````

````{py:method} recv_into()
:canonical: arelle.SocketUtils.WarnSocket.recv_into

````

````{py:method} recvfrom()
:canonical: arelle.SocketUtils.WarnSocket.recvfrom

````

````{py:method} recvfrom_into()
:canonical: arelle.SocketUtils.WarnSocket.recvfrom_into

````

````{py:method} recvmsg()
:canonical: arelle.SocketUtils.WarnSocket.recvmsg

````

````{py:method} recvmsg_into()
:canonical: arelle.SocketUtils.WarnSocket.recvmsg_into

````

````{py:method} send()
:canonical: arelle.SocketUtils.WarnSocket.send

````

````{py:method} sendall()
:canonical: arelle.SocketUtils.WarnSocket.sendall

````

````{py:method} sendmsg()
:canonical: arelle.SocketUtils.WarnSocket.sendmsg

````

````{py:method} sendmsg_afalg()
:canonical: arelle.SocketUtils.WarnSocket.sendmsg_afalg

````

````{py:method} sendto()
:canonical: arelle.SocketUtils.WarnSocket.sendto

````

````{py:method} setblocking()
:canonical: arelle.SocketUtils.WarnSocket.setblocking

````

````{py:method} setsockopt()
:canonical: arelle.SocketUtils.WarnSocket.setsockopt

````

````{py:method} settimeout()
:canonical: arelle.SocketUtils.WarnSocket.settimeout

````

````{py:method} shutdown()
:canonical: arelle.SocketUtils.WarnSocket.shutdown

````

```{py:class} timeout
:canonical: arelle.SocketUtils.WarnSocket.timeout

```

```{py:class} type
:canonical: arelle.SocketUtils.WarnSocket.type

```

````{py:method} dup()
:canonical: arelle.SocketUtils.WarnSocket.dup

````

````{py:method} accept()
:canonical: arelle.SocketUtils.WarnSocket.accept

````

````{py:method} makefile(mode='r', buffering=None, *, encoding=None, errors=None, newline=None)
:canonical: arelle.SocketUtils.WarnSocket.makefile

````

````{py:method} sendfile(file, offset=0, count=None)
:canonical: arelle.SocketUtils.WarnSocket.sendfile

````

`````

````{py:function} warnSocket() -> None
:canonical: arelle.SocketUtils.warnSocket

```{autodoc2-docstring} arelle.SocketUtils.warnSocket
```
````