U
    gJ                     @  sl   d dl mZ d dlmZ ddlmZ ddlmZmZ dddgZG d	d dZ	G d
d dZ
G dd dZdS )    )annotations)Sequence   )Frame)ExtensionNameExtensionParameter	ExtensionClientExtensionFactoryServerExtensionFactoryc                   @  sB   e Zd ZU dZded< ddddddd	d
ZdddddZdS )r   z%
    Base class for extensions.

    r   nameN)max_sizer   z
int | None)framer   returnc                C  s   t dS )a  
        Decode an incoming frame.

        Args:
            frame: Incoming frame.
            max_size: Maximum payload size in bytes.

        Returns:
            Decoded frame.

        Raises:
            PayloadTooBig: If decoding the payload exceeds ``max_size``.

        NNotImplementedError)selfr   r    r   >/tmp/pip-unpacked-wheel-dx_q7dq3/websockets/extensions/base.pydecode   s    zExtension.decode)r   r   c                 C  s   t dS )z
        Encode an outgoing frame.

        Args:
            frame: Outgoing frame.

        Returns:
            Encoded frame.

        Nr   )r   r   r   r   r   encode&   s    zExtension.encode)__name__
__module____qualname____doc____annotations__r   r   r   r   r   r   r      s   
c                   @  s:   e Zd ZU dZded< ddddZdd	d
dddZdS )r	   z:
    Base class for client-side extension factories.

    r   r   zlist[ExtensionParameter])r   c                 C  s   t dS )z
        Build parameters to send to the server for this extension.

        Returns:
            Parameters to send to the server.

        Nr   )r   r   r   r   get_request_params=   s    z)ClientExtensionFactory.get_request_paramsSequence[ExtensionParameter]Sequence[Extension]r   paramsaccepted_extensionsr   c                 C  s   t dS )ah  
        Process parameters received from the server.

        Args:
            params: Parameters received from the server for this extension.
            accepted_extensions: List of previously accepted extensions.

        Returns:
            An extension instance.

        Raises:
            NegotiationError: If parameters aren't acceptable.

        Nr   r   r   r    r   r   r   process_response_paramsG   s    z.ClientExtensionFactory.process_response_paramsN)r   r   r   r   r   r   r"   r   r   r   r   r	   4   s   

c                   @  s,   e Zd ZU dZded< dddddd	Zd
S )r
   z:
    Base class for server-side extension factories.

    r   r   r   r   z*tuple[list[ExtensionParameter], Extension]r   c                 C  s   t dS )a  
        Process parameters received from the client.

        Args:
            params: Parameters received from the client for this extension.
            accepted_extensions: List of previously accepted extensions.

        Returns:
            To accept the offer, parameters to send to the client for this
            extension and an extension instance.

        Raises:
            NegotiationError: To reject the offer, if parameters received from
                the client aren't acceptable.

        Nr   r!   r   r   r   process_request_paramsf   s    z-ServerExtensionFactory.process_request_paramsN)r   r   r   r   r   r#   r   r   r   r   r
   ]   s   
N)
__future__r   typingr   framesr   r   r   __all__r   r	   r
   r   r   r   r   <module>   s   
()