Public Member Functions
None	__init__ (self, serial.Serial serial)

threading.RLock	lock (self)

bytes	readline (self)

typing.List[bytes]	readlines (self, int hint=-1)

bytes	read_until (self, bytes terminator=b"\n", typing.Optional[int] size=None)

int	write (self, bytes data)

Protected Attributes
	_serial = serial

	_lock = threading.RLock()

Detailed Description

Wraps a `Serial` instance with a lock for synchronization.

Definition at line 111 of file _utils.py.

Constructor & Destructor Documentation

◆ init()

None microscope._utils.SharedSerial.__init__	(		self,
		serial.Serial	serial )

Definition at line 114 of file _utils.py.

    def __init__(self, serial: serial.Serial) -> None:
        self._serial = serial
        self._lock = threading.RLock()
 

Member Function Documentation

◆ lock()

threading.RLock microscope._utils.SharedSerial.lock ( self )

Definition at line 119 of file _utils.py.

    def lock(self) -> threading.RLock:
        return self._lock
 

◆ read_until()

bytes microscope._utils.SharedSerial.read_until	(		self,
		bytes	terminator = b"\n",
		typing.Optional[int]	size = None )

Definition at line 132 of file _utils.py.

    ) -> bytes:
        with self._lock:
            return self._serial.read_until(terminator, size=size)
 

◆ readline()

bytes microscope._utils.SharedSerial.readline ( self )

Definition at line 122 of file _utils.py.

    def readline(self) -> bytes:
        with self._lock:
            return self._serial.readline()
 

◆ readlines()

typing.List[bytes] microscope._utils.SharedSerial.readlines	(		self,
		int	hint = -1 )

Definition at line 126 of file _utils.py.

    def readlines(self, hint: int = -1) -> typing.List[bytes]:
        with self._lock:
            return self._serial.readlines(hint)
 

◆ write()

int microscope._utils.SharedSerial.write	(		self,
		bytes	data )

Definition at line 138 of file _utils.py.

    def write(self, data: bytes) -> int:
        with self._lock:
            return self._serial.write(data)

Member Data Documentation

◆ _lock

microscope._utils.SharedSerial._lock = threading.RLock()

protected

Definition at line 116 of file _utils.py.

◆ _serial

microscope._utils.SharedSerial._serial = serial