Package twisted :: Package protocols :: Module shoutcast :: Class ShoutcastClient

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

## Class ShoutcastClient

    BaseProtocol --+
                   |
            Protocol --+
                       |
            LineReceiver --+
                           |
                  HTTPClient --+
                               |
                              ShoutcastClient

Shoutcast HTTP stream.

Modes can be 'length', 'meta' and 'mp3'.

See http://www.smackfu.com/stuff/programming/shoutcast.html for details on the protocol.

Method Summary
| `__init__(self, path)`
| ``connectionFailed`(self)` (Deprecated) (inherited from `Protocol`)
| ``connectionLost`(self, reason)` Called when the connection is shut down. (inherited from `HTTPClient`)
| ``connectionMade`(self)` Called when a connection is made.
| ``dataReceived`(self, data)` Protocol.dataReceived. (inherited from `LineReceiver`)
| `endHeaders(self)` (inherited from `HTTPClient`)
| ``gotMetaData`(self, metadata)` Called with a list of (key, value) pairs of metadata.
| ``gotMP3Data`(self, data)` Called with chunk of MP3 data.
| `handle_length(self)`
| `handle_meta(self)`
| `handle_mp3(self)`
| `handleEndHeaders(*args)` (inherited from `HTTPClient`)
| `handleHeader(self, key, value)`
| `handleResponseEnd(self)` (inherited from `HTTPClient`)
| `handleResponsePart(self, data)`
| `handleStatus(*args)` (inherited from `HTTPClient`)
| ``lineLengthExceeded`(self, line)` Called when the maximum line length has been reached. (inherited from `LineReceiver`)
| ``lineReceived`(self, line)` Override this for when each line is received.
| ``makeConnection`(self, transport)` Make a connection to a transport and a server. (inherited from `BaseProtocol`)
| `parseMetadata(self, data)`
| ``rawDataReceived`(self, data)` Override this for when raw data is received. (inherited from `HTTPClient`)
| `sendCommand(self, command, path)` (inherited from `HTTPClient`)
| `sendHeader(self, name, value)` (inherited from `HTTPClient`)
| ``sendLine`(self, line)` Sends a line to the other end of the connection. (inherited from `LineReceiver`)
| ``setLineMode`(self, extra)` Sets the line-mode of this receiver. (inherited from `LineReceiver`)
| ``setRawMode`(self)` Sets the raw mode of this receiver. (inherited from `LineReceiver`)

Method Details

### connectionMade(self)

Called when a connection is made.

This may be considered the initializer of the protocol, because it is called when the connection is completed. For clients, this is called once the connection to the server has been established; for servers, this is called after an accept() call stops blocking and a socket has been received. If you need to send any greeting or initial message, do it here.

  Overrides:
    `twisted.protocols.http.HTTPClient.connectionMade` (inherited documentation)

### gotMetaData(self, metadata)

Called with a list of (key, value) pairs of metadata.

Will only be called on non-empty metadata.

### gotMP3Data(self, data)

Called with chunk of MP3 data.

### lineReceived(self, line)

Override this for when each line is received.

  Overrides:
    `twisted.protocols.http.HTTPClient.lineReceived` (inherited documentation)

Generated by Epydoc 1.1 on Thu May 8 13:18:54 2003 | http://epydoc.sf.net