Home | Trees | Index | Help |
---|
Package paramiko :: Module buffered_pipe :: Class BufferedPipe |
|
object
--+
|
BufferedPipe
Channel
.
Method Summary | |
---|---|
__init__(self)
| |
int |
Return the number of bytes buffered. |
Close this pipe object. | |
str |
Clear out the buffer and return all data that was in it. |
Feed new data into this pipe. | |
str |
Read data from the pipe. |
bool |
Returns true if data is buffered and ready to be read from this feeder. |
Set an event on this buffer. | |
Inherited from object | |
x.__delattr__('name') <==> del x.name | |
x.__getattribute__('name') <==> x.name | |
x.__hash__() <==> hash(x) | |
T.__new__(S, ...) -> a new object with type S, a subtype of T | |
helper for pickle | |
helper for pickle | |
x.__repr__() <==> repr(x) | |
x.__setattr__('name', value) <==> x.name = value | |
x.__str__() <==> str(x) |
Method Details |
---|
__len__(self)
Return the number of bytes buffered.
|
close(self)Close this pipe object. Future calls toread after the buffer has been emptied
will return immediately with an empty string.
|
empty(self)Clear out the buffer and return all data that was in it.
|
feed(self, data)Feed new data into this pipe. This method is assumed to be called from a separate thread, so synchronization is done.
|
read(self, nbytes, timeout=None)Read data from the pipe. The return value is a string representing
the data received. The maximum amount of data to be received at once is
specified by timeout argument can be a nonnegative
float expressing seconds, or None for no timeout. If a
float is given, a PipeTimeout will be raised if the
timeout period value has elapsed before any data arrives.
|
read_ready(self)Returns true if data is buffered and ready to be read from this feeder. AFalse result does not mean that the feeder has
closed; it means you may need to wait before more data arrives.
|
set_event(self, event)Set an event on this buffer. When data is ready to be read (or the buffer has been closed), the event will be set. When no data is ready, the event will be cleared.
|
Home | Trees | Index | Help |
---|
Generated by Epydoc 2.1 on Wed May 10 18:42:05 2006 | http://epydoc.sf.net |