MessageList.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_MESSAGELIST_H
#define _SUPPORT_MESSAGELIST_H

#include <support/ITextStream.h>
#include <support/SupportDefs.h>

#if _SUPPORTS_NAMESPACE
namespace palmos {
namespace support {
#endif

class SMessage;

enum {
    B_ANY_WHAT = 0
};

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

class SMessageList 
{
public:

                        SMessageList();
                        ~SMessageList();


        SMessageList&   Adopt(SMessageList& other);


    


        void            EnqueueMessage(SMessage* msg);


        SMessage*       EnqueueMessageRemoveDups(   const SMessage& msg, nsecs_t time,
                                                    SValue* outPrevData, SMessageList* outRemoved);


        SMessage*       EnqueueUniqueMessage(   const SMessage& msg, nsecs_t time,
                                                SValue* outPrevData, SMessageList* outRemoved);


        SMessage*       DequeueMessage(uint32_t what = B_ANY_WHAT, bool *more = NULL);


        nsecs_t         OldestMessage(int32_t* out_priority) const;



        const SMessage* Head() const;
        const SMessage* Tail() const;
        const SMessage* Next(const SMessage* current) const;
        const SMessage* Previous(const SMessage* current) const;



        void            AddHead(SMessage* message);
        void            AddTail(SMessage* message);

        void            InsertBefore(SMessage* message, const SMessage* position);

        void            InsertAfter(SMessage* message, const SMessage* position);

        

        SMessage*       RemoveHead();
        SMessage*       RemoveTail();
        SMessage*       Remove(const SMessage* message);




        int32_t         CountMessages(uint32_t what = B_ANY_WHAT) const;
        bool            IsEmpty() const;
        void            MakeEmpty();

        
/*----- Private or reserved -----------------------------------------*/

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

        SMessage        *fHead;
        SMessage        *fTail;
        int32_t         fCount;
        uint32_t        _reserved[2];
};

_IMPEXP_SUPPORT const sptr<ITextOutput>& operator<<(const sptr<ITextOutput>& io, const SMessageList& list);

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

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

#endif /* _SUPPORT_MESSAGELIST_H */

---

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

PalmSource, Inc. © 2005