t.p.s.ShoutcastClient(http.HTTPClient) : class documentation

Part of twisted.protocols.shoutcast View Source View In Hierarchy

Known subclasses: twisted.protocols.shoutcast.Test

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 __init__ Undocumented
Method connectionMade Called when a connection is made.
Method lineReceived Override this for when each line is received.
Method handleHeader Undocumented
Method handleEndHeaders Undocumented
Method handleResponsePart_with_metadata Undocumented
Method handle_length Undocumented
Method handle_mp3 Undocumented
Method handle_meta Undocumented
Method parseMetadata Undocumented
Method gotMetaData Called with a list of (key, value) pairs of metadata, if metadata is available on the server.
Method gotMP3Data Called with chunk of MP3 data.

Inherited from HTTPClient:

Method sendCommand Undocumented
Method sendHeader Undocumented
Method endHeaders Undocumented
Method connectionLost Called when the connection is shut down.
Method handleResponseEnd Undocumented
Method handleResponsePart Undocumented
Method rawDataReceived Override this for when raw data is received.

Inherited from LineReceiver (via HTTPClient):

Method clearLineBuffer Clear buffered data.
Method dataReceived Protocol.dataReceived. Translates bytes into lines, and calls lineReceived (or rawDataReceived, depending on mode.)
Method setLineMode Sets the line-mode of this receiver.
Method setRawMode Sets the raw mode of this receiver. Further data received will be sent to rawDataReceived rather than lineReceived.
Method sendLine Sends a line to the other end of the connection.
Method lineLengthExceeded Called when the maximum line length has been reached. Override if it needs to be dealt with in some special way.

Inherited from BaseProtocol (via HTTPClient, LineReceiver, Protocol):

Method makeConnection Make a connection to a transport and a server.

Inherited from _PauseableMixin (via HTTPClient, LineReceiver):

Method pauseProducing Undocumented
Method resumeProducing Undocumented
Method stopProducing Undocumented
def __init__(self, path='/'): (source)
Undocumented
def connectionMade(self): (source)
from twisted.internet.interfaces.IProtocol
overrides twisted.web.http.HTTPClient.connectionMade

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.
def lineReceived(self, line): (source)
overrides twisted.web.http.HTTPClient.lineReceived
Override this for when each line is received.
def handleHeader(self, key, value): (source)
Undocumented
def handleEndHeaders(self): (source)
Undocumented
def handleResponsePart_with_metadata(self, data): (source)
Undocumented
def handle_length(self): (source)
Undocumented
def handle_mp3(self): (source)
Undocumented
def handle_meta(self): (source)
Undocumented
def parseMetadata(self, data): (source)
Undocumented
def gotMetaData(self, metadata): (source)
overridden in twisted.protocols.shoutcast.Test

Called with a list of (key, value) pairs of metadata, if metadata is available on the server.

Will only be called on non-empty metadata.
def gotMP3Data(self, data): (source)
overridden in twisted.protocols.shoutcast.Test
Called with chunk of MP3 data.
API Documentation for Twisted, generated by pydoctor at 2011-10-27 15:57:47.