IDatum.h

Go to the documentation of this file.

/*========================================================== */ 
// header file automatically generated by PIDGEN - DO NOT MODIFY
/*========================================================== */ 

#ifndef SUPPORT_IDATUM_H
#define SUPPORT_IDATUM_H

#include <support/IInterface.h>
#include <support/Binder.h>
#include <support/Context.h>
#include <support/String.h>

/*
 * 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
 */
/* ============= Interface Class Declarations =========================== */

#if _SUPPORTS_NAMESPACE
namespace palmos {
namespace support {
#endif /* _SUPPORTS_NAMESPACE */


class IDatum : public IInterface
{
public:
    B_DECLARE_META_INTERFACE(Datum)
    
    
    /* ------- enums/structs --------------------- */
    enum  {
        READ_ONLY=0x0000,
        WRITE_ONLY=0x0001,
        READ_WRITE=0x0002,
        READ_WRITE_MASK=0x0003,
        ERASE_DATUM=0x0200,
        OPEN_AT_END=0x0400
    };
    
    enum  {

        NO_COPY_REDIRECTION=0x0001
    };
    
    
    /* ------- Properties --------------------- */
    
    virtual uint32_t                ValueType() const = 0;
    virtual void                    SetValueType(uint32_t value) = 0;
    
    virtual off_t                   Size() const = 0;
    virtual void                    SetSize(off_t value) = 0;
    

    virtual SValue                  Value() const = 0;

    virtual void                    SetValue(const SValue& value) = 0;
    
    /* ------- Methods ------------------------ */
    

    virtual sptr<IBinder>           Open(uint32_t mode, const sptr<IBinder>& editor = NULL, uint32_t newType = 0) = 0;
    

    virtual status_t                CopyTo(const sptr<IDatum>& dest, uint32_t flags = 0) = 0;
    

    virtual status_t                CopyFrom(const sptr<IDatum>& src, uint32_t flags = 0) = 0;
    
    /* ------- Events ------------------------ */
    
    /* ------- inline helpers ------------------------- */
    status_t LinkDatum(const sptr<IBinder>& to, const SValue& mappings, uint32_t flags = 0)
    {
        return AsBinder()->Link(to, mappings, flags);
    }
    status_t UnlinkDatum(const sptr<IBinder>& to, const SValue& mappings, uint32_t flags = 0)
    {
        return AsBinder()->Unlink(to, mappings, flags);
    }

protected:
                                    IDatum() { }
    virtual                         ~IDatum();

private:
    /* ------- copy/assignment protection ------------------ */
                                    IDatum(const IDatum& o);
            IDatum&                 operator=(const IDatum& o);
};


/* ============= Local Class Declarations =============================== */

class BnDatum : public IDatum, public BBinder
{
public:
    virtual SValue                  Inspect(const sptr<IBinder>& caller, const SValue& which, uint32_t flags = 0);
    virtual sptr<IInterface>        InterfaceFor(const SValue& descriptor, uint32_t flags = 0);
    
    /* ------- Events ------------------------- */
public:

            void                    PushDatumChanged(const sptr<IDatum>& who, const sptr<IBinder>& editor, off_t start, off_t length);
    
    /* ------- Push Properties ---------------- */
public:
            void                    PushValueType(uint32_t value);
            void                    PushSize(off_t value);
            void                    PushValue(const SValue& value);

protected:
                                    BnDatum();
                                    BnDatum(const SContext& context);
    virtual                         ~BnDatum();
    
    virtual sptr<IBinder>           AsBinderImpl();
    virtual sptr<const IBinder>     AsBinderImpl() const;
    
    /* ------- Marshalling Details ------------ */
    virtual status_t                HandleEffect(const SValue &, const SValue &, const SValue &, SValue *);
    virtual status_t                Transact(uint32_t code, SParcel& data, SParcel* reply, uint32_t flags);

private:
                                    BnDatum(const BnDatum& o);
            BnDatum&                operator=(const BnDatum& o);
};


#if _SUPPORTS_NAMESPACE
} } // namespace palmos::support
#endif /* _SUPPORTS_NAMESPACE */


// namespace palmos::support

#endif // SUPPORT_IDATUM_H

---

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

PalmSource, Inc. © 2005