Ogg::Logical Class Reference
[Logical InterfaceDerivable and Nonderivable Classes]

Logical interface. More...

#include <Logical.H>

List of all members.

Public Member Functions

void * impl ()
 Logical (Transport &transport, long serialNo)
 Add a writing Logical to an encapsulating Transport.
 Logical (Transport &transport)
 Construct a Logical for reading.
virtual ~Logical ()
 Removes this Logical from Transport.
virtual bool selectCallback (Packet &firstPacket)
 Call back for logical stream selection based on first packet.
long serialNo ()
 Get the serialNo for this Logical.
Transporttransport ()
 Get the Transport for this Logical.
Writerwriter ()
 Get a Writer for this Logical.
Readerreader ()
 Get a Reader for this Logical based on selectCallback.

Protected Member Functions

 Logical (bool dummy)
 Despite appearance, derived classes should NOT construct with this.

Classes

class  FailedToSelectStream
class  MuxTooLate
 Exception thrown by Logical::Logical. More...
class  NoSuchStream
class  NotForReading
 Exception thrown by Logical::Reader. More...
class  NotForWriting
 Exception thrown by Logical::Writer. More...
class  Reader
 Logical stream reader. More...
class  ReaderAlreadyExists
 Exception thrown by Logical::Reader. More...
class  SeekInternalError
 Exception thrown by Logical::Reader:: seek operators. More...
class  SerialNoAlreadyUsed
 Exception thrown by Logical::Logical. More...
class  StreamAlreadyClaimed
class  Writer
 Logical stream writer. More...


Detailed Description

Logical interface.

Codecs may derive from Logical.


Constructor & Destructor Documentation

Ogg::Logical::Logical ( bool  dummy  )  [inline, protected]

Despite appearance, derived classes should NOT construct with this.

Ogg::Logical::Logical ( Transport transport,
long  serialNo 
)

Add a writing Logical to an encapsulating Transport.

Ogg::Logical::Logical ( Transport transport  ) 

Construct a Logical for reading.


Member Function Documentation

void* Ogg::Logical::impl (  )  [inline]

long Ogg::Logical::serialNo (  ) 

Get the serialNo for this Logical.

Transport& Ogg::Logical::transport (  ) 

Get the Transport for this Logical.

Writer& Ogg::Logical::writer (  ) 

Get a Writer for this Logical.

Only one Writer per Logical at one time is allowed. In addition, a first Packet is created.

Reader& Ogg::Logical::reader (  ) 

Get a Reader for this Logical based on selectCallback.

Only one Reader per Logical at one time is allowed. A new Reader may be requested after destroying a previous Reader.


The documentation for this class was generated from the following file:
Generated on Tue May 1 16:35:34 2007 for libogg++ by  doxygen 1.5.1