def run(self):
self.log.debug('Connection id={} is starting'.format(self.conn_id))
def wait_and_read(n_bytes):
"""
Convenience function that simplifies reading and checking for stop events, etc.
Returns a byte string of length n_bytes or None if socket needs to be closed.
"""
data = b""
while len(data) < n_bytes:
if sock.bytesAvailable() == 0:
new_data = sock.waitForReadyRead(100) # wait for 100ms between read attempts
if not new_data:
if sock.state() != sock.ConnectedState or self.need_to_stop():
return None
else:
continue
if self.need_to_stop():
return None
new_data = sock.read(n_bytes - len(data))
if type(new_data) != bytes:
new_data = new_data.data()
data += new_data
return data
sock = QTcpSocket(None)
sock.setSocketDescriptor(self.socketDescriptor)
sock.waitForConnected()
while True:
read_len = wait_and_read(4)
if not read_len:
break
read_len = struct.unpack(">L", read_len)[0]
data = wait_and_read(read_len)
if not data:
break
if data.startswith(self.internal_prefix):
self.handle_internal_command(data)
continue
try:
logDict = self.deserialize(data)
record = LogRecord(logDict)
except Exception:
self.log.error('Creating log record failed', exc_info=True)
continue
self.new_record.emit(record)
self.log.debug('Connection id={} is stopping'.format(self.conn_id))
sock.disconnectFromHost()
sock.close()
self.connection_finished.emit(self)
self.log.debug('Connection id={} has stopped'.format(self.conn_id))
def on_connection(self, device_id: int, socket_descriptor: int):
"""Create new QTcpSocket object and setup connection with client.
Args:
device_id (int): Socket ID.
socket_descriptor (int) Socket descriptor.
Note:
Emits connected signal.
"""
socket = QTcpSocket()
socket.setParent(None) # noqa
if socket.setSocketDescriptor(socket_descriptor): # noqa
socket.readyRead.connect(lambda: self.on_message(socket)) # noqa
socket.disconnected.connect(lambda: self.on_disconnected(socket)) # noqa
socket.error.connect(lambda: self.on_error(socket)) # noqa
socket.setObjectName(str(device_id))
self.sockets.append(socket)
self.__logger.debug("New connection from CLIENT-{} "
"IP: {}:{}".format(socket.objectName(),
socket.peerAddress().toString(),
socket.peerPort()))
self.connected.emit(int(socket.objectName()), socket.peerAddress().toString(), socket.peerPort())
class _SocketClient(QObject):
"""Keeps socket in separate thread.
Outgoing signals:
- disconnected (device_id: int): Client disconnected.
- connected (device_id: int, ip: str, port: int): Client connected.
- message (device_id: int, message: bytes): Message from client.
- error (device_id: int, error: str): Error occured.
- closed (): Closed successfully.
Incomming signals:
- close_signal (): Emit to close connection.
- write (device_id: int, message: bytes): Emit to send message
to client with ID in this thread.
"""
disconnected = Signal(int)
connected = Signal(int, str, int)
message = Signal(int, bytes)
error = Signal(int, str)
closed = Signal()
close_signal = Signal()
write = Signal(bytes)
def __init__(self, socket_descriptor, client_id):
super(_SocketClient, self).__init__(None)
self.socket_descriptor = socket_descriptor
self.id = int(client_id)
@Slot()
def run(self) -> None:
"""Run socket manager."""
self._logger = logging.getLogger(self.__class__.__name__) # noqa
self.data = {"size_left": 0, "data": b""} # noqa
self.socket = QTcpSocket() # noqa
self.socket.setParent(None) # noqa
self.socket.setSocketOption(QAbstractSocket.KeepAliveOption, 1)
if self.socket.setSocketDescriptor(self.socket_descriptor): # noqa
self.socket.readyRead.connect(self.on_message) # noqa
self.socket.disconnected.connect(self.on_disconnected) # noqa
self.socket.error.connect(self.on_error) # noqa
self._logger.debug("CLIENT-{} connected to {}:{}".format(self.get_id(),
self.socket.peerAddress().toString(),
self.socket.peerPort()))
self.connected.emit(self.get_id(), self.socket.peerAddress().toString(), self.socket.peerPort())
self.close_signal.connect(self.close, Qt.BlockingQueuedConnection)
self.write.connect(self._write)
@Slot()
def get_id(self) -> int:
"""Get ID of client."""
return self.id
@Slot(bytes)
def _write(self, message: bytes):
"""Send task to client.
Args:
message (bytes): Message to send.
"""
if self.socket:
message = struct.pack('!L', len(message)) + message
self.socket.write(message)
self.socket.flush()
else:
self._logger.warning("Socket not created.")
@Slot()
def on_message(self):
"""Handle socket messages.
Note:
Emits message signal.
"""
while self.socket.bytesAvailable():
size_left = self.data.get("size_left")
if size_left > 0:
message = self.socket.read(size_left)
size_left = size_left - len(message)
if size_left > 0:
self.data["size_left"] = size_left
self.data["data"] += message
else:
message = self.data.get("data") + message
self.data["size_left"] = 0
self.data["data"] = b""
self.message.emit(self.get_id(), message)
else:
header_size = struct.calcsize('!L')
header = self.socket.read(header_size)
if len(header) == 4:
msg_size = struct.unpack('!L', header)[0]
message = self.socket.read(msg_size)
if len(message) < msg_size:
msg_size = msg_size - len(message)
self.data["data"] = message
self.data["size_left"] = msg_size
else:
self.message.emit(self.get_id(), message)
@Slot()
def on_disconnected(self):
"""Handle disconnecting socket.
Note:
Emits disconnected signal.
"""
if self.socket:
try:
self._logger.info("CLIENT-{} Disconnected {}: {}:{}".format(self.get_id(), self.socket.peerName(),
self.socket.peerAddress().toString(),
self.socket.peerPort()))
self.socket.close()
self.disconnected.emit(self.get_id())
except RuntimeError:
pass
@Slot()
def on_error(self):
"""Handle socket errors
Note:
Emits error signal.
"""
e = self.socket.errorString()
self._logger.error("CLIENT-{} Error: {}".format(self.get_id(), e))
self.error.emit(self.get_id(), str(e))
@Slot()
def close(self):
"""Close connection.
Note:
Emits closed signal.
"""
self.socket.close()
self.socket.deleteLater()
self.closed.emit()