Transport.H

Go to the documentation of this file.

/*===========================================================================*/
/*
 * This file is part of libogg++ - a c++ library for the Ogg transport format
 *
 * Copyright (C) 2006, 2007, 2008 Elaine Tsiang YueLien
 *
 * libogg++ is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 * 
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 * 
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the
 * Free Software Foundation, Inc.
 * 51 Franklin Street, Fifth Floor
 * Boston, MA  02110-1301, USA
 *
 *===========================================================================*/
/*===========================================================================*/
#ifndef TransportToApplicationInterface
#define TransportToApplicationInterface

#ifdef __GNUG__
#pragma interface
#endif

namespace       Ogg
{
  class Transport;
  class Page;
}

#include        <Ogg/Ogg.H>
#include        <Ogg/Logical.H>
#include        <Ogg/Exception.H>

namespace       Ogg
{


  
  class Page
  {
  public:
    void
    data(void *
         ,size_t
         );

    void *
    data();             
    
    size_t
    size() const;       

    bool
    ending() const;     

    Position
    granulePosition() const;    

    bool
    isHeader()const ;   

    long
    pageNo() const;     

    long
    serialNo() const;   

    long
    pageOrderNo() const;        

  };

  class Transport
  {
  private:
    void *              impl_;

    Transport(const Transport &);

    Transport &
    operator=(const Transport &);

  protected:
    Transport(
              int dummy
              )
      : impl_(0)
    {}

  public:
    void *
    impl()
    {
      return(impl_);
    }

    static
    const unsigned char CurrentVersion = 0x00;

    /*----- Exceptions thrown by a Transport thread ---------------------------------*/

    class NoDeletion : public Exception
    {
    public:
      NoDeletion() throw()
      : Exception("Sorry, you can't delete Transport instances")
      {
        *this << std::endl;
      }

      NoDeletion(
                 const NoDeletion & ex
                 ) throw()
        : Exception(ex)
      {}

      ~NoDeletion() throw()
      {}
    }
    ;

    class PrematureEndOfOggStream : public Exception
    {
    public:
      PrematureEndOfOggStream() throw()
      : Exception("Premature end of transport stream.")
      {
        *this << std::endl;
      }

      PrematureEndOfOggStream(
                              const PrematureEndOfOggStream & ex
                              ) throw()
        : Exception(ex)
      {}
      
      ~PrematureEndOfOggStream() throw()
      {}
    }
    ;

    /*- end Exceptions thrown by a Transport thread ---------------------------------*/

    Transport(
              bool      encapsulating
              );

    virtual
    ~Transport();

    long
    serialNo(long);

    Logical *
    logical(
            long        serialNo
            );

    void
    loop();

    void
    terminate();

    virtual
    void
    sendCallback(
                 Page &
                 );

    virtual
    size_t
    recvCallback(
                 Page &
                 );

    virtual
    bool
    laterThan (
               const Page &             p1
               ,const Page &            p2
               );

  }
  ;

};
#endif

---