chatsession.h

Go to the documentation of this file.

/********************************************************************************************
* Twitch Broadcasting SDK
*
* This software is supplied under the terms of a license agreement with Twitch Interactive, Inc. and
* may not be copied or used except in accordance with the terms of that agreement
* Copyright (c) 2012-2016 Twitch Interactive, Inc.
*********************************************************************************************/

#ifndef TTVSDK_CHATSESSION_H
#define TTVSDK_CHATSESSION_H

#include "twitchsdk/core/types/coretypes.h"
#include "twitchsdk/core/types/errortypes.h"

#include "twitchsdk/chat/internal/chatnetworkevent.h"


namespace ttv
{
    namespace chat
    {
        class ChatSession;
        class ChatChannel;
    }
}

class ttv::chat::ChatSession : public IChatReceiveNetworkEvent
{
public:
    ChatSession();
    ~ChatSession();

    void SetWriter(std::shared_ptr<IChatWriteNetworkEvent> writer);

    void AddEventHandler(IChatReceiveNetworkEvent* handler);
    void RemoveEventHandler(IChatReceiveNetworkEvent* handler);

    void Cap(const std::string& subCommand, const std::string& capabilities);                                   
    void Pass(const std::string& pass);                                                                     
    void User(const std::string& nick, const std::string& name);                                                
    void TwitchClient();                                                                                    
    void Nick(const std::string& nick);                                                                     
    void Join(const std::string& channel, const std::string& key = std::string());                              
    void Part(const std::string& channel, const std::string& msg = std::string());                              
    void Kick(const std::string& channel, const std::string& user, const std::string& reason = std::string());  
    void Invite(const std::string& user, const std::string& channel);                                           
    void Topic(const std::string& channel, const std::string& topic = std::string());                           
    void PrivMsg(const std::string& target, const std::string& msg);                                            
    void Action(const std::string& target, const std::string& msg);                                         
    void Notice(const std::string& target, const std::string& msg);                                         
    void CTCP(const std::string& target, const std::string& cmd, const std::string& msg = std::string());       
    void CTCPReply(const std::string& target, const std::string& cmd, const std::string& msg = std::string());
    void CTCPPing(const std::string& target);
    void Whois(const std::string& target);
    void Mode(const std::string& target, const std::string& modes);
    void UserHost(const std::string& user);
    void Quit(const std::string& msg);                                                                      
    void Away(const std::string& msg);
    void Raw(const std::string& text);
    void Ping(const std::string& target);                                                                   
    void Pong(const std::string& target);                                                                   
    void List();

    const std::string& GetNick() const;
    void SetNick(const std::string& nick);
    bool IsMe(const std::string& nick);

    bool IsConnected() { return mConnected; }
    uint64_t GetIdleTime();

    std::string GetChannelTypes();
    void GetChannelUserModes(std::string* letters, std::string* symbols);

    bool HasServerCapability(const std::string& cap);
    std::string GetServerCapability(const std::string& cap);


    // IChatReceiveNetworkEvent implementation ///////////////////////
    virtual void ReceiveEvent(const ChatNetworkEvent& evt);                     

protected:
    void ResetIdleCounter();
    
    // DispatchEvent - Send an event to the display handlers
    void DispatchEvent(const ChatNetworkEvent& evt);

    // DoEvent - Send an outgoing event
    void DoEvent(const ChatNetworkEvent& evt);

    void InitDefaultServerCapabilities();

    void OnConnect(const ChatNetworkEvent& evt);
    void OnDisconnect(const ChatNetworkEvent& evt);

    void OnJoin(const ChatNetworkEvent& evt);
    void OnPart(const ChatNetworkEvent& evt);
    void OnKick(const ChatNetworkEvent& evt);
    void OnNick(const ChatNetworkEvent& evt);
    void OnQuit(const ChatNetworkEvent& evt);
    void OnPing(const ChatNetworkEvent& evt);
    void OnMode(const ChatNetworkEvent& evt);

    void OnCTCPPing(const ChatNetworkEvent& evt);
    void OnCTCPVersion(const ChatNetworkEvent& evt);
    void OnCTCPRplPing(const ChatNetworkEvent& evt);

    void OnRplNamReply(const ChatNetworkEvent& evt);
    void OnRplWelcome(const ChatNetworkEvent& evt);
    void OnRplProtoCtl(const ChatNetworkEvent& evt);
    void OnRplListStart(const ChatNetworkEvent& evt);
    void OnRplList(const ChatNetworkEvent& evt);

private:
    std::map<std::string, std::string> m_mapServerCaps;

    std::string mNick;
    std::vector<IChatReceiveNetworkEvent*> mEventHandlers;  

    std::shared_ptr<IChatWriteNetworkEvent> mWriter; 

    uint64_t mLastActivity;
    bool mConnected;
};

#endif // TTVSDK_CHATSESSION_H