message-buffer.h

Go to the documentation of this file.

/*
 * message-buffer.h
 *
 * Copyright (C) 2007,2009   Thomas A. Vaughan
 * All rights reserved.
 *
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *     * Neither the name of the <organization> nor the
 *       names of its contributors may be used to endorse or promote products
 *       derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THOMAS A. VAUGHAN ''AS IS'' AND ANY
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THOMAS A. VAUGHAN BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 *
 * Defines a message buffer object that is intended to be used to send messages
 * up and down the networking stack while avoiding copies.
 *
 * Basically a wrapper on top of a std::vector<> of characters.
 */

#ifndef WAVEPACKET_NETLIB_MSGBUF_H__
#define WAVEPACKET_NETLIB_MSGBUF_H__

// includes --------------------------------------------------------------------
#include "common/common.h"
#include "threadsafe/smart_ptr.h"


namespace netlib {

/// \ingroup netlib
/*@{*/


/// basic message object (used for incoming and outgoing messages)
class MessageBuffer {
public:
        // virtual destructor --------------------------------------------------
        virtual ~MessageBuffer(void) throw();

        // netlib::MessageBuffer class interface methods -----------------------
        virtual long getBytes(void) const throw() = 0;
        virtual const char * getData(void) const throw() = 0;
        virtual bool isClosed(void) const throw() = 0;
        virtual void reserve(IN long bytes) = 0;
        virtual void appendData(IN const char * data,
                                IN long bytes) = 0;
        virtual void appendToken(IN const char * token) = 0;
        virtual void close(void) = 0;   // message buffer is constructed

        // static factory methods ----------------------------------------------
        static smart_ptr<MessageBuffer> create(void);
};



};      // netlib namespace

#endif  // WAVEPACKET_NETLIB_MSGBUF_H__