Package twisted :: Package internet :: Package serialport :: Module win32serialport :: Class SerialPort

[show private | hide private]
[frames | no frames]

## Class SerialPort

    BaseSerialPort --+
                     |
        Logger --+   |
                 |   |
     Ephemeral --+   |
                 |   |
    FileDescriptor --+
                     |
                    SerialPort

A select()able serial device, acting as a transport.

Method Summary
| `__init__(self, protocol, deviceNameOrPortNumber, reactor, baudrate, bytesize, parity, stopbits, timeout, xonxoff, rtscts)`
| `__getstate__(self)` (inherited from `Ephemeral`)
| `__setstate__(self, state)` (inherited from `Ephemeral`)
| ``connectionLost`(self, reason)` The connection was lost.
| `doRead(self)`
| ``doWrite`(self)` Called when data is available for writing.
| ``fileno`(self)` File Descriptor number for select(). (inherited from `FileDescriptor`)
| `flushInput(self)` (inherited from `BaseSerialPort`)
| `flushOutput(self)` (inherited from `BaseSerialPort`)
| `getCD(self)` (inherited from `BaseSerialPort`)
| `getCTS(self)` (inherited from `BaseSerialPort`)
| `getDSR(self)` (inherited from `BaseSerialPort`)
| `getRI(self)` (inherited from `BaseSerialPort`)
| `inWaiting(self)` (inherited from `BaseSerialPort`)
| `log(self, bytes)` (inherited from `Logger`)
| ``logPrefix`(self)` Override this method to insert custom logging behavior. (inherited from `Logger`)
| ``loseConnection`(self)` Close the connection at the next available opportunity. (inherited from `FileDescriptor`)
| `pauseProducing(self)` (inherited from `FileDescriptor`)
| ``registerProducer`(self, producer, streaming)` Register to receive data from a producer. (inherited from `FileDescriptor`)
| `resumeProducing(self)` (inherited from `FileDescriptor`)
| `sendBreak(self)` (inherited from `BaseSerialPort`)
| `serialEvent(self)`
| `setBaudRate(self, baudrate)` (inherited from `BaseSerialPort`)
| `setDTR(self, on)` (inherited from `BaseSerialPort`)
| `setRTS(self, on)` (inherited from `BaseSerialPort`)
| ``startReading`(self)` Start waiting for read availability. (inherited from `FileDescriptor`)
| ``startWriting`(self)` Start waiting for write availability. (inherited from `FileDescriptor`)
| ``stopConsuming`(self)` Stop consuming data. (inherited from `FileDescriptor`)
| `stopProducing(self)` (inherited from `FileDescriptor`)
| ``stopReading`(self)` Stop waiting for read availability. (inherited from `FileDescriptor`)
| ``stopWriting`(self)` Stop waiting for write availability. (inherited from `FileDescriptor`)
| ``unregisterProducer`(self)` Stop consuming data from a producer, without disconnecting. (inherited from `FileDescriptor`)
| ``write`(self, data)` Reliably write some data.
| `writeSequence(self, iovec)` (inherited from `FileDescriptor`)
| ``writeSomeData`(self, data)` Write as much as possible of the given data, immediately. (inherited from `FileDescriptor`)

Class Variable Summary
`int` | `connected`

Method Details

### connectionLost(self, reason)

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.

  Overrides:
    `twisted.internet.abstract.FileDescriptor.connectionLost` (inherited documentation)

### doWrite(self)

Called when data is available for writing.

A result that is true (which will be a negative number) implies the connection was lost. A false result implies the connection is still there; a result of 0 implies no write was done, and a result of None indicates that a write was done.

  Overrides:
    `twisted.internet.abstract.FileDescriptor.doWrite` (inherited documentation)

### write(self, data)

Reliably write some data.

If there is no buffered data this tries to write this data immediately, otherwise this adds data to be written the next time this file descriptor is ready for writing.

  Overrides:
    `twisted.internet.abstract.FileDescriptor.write` (inherited documentation)

Class Variable Details

### connected

  Type:
    `int`
  Value:

        1

Generated by Epydoc 1.1 on Sat Feb 15 21:17:52 2003 | http://epydoc.sf.net