StreamDatum.h

Go to the documentation of this file.

/*
 * Copyright (c) 2005 Palmsource, Inc.
 * 
 * This software is licensed as described in the file LICENSE, which
 * you should have received as part of this distribution. The terms
 * are also available at http://www.openbinder.org/license.html.
 * 
 * This software consists of voluntary contributions made by many
 * individuals. For the exact contribution history, see the revision
 * history and logs, available at http://www.openbinder.org
 */

#ifndef _STORAGE_STREAMDATUM_H
#define _STORAGE_STREAMDATUM_H

#include <storage/GenericDatum.h>

#include <support/ByteStream.h>
#include <support/IStorage.h>
#include <support/Locker.h>
#include <support/SortedVector.h>

#if _SUPPORTS_NAMESPACE
namespace palmos {
namespace storage {
#endif

// ==========================================================================
// ==========================================================================


class BStreamDatum : public BGenericDatum
{
public:
    // --------------------------------------------------------------
                                    BStreamDatum(uint32_t mode = IDatum::READ_WRITE);
                                    BStreamDatum(const SContext& context, uint32_t mode = IDatum::READ_WRITE);
protected:
    virtual                         ~BStreamDatum();
public:

    static  uint32_t                RestrictMode(uint32_t requested, uint32_t limit);

            uint32_t                Mode() const;


    virtual lock_status_t           Lock() const;

    virtual void                    Unlock() const;


    //  ------------------------------------------------------------------

    virtual uint32_t                ValueType() const;
    virtual void                    SetValueType(uint32_t type);
    virtual off_t                   Size() const;
    virtual void                    SetSize(off_t size);
    virtual SValue                  Value() const;
    virtual void                    SetValue(const SValue& value);
    virtual sptr<IBinder>           Open(uint32_t mode, const sptr<IBinder>& editor = NULL, uint32_t newType = 0);

            status_t                SetValueTypeLocked(uint32_t type);
            status_t                SetSizeLocked(off_t size);
            status_t                SetValueLocked(const SValue& value);

    class Stream;

    //  ------------------------------------------------------------------

    virtual uint32_t                ValueTypeLocked() const;
    virtual status_t                StoreValueTypeLocked(uint32_t type);
    virtual off_t                   SizeLocked() const = 0;
    virtual status_t                StoreSizeLocked(off_t size) = 0;

    virtual SValue                  ValueLocked() const;

    virtual status_t                StoreValueLocked(const SValue& value);

            enum {
                TYPE_CHANGED    = 0x0001,   
                SIZE_CHANGED    = 0x0002,   
                DATA_CHANGED    = 0x0004    
            };


    virtual void                    ReportChangeLocked(const sptr<IBinder>& editor, uint32_t changes, off_t start=-1, off_t length=-1);


    //  ------------------------------------------------------------------

    virtual ssize_t                 ReadLocked( const sptr<Stream>& stream, off_t position,
                                                const struct iovec *vector, ssize_t count, uint32_t flags) const;
    virtual ssize_t                 WriteLocked(const sptr<Stream>& stream, off_t position,
                                                const struct iovec *vector, ssize_t count, uint32_t flags);
    virtual status_t                SyncLocked();
    

    //  ------------------------------------------------------------------

    virtual const void*             StartReadingLocked( const sptr<Stream>& stream, off_t position,
                                                        ssize_t* inoutSize, uint32_t flags) const;
    virtual void                    FinishReadingLocked(const sptr<Stream>& stream, const void* data) const;
    virtual void*                   StartWritingLocked( const sptr<Stream>& stream, off_t position,
                                                        ssize_t* inoutSize, uint32_t flags);
    virtual void                    FinishWritingLocked(const sptr<Stream>& stream, void* data);


protected:

private:
                                    BStreamDatum(const BStreamDatum&);
            BStreamDatum&           operator=(const BStreamDatum&);

    friend class Stream;

            ssize_t                 write_wrapper_l(const sptr<Stream>& stream, off_t position,
                                                    const struct iovec *vector, ssize_t count, uint32_t flags);

    mutable SLocker                 m_lock;
    const   uint32_t                m_mode;
            SSortedVector<wptr<Stream> >
                                    m_streams;
};

// --------------------------------------------------------------------------


class BStreamDatum::Stream : public BnByteInput, public BnByteOutput, public BnByteSeekable, public BnStorage
{
public:
    // --------------------------------------------------------------
                                Stream( const SContext& context, const sptr<BStreamDatum>& datum,
                                        uint32_t mode, uint32_t type, const sptr<IBinder>& editor);
    
    virtual SValue              Inspect(const sptr<IBinder>& caller, const SValue &which, uint32_t flags = 0);
    
protected:
    virtual                     ~Stream();
    virtual void                InitAtom();
    virtual status_t            FinishAtom(const void* id);
public:


    // --------------------------------------------------------------

    virtual ssize_t             ReadV(const struct iovec *vector, ssize_t count, uint32_t flags = 0);
    virtual ssize_t             WriteV(const struct iovec *vector, ssize_t count, uint32_t flags = 0);
    virtual status_t            Sync();
    virtual off_t               Seek(off_t position, uint32_t seek_mode);
    virtual off_t               Position() const;


    // --------------------------------------------------------------

    virtual off_t               Size() const;
    virtual status_t            SetSize(off_t size);
    virtual ssize_t             ReadAtV(off_t position, const struct iovec *vector, ssize_t count);
    virtual ssize_t             WriteAtV(off_t position, const struct iovec *vector, ssize_t count);


    // --------------------------------------------------------------

            sptr<BStreamDatum>  Datum() const;
            uint32_t            Mode() const;
            uint32_t            Type() const;
            sptr<IBinder>       Editor() const;
            sptr<IBinder>       DefaultInterface() const;


private:
                                Stream(const Stream&);

    const   sptr<BStreamDatum>  m_datum;
    const   uint32_t            m_mode;
    const   uint32_t            m_type;
    const   sptr<IBinder>       m_editor;
            off_t               m_pos;
};

// ==========================================================================
// ==========================================================================

#if _SUPPORTS_NAMESPACE
} } // namespace palmos::storage
#endif

#endif // _STORAGE_STREAMDATUM_H

---

Generated on Wed Dec 28 22:33:28 2005 by Doxygen 1.4.4 for OpenBinder Documentation Version 1.0

PalmSource, Inc. © 2005