t.i.s.SerialPort(BaseSerialPort, abstract.FileDescriptor) : class documentation

Part of twisted.internet.serialport View Source View In Hierarchy

A select()able serial device, acting as a transport.
Method __init__ Undocumented
Method serialReadEvent Undocumented
Method write Reliably write some data.
Method serialWriteEvent Undocumented
Method connectionLost The connection was lost.

Inherited from BaseSerialPort:

Method setBaudRate Undocumented
Method inWaiting Undocumented
Method flushInput Undocumented
Method flushOutput Undocumented
Method sendBreak Undocumented
Method getDSR Undocumented
Method getCD Undocumented
Method getRI Undocumented
Method getCTS Undocumented
Method setDTR Undocumented
Method setRTS Undocumented

Inherited from FileDescriptor:

Method logPrefix Returns the default log prefix
Method writeSomeData Write as much as possible of the given data, immediately.
Method doRead Called when data is avaliable for reading.
Method doWrite Called when data can be written.
Method writeConnectionLost Indicates write connection was lost.
Method readConnectionLost Indicates read connection was lost.
Method writeSequence Reliably write a sequence of data.
Method loseConnection Close the connection at the next available opportunity.
Method loseWriteConnection Undocumented
Method stopReading Stop waiting for read availability.
Method stopWriting Stop waiting for write availability.
Method startReading Start waiting for read availability.
Method startWriting Start waiting for write availability.
Method registerProducer Register to receive data from a producer.
Method unregisterProducer Stop consuming data from a producer, without disconnecting.
Method stopConsuming Stop consuming data.
Method resumeProducing Undocumented
Method pauseProducing Undocumented
Method stopProducing Stop producing data.
Method fileno File Descriptor number for select().
Method _postLoseConnection Called after a loseConnection(), when all data has been written.
Method _closeWriteConnection Undocumented
def __init__(self, protocol, deviceNameOrPortNumber, reactor, baudrate=9600, bytesize=EIGHTBITS, parity=PARITY_NONE, stopbits=STOPBITS_ONE, xonxoff=0, rtscts=0): (source)
Undocumented
def serialReadEvent(self): (source)
Undocumented
def write(self, data): (source)

Reliably write some data.

The data is buffered until the underlying file descriptor is ready for writing. If there is more than self.bufferSize data in the buffer and this descriptor has a registered streaming producer, its pauseProducing() method will be called.
def serialWriteEvent(self): (source)
Undocumented
def connectionLost(self, reason): (source)

The connection was lost.

This is called when the connection on a selectable object has been lost. It will be called whether the connection was closed explicitly, an exception occurred in an event handler, or the other end of the connection closed it first.

Clean up state here, but make sure to call back up to FileDescriptor.
API Documentation for Twisted, generated by pydoctor at 2011-10-27 16:17:34.