message.h

Go to the documentation of this file.

/*
 * message.h
 *
 * Copyright (C) 2007,2008  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.
 *
 *
 * Game message objects.  Any client/server message will be representable as a
 * message object.
 *
 * A aesop message is a serialized datahash (see the datahash_stream.h header in
 * the utility library).
 *
 * A aesop message must have a "header" subhash containing the namespace and
 * command.  Then there must also be a "data" subhash containing the command
 * arguments.
 */

#ifndef AESOP_AESOP_PROTO_MESSAGE_H__
#define AESOP_AESOP_PROTO_MESSAGE_H__

// includes --------------------------------------------------------------------
#include "netlib/netlib.h"


// forward declarations
class Datahash;


namespace aesop {

/// \ingroup aesop_proto
/*@{*/


///     A tcp_payload_t consists of a namespace, a command, and then a hash of
///     arguments.
struct tcp_payload_t {
        // constructor, manipulators
        tcp_payload_t(void) throw() { this->clear(); }
        void clear(void) throw() {
                        namespace_.clear();
                        command.clear();
                        arguments = NULL;
                }
        bool is_empty(void) const throw() {
                        return !arguments;
                }

        // data fields
        std::string             namespace_;
        std::string             command;
        smart_ptr<Datahash>     arguments;
};



/// construct a tcp_payload_t from low-level netlib::MessageBuffer data
void getTcpPayload(IN const char * data,
                                OUT tcp_payload_t& payload);



};      // aesop namespace

#endif  // AESOP_AESOP_PROTO_MESSAGE_H__