Go to the latest version of this document.

# ``twisted`.`web`.`_websocket_impl`.`_WebSocketWireProtocol``

class documentation

`class _WebSocketWireProtocol(Generic[_WSP]): (source)`

Implements interfaces: `twisted.internet.interfaces.IProtocol`

View In Hierarchy

Undocumented

Method | `attachProducer` | Undocumented
Method | `connectionLost` | Called when the connection is shut down.
Method | `connectionMade` | Called when a connection is made.
Method | `dataReceived` | Called whenever data is received.
Method | `detachProducer` | Undocumented
Method | `loseConnection` | Undocumented
Method | `makeConnection` | Make a connection to a transport and a server.
Method | `ping` | Undocumented
Method | `sendBytesMessage` | Undocumented
Method | `sendTextMessage` | Undocumented
Class Variable | `factory` | Undocumented
Instance Variable | `transport` | Undocumented
Method | `_completeConnection` | Undocumented
Method | `_rejectConnection` | Undocumented
Class Variable | `_bootstrap` | Undocumented
Class Variable | `_wsconn` | Undocumented
Class Variable | `_wsp` | Undocumented
Instance Variable | `_done` | Undocumented
Instance Variable | `_rejectResponse` | Undocumented

def attachProducer(self, producer: `IPushProducer`): (source)

Undocumented

def connectionLost(self, reason: `Failure`): (source)
from `twisted.internet.interfaces.IProtocol`

Called when the connection is shut down.

Clear any circular references here, and any external references to this Protocol. The connection has been closed. The `reason` Failure wraps a `twisted.internet.error.ConnectionDone` or `twisted.internet.error.ConnectionLost` instance (or a subclass of one of those).

def connectionMade(self): (source)
from `twisted.internet.interfaces.IProtocol`

Called when a connection is made.

This may be considered the initializer of the protocol, because it is called when the connection is completed. For clients, this is called once the connection to the server has been established; for servers, this is called after an accept() call stops blocking and a socket has been received. If you need to send any greeting or initial message, do it here.

def dataReceived(self, data: `bytes`): (source)
from `twisted.internet.interfaces.IProtocol`

Called whenever data is received.

Use this method to translate to a higher-level message. Usually, some callback will be made upon the receipt of each complete protocol message.

Please keep in mind that you will probably need to buffer some data as partial (or multiple) protocol messages may be received! We recommend that unit tests for protocols call through to this method with differing chunk sizes, down to one byte at a time.

Parameters
data:`bytes` | bytes of indeterminate length

def detachProducer(self): (source)

Undocumented

def loseConnection(self, code: `int` = 1000, reason: `str` = ''): (source)

Undocumented

def makeConnection(self, transport: `ITransport`): (source)
from `twisted.internet.interfaces.IProtocol`

Make a connection to a transport and a server.

def ping(self, payload: `bytes` = b''): (source)

Undocumented

def sendBytesMessage(self, data: `bytes`): (source)

Undocumented

def sendTextMessage(self, text: `str`): (source)

Undocumented

factory: `ProtocolFactory[_WebSocketWireProtocol[_WSP]]` = (source)

Undocumented

transport: `ITransport` = (source)

Undocumented

def _completeConnection(self): (source)

Undocumented

def _rejectConnection(self): (source)

Undocumented

_bootstrap: `_Bootstrap` = (source)

Undocumented

_wsconn: `WSConnection | Connection` = (source)

Undocumented

_wsp: `_WSP` = (source)

Undocumented

_done: `Deferred[_WSP]` = (source)

Undocumented

_rejectResponse: `Response | None` = (source)

Undocumented