Main Page | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Class Members | File Members

IceCast Class Reference

#include <IceCast.h>

Inheritance diagram for IceCast:

Inheritance graph
[legend]
Collaboration diagram for IceCast:

Collaboration graph
[legend]
List of all members.

Detailed Description

Class representing output to an IceCast server with x-audiocast login.

Author:
Author
darkeye
Version:
Revision
1.8

Definition at line 59 of file IceCast.h.

Public Member Functions

 IceCast (TcpSocket *socket, const char *password, const char *mountPoint, unsigned int bitRate, const char *name=0, const char *description=0, const char *url=0, const char *genre=0, bool isPublic=false, const char *remoteDumpFile=0, Sink *streamDump=0, unsigned int bufferDuration=10) throw ( Exception )
 Constructor.
 IceCast (const IceCast &cs) throw ( Exception )
 Copy constructor.
virtual ~IceCast (void) throw ( Exception )
 Destructor.
virtual IceCastoperator= (const IceCast &cs) throw ( Exception )
 Assignment operator.
const char * getMountPoint (void) const throw ()
 Get the mount point of the stream on the server.
const char * getRemoteDumpFile (void) const throw ()
 Get the remote dump file if any.
const char * getDescription (void) const throw ()
 Get the description of the stream.

Protected Member Functions

 IceCast (void) throw ( Exception )
 Default constructor.
virtual bool sendLogin (void) throw ( Exception )
 Log in to the server using the socket avialable.


Constructor & Destructor Documentation

IceCast::IceCast void   )  throw ( Exception ) [inline, protected]
 

Default constructor.

Always throws an Exception.

Exceptions:
Exception 

Definition at line 109 of file IceCast.h.

IceCast::IceCast TcpSocket socket,
const char *  password,
const char *  mountPoint,
unsigned int  bitRate,
const char *  name = 0,
const char *  description = 0,
const char *  url = 0,
const char *  genre = 0,
bool  isPublic = false,
const char *  remoteDumpFile = 0,
Sink streamDump = 0,
unsigned int  bufferDuration = 10
throw ( Exception ) [inline]
 

Constructor.

Parameters:
socket socket connection to the server.
password password to the server.
mountPoint mount point of the stream on the server.
remoteDumpFile remote dump file (may be NULL).
name name of the stream.
description description of the stream.
url URL associated with the stream.
genre genre of the stream.
bitRate bitrate of the stream (e.g. mp3 bitrate).
isPublic is the stream public?
streamDump an optional sink to dump the binary stream data to.
bufferDuration duration of the BufferedSink buffer in seconds.
Exceptions:
Exception 

Definition at line 146 of file IceCast.h.

IceCast::IceCast const IceCast cs  )  throw ( Exception ) [inline]
 

Copy constructor.

Parameters:
cs the IceCast to copy.

Definition at line 178 of file IceCast.h.

References Exception::getDescription().

virtual IceCast::~IceCast void   )  throw ( Exception ) [inline, virtual]
 

Destructor.

Exceptions:
Exception 

Definition at line 192 of file IceCast.h.


Member Function Documentation

const char* IceCast::getDescription void   )  const throw () [inline]
 

Get the description of the stream.

Returns:
the description of the stream.

Definition at line 245 of file IceCast.h.

Referenced by sendLogin().

const char* IceCast::getMountPoint void   )  const throw () [inline]
 

Get the mount point of the stream on the server.

Returns:
the mount point of the stream on the server.

Definition at line 223 of file IceCast.h.

Referenced by sendLogin().

const char* IceCast::getRemoteDumpFile void   )  const throw () [inline]
 

Get the remote dump file if any.

Returns:
the remote dump file. May be NULL.

Definition at line 234 of file IceCast.h.

Referenced by sendLogin().

virtual IceCast& IceCast::operator= const IceCast cs  )  throw ( Exception ) [inline, virtual]
 

Assignment operator.

Parameters:
cs the IceCast to assign this to.
Returns:
a reference to this IceCast.
Exceptions:
Exception 

Definition at line 205 of file IceCast.h.

References CastSink::operator=().

bool IceCast::sendLogin void   )  throw ( Exception ) [protected, virtual]
 

Log in to the server using the socket avialable.

Returns:
true if login was successful, false otherwise.
Exceptions:
Exception 

Implements CastSink.

Definition at line 119 of file IceCast.cpp.

References Source::canRead(), Sink::flush(), CastSink::getBitRate(), getDescription(), CastSink::getGenre(), CastSink::getIsPublic(), getMountPoint(), CastSink::getName(), CastSink::getPassword(), getRemoteDumpFile(), CastSink::getSink(), CastSink::getSocket(), CastSink::getUrl(), Sink::isOpen(), Source::isOpen(), Source::read(), STRBUF_SIZE, and Sink::write().


The documentation for this class was generated from the following files:
Generated on Sat Oct 22 13:17:07 2005 for DarkIce by  doxygen 1.4.4