Ogg::Logical::PageWriter Class Reference
[Derivable and Nonderivable Classes]

Logical stream Page writer

Do not derive from PageWriter. It is designed for writing pages that have been routed from a PageReader. More...

#include <Logical.H>

List of all members.

Public Member Functions

 ~PageWriter ()
 Ends writing this Logical stream.
bool put (Page &)
 Enques the given page.
void doPut (Page &)
 Enques the given page.

Protected Member Functions

 PageWriter ()


Detailed Description

Logical stream Page writer

Do not derive from PageWriter. It is designed for writing pages that have been routed from a PageReader.


Constructor & Destructor Documentation

Ogg::Logical::PageWriter::PageWriter (  )  [inline, protected]

Ogg::Logical::PageWriter::~PageWriter (  ) 

Ends writing this Logical stream.

The user deletes the PageWriter instance, or the PageWriter instance falls out of scrope, which implicitly calls this destructor which closes the Logical stream.


Member Function Documentation

bool Ogg::Logical::PageWriter::put ( Page  ) 

Enques the given page.

Return true if successful. Returns false if queue is congested. Note once a page has been put, it should not be referenced again, as the page is sunk after being muxed. When that happens on the muxing thread is unpredictable.

void Ogg::Logical::PageWriter::doPut ( Page  ) 

Enques the given page.


The documentation for this class was generated from the following file:

Generated on Thu Feb 26 12:25:46 2009 for libogg++ by  doxygen 1.5.6