3
P\ @ sz d Z ddlZddlZddlZddlZddlmZ ddlmZ ddlmZ ddl m
Z G dd d ej Z
G d
d d e
ZdS ) z/The implementation of the SocketOptionsAdapter. N)adapters )
connection) poolmanager)
exceptionsc sd e Zd ZdZedk r0eejdejej dfgZ
ng Z
e j e
jd fddZd fd d
Z ZS ) SocketOptionsAdapterad An adapter for requests that allows users to specify socket options.
Since version 2.4.0 of requests, it is possible to specify a custom list
of socket options that need to be set before establishing the connection.
Example usage::
>>> import socket
>>> import requests
>>> from requests_toolbelt.adapters import socket_options
>>> s = requests.Session()
>>> opts = [(socket.IPPROTO_TCP, socket.TCP_NODELAY, 0)]
>>> adapter = socket_options.SocketOptionsAdapter(socket_options=opts)
>>> s.mount('http://', adapter)
You can also take advantage of the list of default options on this class
to keep using the original options in addition to your custom options. In
that case, ``opts`` might look like::
>>> opts = socket_options.SocketOptionsAdapter.default_options + opts
NZdefault_socket_options zThis version of Requests is only compatible with a version of urllib3 which is too old to support setting options on a socket. This adapter is functionally useless.c s& |j d| j| _tt| jf | d S )Nsocket_options)popdefault_optionsr superr __init__)selfkwargs) __class__ $/usr/lib/python3.6/socket_options.pyr
5 s
z SocketOptionsAdapter.__init__Fc s: t jdkr"tj|||| jd| _ntt| j||| d S )Ni )Z num_poolsmaxsizeblockr )requestsZ __build__r Z PoolManagerr r r init_poolmanager)r Z connectionsr r )r r r r ; s
z%SocketOptionsAdapter.init_poolmanager)F)__name__
__module__ __qualname____doc__r getattrZHTTPConnectionsocket IPPROTO_TCPZ TCP_NODELAYr warningswarnexcZRequestsVersionTooOldr
r
__classcell__r r )r r r s r c s e Zd ZdZ fddZ ZS )TCPKeepAliveAdapteraJ An adapter for requests that turns on TCP Keep-Alive by default.
The adapter sets 4 socket options:
- ``SOL_SOCKET`` ``SO_KEEPALIVE`` - This turns on TCP Keep-Alive
- ``IPPROTO_TCP`` ``TCP_KEEPINTVL`` 20 - Sets the keep alive interval
- ``IPPROTO_TCP`` ``TCP_KEEPCNT`` 5 - Sets the number of keep alive probes
- ``IPPROTO_TCP`` ``TCP_KEEPIDLE`` 60 - Sets the keep alive time if the
socket library has the ``TCP_KEEPIDLE`` constant
The latter three can be overridden by keyword arguments (respectively):
- ``idle``
- ``interval``
- ``count``
You can use this adapter like so::
>>> from requests_toolbelt.adapters import socket_options
>>> tcp = socket_options.TCPKeepAliveAdapter(idle=120, interval=10)
>>> s = requests.Session()
>>> s.mount('http://', tcp)
c s |j dtj}|j dd}|j dd}|j dd}|tjtjdfg }ttd d d k rl|tjtj|fg7 }n(t j
d
krttd d }|tj||fg7 }ttd
d d k r|tjtj |fg7 }ttdd d k r|tjtj |fg7 }t
t| jf d|i| d S )Nr idle< interval count r
TCP_KEEPINTVLdarwin
TCP_KEEPALIVE TCP_KEEPCNT TCP_KEEPIDLE)r
r r r Z
SOL_SOCKETZ SO_KEEPALIVEr r r) sysplatformr- r. r r" r
)r r r r# r% r' r+ )r r r r
d s&
z TCPKeepAliveAdapter.__init__)r r r r r
r! r r )r r r" J s r" )r r r r/ r r Z_compatr r r r Z HTTPAdapterr r" r r r r s ;