protocol.h

Go to the documentation of this file.

/*
 * protocol.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.
 *
 *
 * The aesop protocol.  The interface by which the server
 * communicates with aesop clients, and vice-versa.
 */

#ifndef AESOP_AESOP_PROTO_PROTOCOL_H__
#define AESOP_AESOP_PROTO_PROTOCOL_H__

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

#include "aesop-base/errors.h"


// forward declaration
class Datahash;


namespace aesop {










enum eDefaultPorts {
        // client-side ports
        eDefaultPort_clientUdp          = 20051, 

        // server-side ports
        eDefaultPort_serverUdp          = 20050, 
        eDefaultPort_serverTcp          = 20051, 

        // keep this last
        eDefaultPort_Invalid            = 0
};



//
//      protocol message creation helpers
//

smart_ptr<netlib::MessageBuffer> createTcpConnectMessage(
                                IN long token);

// general notification from server to client of errors
smart_ptr<netlib::MessageBuffer> createNotifyErrorMessage(
                                IN eErrorCode errorCode,
                                IN const char * message);

smart_ptr<netlib::MessageBuffer> createConversationDialogMessage(
                                IN int localPlayerId,
                                IN const char * conversationGuid,
                                IN int dialogId,
                                IN const char * dialogData);

smart_ptr<netlib::MessageBuffer> createConversationReplyMessage(
                                IN int localPlayerId,
                                IN const char * conversationGuid,
                                IN int dialogId,
                                IN const char * reply);

smart_ptr<netlib::MessageBuffer> createRefreshConversationMessage(
                                IN int localPlayerId,
                                IN const char * conversationGuid);

smart_ptr<netlib::MessageBuffer> createTerminateConversationMessage(
                                IN int localPlayerId,
                                IN const char * conversationGuid);


smart_ptr<netlib::MessageBuffer> createNewGameMessage(
                                IN int localPlayerId);


};      // aesop namespace



#endif  // AESOP_AESOP_PROTO_PROTOCOL_H__