Shortcuts on this page
r m x toggle line displays
j k next/prev highlighted chunk
0 (zero) top of page
1 (one) first highlighted chunk
1from __future__ import annotations
3from collections.abc import Sequence
5from ..frames import Frame
6from ..typing import ExtensionName, ExtensionParameter
9__all__ = ["Extension", "ClientExtensionFactory", "ServerExtensionFactory"]
12class Extension:
13 """
14 Base class for extensions.
16 """
18 name: ExtensionName
19 """Extension identifier."""
21 def decode(self, frame: Frame, *, max_size: int | None = None) -> Frame:
22 """
23 Decode an incoming frame.
25 Args:
26 frame: Incoming frame.
27 max_size: Maximum payload size in bytes.
29 Returns:
30 Decoded frame.
32 Raises:
33 PayloadTooBig: If decoding the payload exceeds ``max_size``.
35 """
36 raise NotImplementedError
38 def encode(self, frame: Frame) -> Frame:
39 """
40 Encode an outgoing frame.
42 Args:
43 frame: Outgoing frame.
45 Returns:
46 Encoded frame.
48 """
49 raise NotImplementedError
52class ClientExtensionFactory:
53 """
54 Base class for client-side extension factories.
56 """
58 name: ExtensionName
59 """Extension identifier."""
61 def get_request_params(self) -> Sequence[ExtensionParameter]:
62 """
63 Build parameters to send to the server for this extension.
65 Returns:
66 Parameters to send to the server.
68 """
69 raise NotImplementedError
71 def process_response_params(
72 self,
73 params: Sequence[ExtensionParameter],
74 accepted_extensions: Sequence[Extension],
75 ) -> Extension:
76 """
77 Process parameters received from the server.
79 Args:
80 params: Parameters received from the server for this extension.
81 accepted_extensions: List of previously accepted extensions.
83 Returns:
84 An extension instance.
86 Raises:
87 NegotiationError: If parameters aren't acceptable.
89 """
90 raise NotImplementedError
93class ServerExtensionFactory:
94 """
95 Base class for server-side extension factories.
97 """
99 name: ExtensionName
100 """Extension identifier."""
102 def process_request_params(
103 self,
104 params: Sequence[ExtensionParameter],
105 accepted_extensions: Sequence[Extension],
106 ) -> tuple[list[ExtensionParameter], Extension]:
107 """
108 Process parameters received from the client.
110 Args:
111 params: Parameters received from the client for this extension.
112 accepted_extensions: List of previously accepted extensions.
114 Returns:
115 To accept the offer, parameters to send to the client for this
116 extension and an extension instance.
118 Raises:
119 NegotiationError: To reject the offer, if parameters received from
120 the client aren't acceptable.
122 """
123 raise NotImplementedError