UTMessage.h

Go to the documentation of this file.

//==================================================================================================
// Copyright (C) 2010  Brian Tietz    sdbtietz at yahoo dot com
//
// This program is free software; you can redistribute it and/or modify it under the terms of the
// GNU General Public License as published by the Free Software Foundation, version 2.0 of the
// License.
//
// This program 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
// General Public License for more details.
//
// You should have received a copy of the GNU General Public License along with this program; if
// not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
// 02110-1301, USA.
//
// For commercial software, the copyright holder (Brian Tietz, email sdbtietz at yahoo dot com)
// reserves the right and is willing to waive the proprietary source code disclosure aspects of that
// license as applied to the UT library in exchange for either substantial contributions to the
// development of the UT library or other forms of compensation.  Any such waiver must be
// established in writing between the copyright holder and the commercial entity obtaining such a
// waiver.
//==================================================================================================


#ifndef _UT_MESSAGE_H_
#define _UT_MESSAGE_H_


//==================================================================================================
//=== Project headers
//==================================================================================================
#include "UTMessageDestination.h"
#include "UTPoolAllocator.h"


//==================================================================================================
//=== Forward name declarations
//==================================================================================================
class Buffer_t;


//==================================================================================================
class UT_EXPORT Message_t
//==================================================================================================
{
    //----------------------------------------------------------------------------------------------
    public:
    //----------------------------------------------------------------------------------------------
                                    Message_t();

    virtual                         ~Message_t();

    virtual gives Message_t*        Clone() const;

    void                            Flatten(out Buffer_t* buffer) const;

    virtual int                     FlattenContents(out byte* buffer) const;

    virtual int                     FlattenedContentsSize() const;

    // \cond DOXYGEN_DOCUMENT_NEVER
    inline void*                    operator new(size_t size);
    inline void                     operator delete(void* block);
    // \endcond

    //----------------------------------------------------------------------------------------------
    private:
    //----------------------------------------------------------------------------------------------
    void                            SetDestination(const AbstractMessageDestination_t& destination);

    //----------------------------------------------------------------------------------------------
    private:
    //----------------------------------------------------------------------------------------------
    AbstractMessageDestination_t    m_destination;

    // Message queue could be a LinkedList_t, but we don't need all that state, and this allows the
    // minimum amount of list mutex protection.
    Message_t* volatile             m_next;

    static PoolAllocator_t          ms_message_block_pool;

    friend class AbstractMessageDestination_t;
    friend class MessageLoop_t;
    friend class App_t;
    friend class AppPlatformInfo_t;
};




//==================================================================================================
//==================================================================================================
//===
//=== Inline function implementations
//===
//==================================================================================================
//==================================================================================================

// \cond DOXYGEN_DOCUMENT_NEVER


inline void*
Message_t::operator new(size_t size)
{
    return ms_message_block_pool.Allocate(size);
}


inline void
Message_t::operator delete(void* block)
{
    ms_message_block_pool.Release(block);
}


// \endcond

#endif // _UT_MESSAGE_H_