|
1900
|
1 # Stubs for autobahn.websocket.interfaces (Python 3)
|
|
|
2 #
|
|
|
3 # NOTE: This dynamically typed stub was automatically generated by stubgen.
|
|
|
4
|
|
|
5 import abc
|
|
|
6 from typing import Any, Optional
|
|
|
7
|
|
|
8 class IWebSocketClientAgent(metaclass=abc.ABCMeta):
|
|
|
9 def open(self, transport_config: Any, options: Any, protocol_class: Optional[Any] = ...) -> None: ...
|
|
|
10
|
|
|
11 class IWebSocketServerChannelFactory(metaclass=abc.ABCMeta):
|
|
|
12 @abc.abstractmethod
|
|
|
13 def __init__(self, url: Optional[Any] = ..., protocols: Optional[Any] = ..., server: Optional[Any] = ..., headers: Optional[Any] = ..., externalPort: Optional[Any] = ...): ...
|
|
|
14 @abc.abstractmethod
|
|
|
15 def setSessionParameters(self, url: Optional[Any] = ..., protocols: Optional[Any] = ..., server: Optional[Any] = ..., headers: Optional[Any] = ..., externalPort: Optional[Any] = ...) -> Any: ...
|
|
|
16 @abc.abstractmethod
|
|
|
17 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: int = ...) -> Any: ...
|
|
|
18 @abc.abstractmethod
|
|
|
19 def resetProtocolOptions(self) -> Any: ...
|
|
|
20
|
|
|
21 class IWebSocketClientChannelFactory(metaclass=abc.ABCMeta):
|
|
|
22 @abc.abstractmethod
|
|
|
23 def __init__(self, url: Optional[Any] = ..., origin: Optional[Any] = ..., protocols: Optional[Any] = ..., useragent: Optional[Any] = ..., headers: Optional[Any] = ..., proxy: Optional[Any] = ...): ...
|
|
|
24 @abc.abstractmethod
|
|
|
25 def setSessionParameters(self, url: Optional[Any] = ..., origin: Optional[Any] = ..., protocols: Optional[Any] = ..., useragent: Optional[Any] = ..., headers: Optional[Any] = ..., proxy: Optional[Any] = ...) -> Any: ...
|
|
|
26 @abc.abstractmethod
|
|
|
27 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] = ...) -> Any: ...
|
|
|
28 @abc.abstractmethod
|
|
|
29 def resetProtocolOptions(self) -> Any: ...
|
|
|
30
|
|
|
31 class IWebSocketChannel(metaclass=abc.ABCMeta):
|
|
|
32 @abc.abstractmethod
|
|
|
33 def onConnect(self, request_or_response: Any) -> Any: ...
|
|
|
34 @abc.abstractmethod
|
|
|
35 def onConnecting(self, transport_details: Any) -> Any: ...
|
|
|
36 @abc.abstractmethod
|
|
|
37 def onOpen(self) -> Any: ...
|
|
|
38 @abc.abstractmethod
|
|
|
39 def sendMessage(self, payload: Any, isBinary: Any) -> Any: ...
|
|
|
40 @abc.abstractmethod
|
|
|
41 def onMessage(self, payload: Any, isBinary: Any) -> Any: ...
|
|
|
42 @abc.abstractmethod
|
|
|
43 def sendClose(self, code: Optional[Any] = ..., reason: Optional[Any] = ...) -> Any: ...
|
|
|
44 @abc.abstractmethod
|
|
|
45 def onClose(self, wasClean: Any, code: Any, reason: Any) -> Any: ...
|
|
|
46 @abc.abstractmethod
|
|
|
47 def sendPing(self, payload: Optional[Any] = ...) -> Any: ...
|
|
|
48 @abc.abstractmethod
|
|
|
49 def onPing(self, payload: Any) -> Any: ...
|
|
|
50 @abc.abstractmethod
|
|
|
51 def sendPong(self, payload: Optional[Any] = ...) -> Any: ...
|
|
|
52 @abc.abstractmethod
|
|
|
53 def onPong(self, payload: Any) -> Any: ...
|
|
|
54
|
|
|
55 class IWebSocketChannelFrameApi(IWebSocketChannel, metaclass=abc.ABCMeta):
|
|
|
56 @abc.abstractmethod
|
|
|
57 def onMessageBegin(self, isBinary: Any) -> Any: ...
|
|
|
58 @abc.abstractmethod
|
|
|
59 def onMessageFrame(self, payload: Any) -> Any: ...
|
|
|
60 @abc.abstractmethod
|
|
|
61 def onMessageEnd(self) -> Any: ...
|
|
|
62 @abc.abstractmethod
|
|
|
63 def beginMessage(self, isBinary: bool = ..., doNotCompress: bool = ...) -> Any: ...
|
|
|
64 @abc.abstractmethod
|
|
|
65 def sendMessageFrame(self, payload: Any, sync: bool = ...) -> Any: ...
|
|
|
66 @abc.abstractmethod
|
|
|
67 def endMessage(self) -> Any: ...
|
|
|
68
|
|
|
69 class IWebSocketChannelStreamingApi(IWebSocketChannelFrameApi, metaclass=abc.ABCMeta):
|
|
|
70 @abc.abstractmethod
|
|
|
71 def onMessageFrameBegin(self, length: Any) -> Any: ...
|
|
|
72 @abc.abstractmethod
|
|
|
73 def onMessageFrameData(self, payload: Any) -> Any: ...
|
|
|
74 @abc.abstractmethod
|
|
|
75 def onMessageFrameEnd(self) -> Any: ...
|
|
|
76 @abc.abstractmethod
|
|
|
77 def beginMessageFrame(self, length: Any) -> Any: ...
|
|
|
78 @abc.abstractmethod
|
|
|
79 def sendMessageFrameData(self, payload: Any, sync: bool = ...) -> Any: ...
|
