|
1900
|
1 # Stubs for autobahn.websocket.protocol (Python 3)
|
|
|
2 #
|
|
|
3 # NOTE: This dynamically typed stub was automatically generated by stubgen.
|
|
|
4
|
|
|
5 from autobahn.util import ObservableMixin
|
|
|
6 from typing import Any, Optional
|
|
|
7
|
|
|
8 xrange = range
|
|
|
9
|
|
|
10 class TrafficStats:
|
|
|
11 def __init__(self) -> None: ...
|
|
|
12 outgoingOctetsWireLevel: int = ...
|
|
|
13 outgoingOctetsWebSocketLevel: int = ...
|
|
|
14 outgoingOctetsAppLevel: int = ...
|
|
|
15 outgoingWebSocketFrames: int = ...
|
|
|
16 outgoingWebSocketMessages: int = ...
|
|
|
17 incomingOctetsWireLevel: int = ...
|
|
|
18 incomingOctetsWebSocketLevel: int = ...
|
|
|
19 incomingOctetsAppLevel: int = ...
|
|
|
20 incomingWebSocketFrames: int = ...
|
|
|
21 incomingWebSocketMessages: int = ...
|
|
|
22 preopenOutgoingOctetsWireLevel: int = ...
|
|
|
23 preopenIncomingOctetsWireLevel: int = ...
|
|
|
24 def reset(self) -> None: ...
|
|
|
25 def __json__(self): ...
|
|
|
26
|
|
|
27 class FrameHeader:
|
|
|
28 opcode: Any = ...
|
|
|
29 fin: Any = ...
|
|
|
30 rsv: Any = ...
|
|
|
31 length: Any = ...
|
|
|
32 mask: Any = ...
|
|
|
33 def __init__(self, opcode: Any, fin: Any, rsv: Any, length: Any, mask: Any) -> None: ...
|
|
|
34
|
|
|
35 class Timings:
|
|
|
36 def __init__(self) -> None: ...
|
|
|
37 def track(self, key: Any) -> None: ...
|
|
|
38 def diff(self, startKey: Any, endKey: Any, formatted: bool = ...): ...
|
|
|
39 def __getitem__(self, key: Any): ...
|
|
|
40 def __iter__(self): ...
|
|
|
41
|
|
|
42 class WebSocketProtocol(ObservableMixin):
|
|
|
43 peer: str = ...
|
|
|
44 SUPPORTED_SPEC_VERSIONS: Any = ...
|
|
|
45 SUPPORTED_PROTOCOL_VERSIONS: Any = ...
|
|
|
46 SPEC_TO_PROTOCOL_VERSION: Any = ...
|
|
|
47 PROTOCOL_TO_SPEC_VERSION: Any = ...
|
|
|
48 DEFAULT_SPEC_VERSION: int = ...
|
|
|
49 MESSAGE_TYPE_TEXT: int = ...
|
|
|
50 MESSAGE_TYPE_BINARY: int = ...
|
|
|
51 STATE_CLOSED: int = ...
|
|
|
52 STATE_CONNECTING: int = ...
|
|
|
53 STATE_CLOSING: int = ...
|
|
|
54 STATE_OPEN: int = ...
|
|
|
55 STATE_PROXY_CONNECTING: int = ...
|
|
|
56 SEND_STATE_GROUND: int = ...
|
|
|
57 SEND_STATE_MESSAGE_BEGIN: int = ...
|
|
|
58 SEND_STATE_INSIDE_MESSAGE: int = ...
|
|
|
59 SEND_STATE_INSIDE_MESSAGE_FRAME: int = ...
|
|
|
60 CLOSE_STATUS_CODE_NORMAL: int = ...
|
|
|
61 CLOSE_STATUS_CODE_GOING_AWAY: int = ...
|
|
|
62 CLOSE_STATUS_CODE_PROTOCOL_ERROR: int = ...
|
|
|
63 CLOSE_STATUS_CODE_UNSUPPORTED_DATA: int = ...
|
|
|
64 CLOSE_STATUS_CODE_RESERVED1: int = ...
|
|
|
65 CLOSE_STATUS_CODE_NULL: int = ...
|
|
|
66 CLOSE_STATUS_CODE_ABNORMAL_CLOSE: int = ...
|
|
|
67 CLOSE_STATUS_CODE_INVALID_PAYLOAD: int = ...
|
|
|
68 CLOSE_STATUS_CODE_POLICY_VIOLATION: int = ...
|
|
|
69 CLOSE_STATUS_CODE_MESSAGE_TOO_BIG: int = ...
|
|
|
70 CLOSE_STATUS_CODE_MANDATORY_EXTENSION: int = ...
|
|
|
71 CLOSE_STATUS_CODE_INTERNAL_ERROR: int = ...
|
|
|
72 CLOSE_STATUS_CODE_SERVICE_RESTART: int = ...
|
|
|
73 CLOSE_STATUS_CODE_TRY_AGAIN_LATER: int = ...
|
|
|
74 CLOSE_STATUS_CODE_UNASSIGNED1: int = ...
|
|
|
75 CLOSE_STATUS_CODE_TLS_HANDSHAKE_FAILED: int = ...
|
|
|
76 CLOSE_STATUS_CODES_ALLOWED: Any = ...
|
|
|
77 CONFIG_ATTRS_COMMON: Any = ...
|
|
|
78 CONFIG_ATTRS_SERVER: Any = ...
|
|
|
79 CONFIG_ATTRS_CLIENT: Any = ...
|
|
|
80 is_closed: Any = ...
|
|
|
81 is_open: Any = ...
|
|
|
82 def __init__(self) -> None: ...
|
|
|
83 def onOpen(self) -> None: ...
|
|
|
84 message_is_binary: Any = ...
|
|
|
85 message_data: Any = ...
|
|
|
86 message_data_total_length: int = ...
|
|
|
87 def onMessageBegin(self, isBinary: Any) -> None: ...
|
|
|
88 frame_length: Any = ...
|
|
|
89 frame_data: Any = ...
|
|
|
90 wasMaxMessagePayloadSizeExceeded: bool = ...
|
|
|
91 wasMaxFramePayloadSizeExceeded: bool = ...
|
|
|
92 def onMessageFrameBegin(self, length: Any) -> None: ...
|
|
|
93 def onMessageFrameData(self, payload: Any) -> None: ...
|
|
|
94 def onMessageFrameEnd(self) -> None: ...
|
|
|
95 def onMessageFrame(self, payload: Any) -> None: ...
|
|
|
96 def onMessageEnd(self) -> None: ...
|
|
|
97 def onMessage(self, payload: Any, isBinary: Any) -> None: ...
|
|
|
98 def onPing(self, payload: Any) -> None: ...
|
|
|
99 def onPong(self, payload: Any) -> None: ...
|
|
|
100 def onClose(self, wasClean: Any, code: Any, reason: Any) -> None: ...
|
|
|
101 remoteCloseCode: Any = ...
|
|
|
102 remoteCloseReason: Any = ...
|
|
|
103 closeHandshakeTimeoutCall: Any = ...
|
|
|
104 wasClean: bool = ...
|
|
|
105 serverConnectionDropTimeoutCall: Any = ...
|
|
|
106 def onCloseFrame(self, code: Any, reasonRaw: Any): ...
|
|
|
107 wasNotCleanReason: str = ...
|
|
|
108 wasServerConnectionDropTimeout: bool = ...
|
|
|
109 def onServerConnectionDropTimeout(self) -> None: ...
|
|
|
110 openHandshakeTimeoutCall: Any = ...
|
|
|
111 wasOpenHandshakeTimeout: bool = ...
|
|
|
112 def onOpenHandshakeTimeout(self) -> None: ...
|
|
|
113 wasCloseHandshakeTimeout: bool = ...
|
|
|
114 def onCloseHandshakeTimeout(self) -> None: ...
|
|
|
115 autoPingTimeoutCall: Any = ...
|
|
|
116 def onAutoPingTimeout(self) -> None: ...
|
|
|
117 droppedByMe: bool = ...
|
|
|
118 state: Any = ...
|
|
|
119 def dropConnection(self, abort: bool = ...) -> None: ...
|
|
|
120 trackTimings: Any = ...
|
|
|
121 trackedTimings: Any = ...
|
|
|
122 def setTrackTimings(self, enable: Any) -> None: ...
|
|
|
123 def logRxOctets(self, data: Any) -> None: ...
|
|
|
124 def logTxOctets(self, data: Any, sync: Any) -> None: ...
|
|
|
125 def logRxFrame(self, frameHeader: Any, payload: Any) -> None: ...
|
|
|
126 def logTxFrame(self, frameHeader: Any, payload: Any, repeatLength: Any, chopsize: Any, sync: Any) -> None: ...
|
|
|
127 def consumeData(self) -> None: ...
|
|
|
128 def processProxyConnect(self) -> None: ...
|
|
|
129 def processHandshake(self) -> None: ...
|
|
|
130 def sendData(self, data: Any, sync: bool = ..., chopsize: Optional[Any] = ...) -> None: ...
|
|
|
131 def sendPreparedMessage(self, preparedMsg: Any) -> None: ...
|
|
|
132 current_frame_masker: Any = ...
|
|
|
133 data: Any = ...
|
|
|
134 current_frame: Any = ...
|
|
|
135 def processData(self): ...
|
|
|
136 control_frame_data: Any = ...
|
|
|
137 inside_message: bool = ...
|
|
|
138 utf8validateIncomingCurrentMessage: bool = ...
|
|
|
139 utf8validateLast: Any = ...
|
|
|
140 def onFrameBegin(self) -> None: ...
|
|
|
141 def onFrameData(self, payload: Any): ...
|
|
|
142 def onFrameEnd(self): ...
|
|
|
143 autoPingPending: Any = ...
|
|
|
144 autoPingPendingCall: Any = ...
|
|
|
145 def processControlFrame(self): ...
|
|
|
146 def sendFrame(self, opcode: Any, payload: bytes = ..., fin: bool = ..., rsv: int = ..., mask: Optional[Any] = ..., payload_len: Optional[Any] = ..., chopsize: Optional[Any] = ..., sync: bool = ...) -> None: ...
|
|
|
147 def sendPing(self, payload: Optional[Any] = ...) -> None: ...
|
|
|
148 def sendPong(self, payload: Optional[Any] = ...) -> None: ...
|
|
|
149 closedByMe: Any = ...
|
|
|
150 localCloseCode: Any = ...
|
|
|
151 localCloseReason: Any = ...
|
|
|
152 def sendCloseFrame(self, code: Optional[Any] = ..., reasonUtf8: Optional[Any] = ..., isReply: bool = ...) -> None: ...
|
|
|
153 def sendClose(self, code: Optional[Any] = ..., reason: Optional[Any] = ...) -> None: ...
|
|
|
154 send_message_opcode: Any = ...
|
|
|
155 send_state: Any = ...
|
|
|
156 send_compressed: bool = ...
|
|
|
157 def beginMessage(self, isBinary: bool = ..., doNotCompress: bool = ...) -> None: ...
|
|
|
158 send_message_frame_length: Any = ...
|
|
|
159 send_message_frame_mask: Any = ...
|
|
|
160 send_message_frame_masker: Any = ...
|
|
|
161 def beginMessageFrame(self, length: Any) -> None: ...
|
|
|
162 def sendMessageFrameData(self, payload: Any, sync: bool = ...): ...
|
|
|
163 def endMessage(self) -> None: ...
|
|
|
164 def sendMessageFrame(self, payload: Any, sync: bool = ...) -> None: ...
|
|
|
165 def sendMessage(self, payload: Any, isBinary: bool = ..., fragmentSize: Optional[Any] = ..., sync: bool = ..., doNotCompress: bool = ...) -> None: ...
|
|
|
166
|
|
|
167 class PreparedMessage:
|
|
|
168 payload: Any = ...
|
|
|
169 binary: Any = ...
|
|
|
170 doNotCompress: Any = ...
|
|
|
171 payloadHybi: Any = ...
|
|
|
172 def __init__(self, payload: Any, isBinary: Any, applyMask: Any, doNotCompress: Any) -> None: ...
|
|
|
173
|
|
|
174 class WebSocketFactory:
|
|
|
175 def prepareMessage(self, payload: Any, isBinary: bool = ..., doNotCompress: bool = ...): ...
|
|
|
176
|
|
|
177 class WebSocketServerProtocol(WebSocketProtocol):
|
|
|
178 log: Any = ...
|
|
|
179 CONFIG_ATTRS: Any = ...
|
|
|
180 def onConnect(self, request: Any) -> None: ...
|
|
|
181 def processProxyConnect(self) -> None: ...
|
|
|
182 http_request_data: Any = ...
|
|
|
183 peer: Any = ...
|
|
|
184 http_request_uri: Any = ...
|
|
|
185 http_request_path: Any = ...
|
|
|
186 http_request_params: Any = ...
|
|
|
187 http_request_host: Any = ...
|
|
|
188 websocket_version: Any = ...
|
|
|
189 websocket_protocols: Any = ...
|
|
|
190 websocket_origin: str = ...
|
|
|
191 websocket_extensions: Any = ...
|
|
|
192 data: Any = ...
|
|
|
193 wasServingFlashSocketPolicyFile: bool = ...
|
|
|
194 def processHandshake(self): ...
|
|
|
195 websocket_protocol_in_use: Any = ...
|
|
|
196 websocket_extensions_in_use: Any = ...
|
|
|
197 http_response_data: Any = ...
|
|
|
198 state: Any = ...
|
|
|
199 openHandshakeTimeoutCall: Any = ...
|
|
|
200 inside_message: bool = ...
|
|
|
201 current_frame: Any = ...
|
|
|
202 autoPingPendingCall: Any = ...
|
|
|
203 def succeedHandshake(self, res: Any): ...
|
|
|
204 wasNotCleanReason: Any = ...
|
|
|
205 def failHandshake(self, reason: Any, code: int = ..., responseHeaders: Optional[Any] = ...) -> None: ...
|
|
|
206 def sendHttpErrorResponse(self, code: Any, reason: Any, responseHeaders: Optional[Any] = ...) -> None: ...
|
|
|
207 def sendHtml(self, html: Any) -> None: ...
|
|
|
208 def sendRedirect(self, url: Any) -> None: ...
|
|
|
209 def sendServerStatus(self, redirectUrl: Optional[Any] = ..., redirectAfter: int = ...) -> None: ...
|
|
|
210
|
|
|
211 class WebSocketServerFactory(WebSocketFactory):
|
|
|
212 log: Any = ...
|
|
|
213 protocol: Any = ...
|
|
|
214 isServer: bool = ...
|
|
|
215 logOctets: bool = ...
|
|
|
216 logFrames: bool = ...
|
|
|
217 trackTimings: bool = ...
|
|
|
218 countConnections: int = ...
|
|
|
219 def __init__(self, url: Optional[Any] = ..., protocols: Optional[Any] = ..., server: Any = ..., headers: Optional[Any] = ..., externalPort: Optional[Any] = ...) -> None: ...
|
|
|
220 url: Any = ...
|
|
|
221 isSecure: Any = ...
|
|
|
222 host: Any = ...
|
|
|
223 port: Any = ...
|
|
|
224 resource: Any = ...
|
|
|
225 path: Any = ...
|
|
|
226 params: Any = ...
|
|
|
227 protocols: Any = ...
|
|
|
228 server: Any = ...
|
|
|
229 headers: Any = ...
|
|
|
230 externalPort: Any = ...
|
|
|
231 def setSessionParameters(self, url: Optional[Any] = ..., protocols: Optional[Any] = ..., server: Optional[Any] = ..., headers: Optional[Any] = ..., externalPort: Optional[Any] = ...) -> None: ...
|
|
|
232 versions: Any = ...
|
|
|
233 webStatus: bool = ...
|
|
|
234 utf8validateIncoming: bool = ...
|
|
|
235 requireMaskedClientFrames: bool = ...
|
|
|
236 maskServerFrames: bool = ...
|
|
|
237 applyMask: bool = ...
|
|
|
238 maxFramePayloadSize: int = ...
|
|
|
239 maxMessagePayloadSize: int = ...
|
|
|
240 autoFragmentSize: int = ...
|
|
|
241 failByDrop: bool = ...
|
|
|
242 echoCloseCodeReason: bool = ...
|
|
|
243 openHandshakeTimeout: int = ...
|
|
|
244 closeHandshakeTimeout: int = ...
|
|
|
245 tcpNoDelay: bool = ...
|
|
|
246 serveFlashSocketPolicy: bool = ...
|
|
|
247 flashSocketPolicy: str = ...
|
|
|
248 perMessageCompressionAccept: Any = ...
|
|
|
249 autoPingInterval: int = ...
|
|
|
250 autoPingTimeout: int = ...
|
|
|
251 autoPingSize: int = ...
|
|
|
252 allowedOrigins: Any = ...
|
|
|
253 allowedOriginsPatterns: Any = ...
|
|
|
254 allowNullOrigin: bool = ...
|
|
|
255 maxConnections: int = ...
|
|
|
256 trustXForwardedFor: int = ...
|
|
|
257 def resetProtocolOptions(self) -> None: ...
|
|
|
258 def setProtocolOptions(self, versions: Optional[Any] = ..., webStatus: Optional[Any] = ..., utf8validateIncoming: Optional[Any] = ..., maskServerFrames: Optional[Any] = ..., requireMaskedClientFrames: Optional[Any] = ..., applyMask: Optional[Any] = ..., maxFramePayloadSize: Optional[Any] = ..., maxMessagePayloadSize: Optional[Any] = ..., autoFragmentSize: Optional[Any] = ..., failByDrop: Optional[Any] = ..., echoCloseCodeReason: Optional[Any] = ..., openHandshakeTimeout: Optional[Any] = ..., closeHandshakeTimeout: Optional[Any] = ..., tcpNoDelay: Optional[Any] = ..., perMessageCompressionAccept: Optional[Any] = ..., autoPingInterval: Optional[Any] = ..., autoPingTimeout: Optional[Any] = ..., autoPingSize: Optional[Any] = ..., serveFlashSocketPolicy: Optional[Any] = ..., flashSocketPolicy: Optional[Any] = ..., allowedOrigins: Optional[Any] = ..., allowNullOrigin: bool = ..., maxConnections: Optional[Any] = ..., trustXForwardedFor: Optional[Any] = ...) -> None: ...
|
|
|
259 def getConnectionCount(self): ...
|
|
|
260
|
|
|
261 class WebSocketClientProtocol(WebSocketProtocol):
|
|
|
262 log: Any = ...
|
|
|
263 CONFIG_ATTRS: Any = ...
|
|
|
264 def onConnecting(self, transport_details: Any) -> None: ...
|
|
|
265 def onConnect(self, response: Any) -> None: ...
|
|
|
266 def startProxyConnect(self) -> None: ...
|
|
|
267 data: Any = ...
|
|
|
268 state: Any = ...
|
|
|
269 def processProxyConnect(self): ...
|
|
|
270 def failProxyConnect(self, reason: Any) -> None: ...
|
|
|
271 def startHandshake(self): ...
|
|
|
272 http_response_data: Any = ...
|
|
|
273 websocket_extensions_in_use: Any = ...
|
|
|
274 websocket_protocol_in_use: Any = ...
|
|
|
275 openHandshakeTimeoutCall: Any = ...
|
|
|
276 inside_message: bool = ...
|
|
|
277 current_frame: Any = ...
|
|
|
278 websocket_version: Any = ...
|
|
|
279 autoPingPendingCall: Any = ...
|
|
|
280 def processHandshake(self): ...
|
|
|
281 wasNotCleanReason: Any = ...
|
|
|
282 def failHandshake(self, reason: Any) -> None: ...
|
|
|
283
|
|
|
284 class WebSocketClientFactory(WebSocketFactory):
|
|
|
285 log: Any = ...
|
|
|
286 protocol: Any = ...
|
|
|
287 isServer: bool = ...
|
|
|
288 logOctets: bool = ...
|
|
|
289 logFrames: bool = ...
|
|
|
290 trackTimings: bool = ...
|
|
|
291 def __init__(self, url: Optional[Any] = ..., origin: Optional[Any] = ..., protocols: Optional[Any] = ..., useragent: Any = ..., headers: Optional[Any] = ..., proxy: Optional[Any] = ...) -> None: ...
|
|
|
292 url: Any = ...
|
|
|
293 isSecure: Any = ...
|
|
|
294 host: Any = ...
|
|
|
295 port: Any = ...
|
|
|
296 resource: Any = ...
|
|
|
297 path: Any = ...
|
|
|
298 params: Any = ...
|
|
|
299 origin: Any = ...
|
|
|
300 protocols: Any = ...
|
|
|
301 useragent: Any = ...
|
|
|
302 headers: Any = ...
|
|
|
303 proxy: Any = ...
|
|
|
304 def setSessionParameters(self, url: Optional[Any] = ..., origin: Optional[Any] = ..., protocols: Optional[Any] = ..., useragent: Optional[Any] = ..., headers: Optional[Any] = ..., proxy: Optional[Any] = ...) -> None: ...
|
|
|
305 version: Any = ...
|
|
|
306 utf8validateIncoming: bool = ...
|
|
|
307 acceptMaskedServerFrames: bool = ...
|
|
|
308 maskClientFrames: bool = ...
|
|
|
309 applyMask: bool = ...
|
|
|
310 maxFramePayloadSize: int = ...
|
|
|
311 maxMessagePayloadSize: int = ...
|
|
|
312 autoFragmentSize: int = ...
|
|
|
313 failByDrop: bool = ...
|
|
|
314 echoCloseCodeReason: bool = ...
|
|
|
315 serverConnectionDropTimeout: int = ...
|
|
|
316 openHandshakeTimeout: int = ...
|
|
|
317 closeHandshakeTimeout: int = ...
|
|
|
318 tcpNoDelay: bool = ...
|
|
|
319 perMessageCompressionOffers: Any = ...
|
|
|
320 perMessageCompressionAccept: Any = ...
|
|
|
321 autoPingInterval: int = ...
|
|
|
322 autoPingTimeout: int = ...
|
|
|
323 autoPingSize: int = ...
|
|
|
324 def resetProtocolOptions(self) -> None: ...
|
|
|
325 def setProtocolOptions(self, version: Optional[Any] = ..., utf8validateIncoming: Optional[Any] = ..., acceptMaskedServerFrames: Optional[Any] = ..., maskClientFrames: Optional[Any] = ..., applyMask: Optional[Any] = ..., maxFramePayloadSize: Optional[Any] = ..., maxMessagePayloadSize: Optional[Any] = ..., autoFragmentSize: Optional[Any] = ..., failByDrop: Optional[Any] = ..., echoCloseCodeReason: Optional[Any] = ..., serverConnectionDropTimeout: Optional[Any] = ..., openHandshakeTimeout: Optional[Any] = ..., closeHandshakeTimeout: Optional[Any] = ..., tcpNoDelay: Optional[Any] = ..., perMessageCompressionOffers: Optional[Any] = ..., perMessageCompressionAccept: Optional[Any] = ..., autoPingInterval: Optional[Any] = ..., autoPingTimeout: Optional[Any] = ..., autoPingSize: Optional[Any] = ...) -> None: ...
|
