read¶
-
Cauldron.ktl.procedural.
read
(service, keyword, *args, **kwargs) [edit on github]¶ Perform a ktl_read() operation for this keyword.
The default behavior is to do a blocking read and return the ascii representation of the keyword value. If
binary
is set to True, only the binary representation will be returned; Ifboth
is set to True, both representations will be returned in a (binary, ascii) tuple. Ifwait
is set to False, the KTL read operation will be performed in a background thread, and any resulting updates would trigger any callbacks registered viacallback()
. If atimeout
is specified (in seconds), and wait is set to True,read()
will raise a TimeoutException if the timeout expires before a response is received.This is an abstract method. Backends must implement this method