Apocalypse mirror Sourceforge mirror

			News | Info | Characters | Arenas | Screenshots | Forums | Download
	Developer:		Making of | Character-HOWTO | AI Design | Submit a Character
	Documentation:		| | | |

OnlineChatBE.h

Go to the documentation of this file.

//
// C++ Interface: onlinechatbe
//
// Description: 
//
//
// Author: upi <upi@apocalypse.rulez.org>, (C) 2004
//
// Copyright: See COPYING file that comes with this distribution
//
//
#ifndef ONLINECHATBE_H
#define ONLINECHATBE_H


#include <string>


class IOnlineEventSink;
struct SOnlineChatBE_P;

class IOnlineChatBE
{
public:
    enum ConnectionStateEnum
    {
        CS_Disconnected,                    
        CS_Connecting,                      
        CS_Connected,                       
        CS_Disconnecting,
    };
    
    enum ClientModeEnum
    {
        CM_Chatroom,                        
        CM_Game,                            
        CM_Away,                            
        CM_WaitingForChallenge,             
    };
    
    enum ChatEventEnum
    {
        CE_Nothing,
        CE_MyNick,                          
        CE_Challenge,                       
        CE_Message,                         
        CE_Joins,                           
        CE_Leaves,                          
        CE_NickChange,                      
        CE_ServerMessage,                   
    };
    
    struct UserInfo
    {
        std::string     m_sNick;            
        ClientModeEnum  m_enClientMode;     
        std::string     m_sHostName;        
        std::string     m_sHostAddress;     
        
        UserInfo();
        UserInfo( const UserInfo& a_roRhs );
        UserInfo& operator=( const UserInfo& a_roRhs );
    };
    
    struct SChatEvent
    {
        ChatEventEnum   m_enEvent;
        UserInfo        m_sUser;
        std::string     m_sMessage;
    };
    
protected:
    
    // Lifecycle control
                        IOnlineChatBE() {}
    virtual             ~IOnlineChatBE() {}

public:
    static void         create();
    
    // Connection
    
    virtual void                connect( std::string a_sNick ) = 0;
    virtual void                disconnect() = 0;
    virtual ConnectionStateEnum getConnectionState() const = 0;
    
    // Getting/setting my connection parameters
    
    virtual std::string         getMyNick() const = 0;
    virtual void                setMyNick( std::string a_sNick ) = 0;
    virtual ClientModeEnum      getMyClientMode() const = 0;
    virtual void                setMyClientMode( ClientModeEnum a_enClientMode ) = 0;
    virtual const UserInfo&     getMyUserInfo() const = 0;              
    
    // User control
    
    virtual int                 getUserCount() const = 0;
    virtual const UserInfo&     getUserInfo( int a_iUserNumber ) const = 0;
    virtual ClientModeEnum      getClientMode() const = 0;
    virtual void                setClientMode( ClientModeEnum a_newMode ) = 0;
    
    // Event sinks
    
    virtual void                addEventSink( IOnlineEventSink* a_poSink ) = 0;
    virtual void                removeEventSink( IOnlineEventSink* a_poSink ) = 0;
    virtual void                removeAllEventSinks() = 0;
};


extern IOnlineChatBE*   g_poChatBE;



class IOnlineEventSink
{
public:
                        IOnlineEventSink() {}
    virtual             ~IOnlineEventSink() {}
    
    virtual void        receiveEvent( const IOnlineChatBE::SChatEvent& a_roEvent ) = 0;
    virtual void        connectionStateChange( IOnlineChatBE::ConnectionStateEnum a_enOldState, 
                                               IOnlineChatBE::ConnectionStateEnum a_enNewState,
                                               const std::string& a_rsMessage ) = 0;
};




#endif

---