Package twisted :: Package internet :: Module interfaces :: Class ITransport

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

## Class ITransport

    Interface --+
                |
               ITransport

Known Subclasses:
  `IProcessTransport`, `ITCPTransport`

I am a transport for bytes.

I represent (and wrap) the physical connection and synchronicity of the framework which is talking to the network. I make no representations about whether calls to me will happen immediately or require returning to a control loop, or whether they will happen in the same or another thread. Consider methods of this class (aside from getPeer) to be 'thrown over the wall', to happen at some indeterminate time.

Method Summary
| ``getHost`(self)` Similar to getPeer, but returns a tuple describing this side of the connection.
| ``getPeer`(self)` Return a tuple of (TYPE, ...).
| ``loseConnection`(self)` Close my connection, after writing all pending data.
| ``write`(self, data)` Write some data to the physical connection, in sequence.
| ``writeSequence`(self, data)` Write a list of strings to the physical connection.

Method Details

### getHost(self)

Similar to getPeer, but returns a tuple describing this side of the connection.

### getPeer(self)

Return a tuple of (TYPE, ...).

This indicates the other end of the connection. TYPE indicates what sort of connection this is: "INET", "UNIX", or something else.

Treat this method with caution. It is the unfortunate result of the CGI and Jabber standards, but should not be considered reliable for the usual host of reasons; port forwarding, proxying, firewalls, IP masquerading, etcetera.

### loseConnection(self)

Close my connection, after writing all pending data.

### write(self, data)

Write some data to the physical connection, in sequence.

If possible, make sure that it is all written. No data will ever be lost, although (obviously) the connection may be closed before it all gets through.

### writeSequence(self, data)

Write a list of strings to the physical connection.

If possible, make sure that all of the data is written to the socket at once, without first copying it all into a single string.

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