IByteStream.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 _SUPPORT_BYTESTREAM_INTERFACE_H
#define _SUPPORT_BYTESTREAM_INTERFACE_H

#include <support/IInterface.h>
#include <sys/uio.h>

#if _SUPPORTS_NAMESPACE
namespace palmos {
namespace support {
#endif


enum {
    B_WRITE_TRANSACTION         = 'WRTE',
    B_WRITE_FLAGS_TRANSACTION   = 'WRFL',
    B_READ_TRANSACTION          = 'READ'
};


enum {

    B_DO_NOT_BLOCK              = 0x00000001
};

enum {

    B_WRITE_END                 = 0x00010000
};

/*-------------------------------------------------------------*/
/*------- IByteInput Interface --------------------------------*/

class IByteInput : public IInterface
{
    public:

        B_DECLARE_META_INTERFACE(ByteInput)

                

        virtual ssize_t     ReadV(const iovec *vector, ssize_t count, uint32_t flags = 0) = 0;
        
                ssize_t     Read(void *buffer, size_t size, uint32_t flags = 0);
};

/*-------------------------------------------------------------*/
/*------- IByteOutput Interface -------------------------------*/

class IByteOutput : public IInterface
{
    public:

        B_DECLARE_META_INTERFACE(ByteOutput)

                

        virtual ssize_t     WriteV(const iovec *vector, ssize_t count, uint32_t flags = 0) = 0;
        
                ssize_t     Write(const void *buffer, size_t size, uint32_t flags = 0);
                

        virtual status_t    Sync() = 0;
};

/*-------------------------------------------------------------*/
/*------- IByteSeekable Interface -----------------------------*/

class IByteSeekable : public IInterface
{
    public:

        B_DECLARE_META_INTERFACE(ByteSeekable)

                
        virtual off_t       Position() const = 0;
        

        virtual off_t       Seek(off_t position, uint32_t seek_mode) = 0;
};

/*-------------------------------------------------------------*/
/*---- No user serviceable parts after this -------------------*/

inline ssize_t IByteInput::Read(void *buffer, size_t size, uint32_t flags)
{
    iovec v;
    v.iov_base = buffer;
    v.iov_len = size;
    return ReadV(&v,1,flags);
}

inline ssize_t IByteOutput::Write(const void *buffer, size_t size, uint32_t flags)
{
    iovec v;
    v.iov_base = const_cast<void*>(buffer);
    v.iov_len = size;
    return WriteV(&v,1,flags);
}

/*-------------------------------------------------------------*/

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

#endif /* _SUPPORT_BYTESTREAM_INTERFACE_H */

---

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

PalmSource, Inc. © 2005