C4LeagueClient Class Reference

#include <C4League.h>

Inheritance diagram for C4LeagueClient:

Collaboration diagram for C4LeagueClient:

Public Types
enum	ResponseType { NoPreference , XML }

Public Member Functions
	C4LeagueClient ()
const char *	getCSID () const
C4LeagueAction	getCurrentAction () const
void	ResetCurrentAction ()
bool	Start (const C4Network2Reference &Ref)
bool	GetStartReply (StdStrBuf *pMessage, StdStrBuf *pLeague, StdStrBuf *pStreamingAddr, int32_t *pSeed, int32_t *pMaxPlayers)
bool	Update (const C4Network2Reference &Ref)
bool	GetUpdateReply (StdStrBuf *pMessage, C4ClientPlayerInfos *pPlayerLeagueInfos)
bool	End (const C4Network2Reference &Ref, const char *szRecordName, const BYTE *pRecordSHA)
bool	GetEndReply (StdStrBuf *pMessage, class C4RoundResultsPlayers *pRoundResults)
bool	Auth (const C4PlayerInfo &PlrInfo, const char *szAccount, const char *szPassword, const char *szNewAccount=nullptr, const char *szNewPassword=nullptr, bool fRememberLogin=false)
bool	GetAuthReply (StdStrBuf *pMessage, StdStrBuf *pAUID, StdStrBuf *pAccount, bool *pRegister, StdStrBuf *pLoginToken)
bool	AuthCheck (const C4PlayerInfo &PlrInfo)
bool	GetAuthCheckReply (StdStrBuf *pMessage, const char *szLeague, class C4PlayerInfo *pPlrInfo)
bool	ReportDisconnect (const C4ClientPlayerInfos &rSendPlayerFBIDs, C4LeagueDisconnectReason eReason)
bool	GetReportDisconnectReply (StdStrBuf *pMessage)
bool	QueryReferences ()
bool	GetReferences (C4Network2Reference **&rpReferences, int32_t &rRefCount)
bool	Init ()
bool	Query (const StdBuf &Data, bool fBinary)
bool	Query (const char *szData, bool fBinary)
bool	isBusy () const
bool	isConnected () const
bool	isSuccess () const
size_t	getTotalSize () const
size_t	getDownloadedSize () const
const StdBuf &	getResultBin () const
const char *	getResultString () const
const char *	getURL () const
const char *	getServerName () const
const C4NetIO::addr_t &	getServerAddress () const
virtual const char *	GetError () const
void	ResetError ()
void	Cancel (const char *szReason)
void	Clear ()
bool	SetServer (const char *szServerAddress)
void	SetExpectedResponseType (ResponseType type)
void	SetNotify (class C4InteractiveThread *pnNotify)
bool	Execute (int iMaxTime=-1, pollfd *readyfds=nullptr) override
C4TimeMilliseconds	GetNextTick (C4TimeMilliseconds tNow) override
void	GetFDs (std::vector< struct pollfd > &) override
bool	ExecuteUntil (int iTimeout=-1)
bool	IsSignaled ()
virtual bool	IsLowPriority ()
virtual bool	IsNotify ()
virtual uint32_t	TimerInterval ()

Protected Member Functions
void	SetError (const char *strnError)
void	Changed ()

Protected Attributes
StdCopyBuf	ResultBin
StdCopyStrBuf	ResultString
StdCopyStrBuf	Error

Detailed Description

Definition at line 205 of file C4League.h.

Member Enumeration Documentation

ResponseType

enum C4HTTPClient::ResponseType

inherited

Enumerator
NoPreference
XML

Definition at line 103 of file C4HTTP.h.

{ NoPreference, XML };

Constructor & Destructor Documentation

C4LeagueClient()

C4LeagueClient::C4LeagueClient ( )

inline

Definition at line 214 of file C4League.h.

: C4Network2RefClient(), CSID() { }

Member Function Documentation

Auth()

bool C4LeagueClient::Auth	(	const C4PlayerInfo &	PlrInfo,
		const char *	szAccount,
		const char *	szPassword,
		const char *	szNewAccount = nullptr,
		const char *	szNewPassword = nullptr,
		bool	fRememberLogin = false
	)

Definition at line 405 of file C4League.cpp.

{
    // Build header
    eCurrAction = C4LA_PlrAuth;
    C4LeagueRequestHead Head(eCurrAction);
    Head.SetAuth(szAccount, szPassword, fRememberLogin);
    if (szNewAccount)
        Head.SetNewAccount(szNewAccount);
    if (szNewPassword)
        Head.SetNewPassword(szNewPassword);
    // Create query
    StdStrBuf QueryText = DecompileToBuf<StdCompilerINIWrite>(
                            mkInsertAdapt(
                              mkNamingAdapt(Head, "Request"),
                              mkNamingAdapt(mkDecompileAdapt(PlrInfo), "PlrInfo"),
                              false));
    // Perform query
    return Query(QueryText.getData(), false);
}

References C4LA_PlrAuth, StdStrBuf::getData(), mkDecompileAdapt(), mkInsertAdapt(), mkNamingAdapt(), C4HTTPClient::Query(), C4LeagueRequestHead::SetAuth(), C4LeagueRequestHead::SetNewAccount(), and C4LeagueRequestHead::SetNewPassword().

Referenced by C4Network2::LeaguePlrAuth().

Here is the call graph for this function:

Here is the caller graph for this function:

AuthCheck()

bool C4LeagueClient::AuthCheck

(

const C4PlayerInfo &

PlrInfo

)

Definition at line 455 of file C4League.cpp.

{
    assert(CSID.getLength());
    // Build header
    eCurrAction = C4LA_PlrAuthCheck;
    C4LeagueRequestHead Head(eCurrAction, CSID.getData(), PlrInfo.getAuthID());
    // Create query
    StdStrBuf QueryText = DecompileToBuf<StdCompilerINIWrite>(
                            mkInsertAdapt(
                              mkNamingAdapt(Head, "Request"),
                              mkNamingAdapt(mkDecompileAdapt(PlrInfo), "PlrInfo"),
                              false));
    // Perform query
    return Query(QueryText.getData(), false);
}

References C4LA_PlrAuthCheck, C4PlayerInfo::getAuthID(), StdStrBuf::getData(), StdStrBuf::getLength(), mkDecompileAdapt(), mkInsertAdapt(), mkNamingAdapt(), and C4HTTPClient::Query().

Referenced by C4Network2::LeaguePlrAuthCheck().

Here is the call graph for this function:

Here is the caller graph for this function:

Cancel()

void C4HTTPClient::Cancel ( const char *  szReason )

inherited

Definition at line 277 of file C4HTTP.cpp.

{
    if (CurlHandle)
    {
        curl_multi_remove_handle(MultiHandle, CurlHandle);
        curl_easy_cleanup(CurlHandle);
        CurlHandle = nullptr;
    }
    fBinary = false;
    iDownloadedSize = iTotalSize = 0;
    Error = szReason;
}

References C4HTTPClient::Error.

Referenced by C4HTTPClient::Clear(), C4StartupNetListEntry::Execute(), C4HTTPClient::Query(), C4DownloadDlg::UserClose(), and C4HTTPClient::~C4HTTPClient().

Here is the caller graph for this function:

Changed()

void StdSchedulerProc::Changed ( )

protectedinherited

Definition at line 108 of file StdScheduler.cpp.

{
    auto s = scheduler;
    if (s)
        s->Changed(this);
}

References s.

Referenced by C4NetIOTCP::Accept(), C4NetIOTCP::AddConnectWait(), C4NetIOUDP::AddPeer(), C4NetIOTCP::Listen(), and CStdTimerProc::SetDelay().

Here is the caller graph for this function:

Clear()

void C4HTTPClient::Clear ( )

inherited

Definition at line 290 of file C4HTTP.cpp.

{
    Cancel(nullptr);
    ServerAddr.Clear();
    ResultBin.Clear();
    ResultString.Clear();
}

References C4HTTPClient::Cancel(), StdBuf::Clear(), StdStrBuf::Clear(), C4NetIO::EndpointAddress::Clear(), C4HTTPClient::ResultBin, and C4HTTPClient::ResultString.

Referenced by C4Network2::StreamOut().

Here is the call graph for this function:

Here is the caller graph for this function:

End()

bool C4LeagueClient::End	(	const C4Network2Reference &	Ref,
		const char *	szRecordName,
		const BYTE *	pRecordSHA
	)

Definition at line 375 of file C4League.cpp.

{
    assert(CSID.getLength());
    // Create query
    eCurrAction = C4LA_End;
    C4LeagueRequestHeadEnd Head(eCurrAction, CSID.getData(), szRecordName, pRecordSHA);
    StdStrBuf QueryText = DecompileToBuf<StdCompilerINIWrite>(
                            mkInsertAdapt(
                              mkNamingAdapt(Head, "Request"),
                              mkNamingAdapt(mkDecompileAdapt(Ref), "Reference"),
                              false));
    // Perform query
    return Query(QueryText.getData(), false);
}

References C4LA_End, StdStrBuf::getData(), StdStrBuf::getLength(), mkDecompileAdapt(), mkInsertAdapt(), mkNamingAdapt(), and C4HTTPClient::Query().

Referenced by C4Network2::LeagueEnd().

Here is the call graph for this function:

Here is the caller graph for this function:

Execute()

bool C4HTTPClient::Execute ( int  iMaxTime = -1, pollfd *  readyfds = nullptr  )

overridevirtualinherited

Implements StdSchedulerProc.

Definition at line 59 of file C4HTTP.cpp.

{
    int running;
#ifdef STDSCHEDULER_USE_EVENTS
    // On Windows, StdScheduler doesn't inform us about which fd triggered the
    // event, so we have to check manually.
    if (WaitForSingleObject(Event, 0) == WAIT_OBJECT_0)
    {
        // sockets might be modified during the call to curl_multi_socket_action() below.
        auto sockets_tmp = sockets;
        for (const auto& kv : sockets_tmp)
        {
            auto socket = kv.first;
            WSANETWORKEVENTS NetworkEvents;
            if (WSAEnumNetworkEvents(socket, Event, &NetworkEvents) != SOCKET_ERROR)
            {
                int ev_bitmask = 0;
                if (NetworkEvents.lNetworkEvents & (FD_READ|FD_ACCEPT|FD_CLOSE)) ev_bitmask |= CURL_CSELECT_IN;
                if (NetworkEvents.lNetworkEvents & (FD_WRITE|FD_CONNECT))        ev_bitmask |= CURL_CSELECT_OUT;
                curl_multi_socket_action(MultiHandle, socket, ev_bitmask, &running);
            }
        }
    }
#else
    if (readyfd)
    {
        int ev_bitmask = 0;
        if (readyfd->revents & POLLIN)  ev_bitmask |= CURL_CSELECT_IN;
        if (readyfd->revents & POLLOUT) ev_bitmask |= CURL_CSELECT_OUT;
        if (readyfd->revents & POLLERR) ev_bitmask |= CURL_CSELECT_ERR;
        curl_multi_socket_action(MultiHandle, readyfd->fd, ev_bitmask, &running);
    }
#endif
    else
    {
        curl_multi_socket_action(MultiHandle, CURL_SOCKET_TIMEOUT, 0, &running);
    }
 
    CURLMsg *m;
    do {
        int msgq = 0;
        m = curl_multi_info_read(MultiHandle, &msgq);
        if(m && (m->msg == CURLMSG_DONE)) {
            CURL *e = m->easy_handle;
            assert(e == CurlHandle);
            CurlHandle = nullptr;
            curl_multi_remove_handle(MultiHandle, e);
 
            // Check for errors and notify listeners. Note that curl fills
            // the Error buffer automatically.
            fSuccess = m->data.result == CURLE_OK;
            if (!fSuccess && !*Error.getData())
                Error.Copy(curl_easy_strerror(m->data.result));
            char *ip;
            curl_easy_getinfo(e, CURLINFO_PRIMARY_IP, &ip);
            ServerAddr.SetHost(StdStrBuf(ip));
            if (pNotify)
                pNotify->PushEvent(Ev_HTTP_Response, this);
 
            curl_easy_cleanup(e);
        }
    } while(m);
 
    return true;
}

References StdStrBuf::Copy(), C4HTTPClient::Error, Ev_HTTP_Response, StdStrBuf::getData(), C4InteractiveThread::PushEvent(), C4NetIO::HostAddress::SetHost(), and SOCKET_ERROR.

Referenced by C4DownloadDlg::OnIdle().

Here is the call graph for this function:

Here is the caller graph for this function:

ExecuteUntil()

bool StdSchedulerProc::ExecuteUntil ( int  iTimeout = -1 )

inherited

Definition at line 33 of file StdScheduler.cpp.

{
    // Infinite?
    if (iTimeout < 0)
        for (;;)
            if (!Execute())
                return false;
    // Calculate endpoint
    C4TimeMilliseconds tStopTime = C4TimeMilliseconds::Now() + iTimeout;
    for (;;)
    {
        // Call execute with given timeout
        if (!Execute(std::max(iTimeout, 0)))
            return false;
        // Calculate timeout
        C4TimeMilliseconds tTime = C4TimeMilliseconds::Now();
        if (tTime >= tStopTime)
            break;
        iTimeout = tStopTime - tTime;
    }
    // All ok.
    return true;
}

References StdSchedulerProc::Execute(), and C4TimeMilliseconds::Now().

Referenced by main().

Here is the call graph for this function:

Here is the caller graph for this function:

GetAuthCheckReply()

bool C4LeagueClient::GetAuthCheckReply	(	StdStrBuf *	pMessage,
		const char *	szLeague,
		class C4PlayerInfo *	pPlrInfo
	)

Definition at line 471 of file C4League.cpp.

{
    // Parse response head
    C4LeagueResponseHeadAuthCheck Head;
    if (!CompileFromBuf_LogWarn<StdCompilerINIRead>(mkNamingAdapt(Head, "Response"), ResultString, "Auth Check Reply"))
        return false;
    // Get message and additional data
    if (pMessage)
        pMessage->Copy(Head.getMessage());
    if (szLeague && pPlrInfo)
        pPlrInfo->SetLeagueData(Head.getAccount(), Head.getClanTag(), Head.getScore(szLeague), Head.getRank(szLeague), Head.getRankSymbol(szLeague), Head.getProgressData(szLeague));
    return Head.isSuccess();
}

References StdStrBuf::Copy(), C4LeagueResponseHead::getAccount(), C4LeagueResponseHeadAuthCheck::getClanTag(), C4LeagueResponseHead::getMessage(), C4LeagueResponseHeadAuthCheck::getProgressData(), C4LeagueResponseHeadAuthCheck::getRank(), C4LeagueResponseHeadAuthCheck::getRankSymbol(), C4LeagueResponseHeadAuthCheck::getScore(), C4LeagueResponseHead::isSuccess(), mkNamingAdapt(), C4HTTPClient::ResultString, and C4PlayerInfo::SetLeagueData().

Referenced by C4Network2::LeaguePlrAuthCheck().

Here is the call graph for this function:

Here is the caller graph for this function:

GetAuthReply()

bool C4LeagueClient::GetAuthReply	(	StdStrBuf *	pMessage,
		StdStrBuf *	pAUID,
		StdStrBuf *	pAccount,
		bool *	pRegister,
		StdStrBuf *	pLoginToken
	)

Definition at line 425 of file C4League.cpp.

{
    C4LeagueResponseHead Head;
    if (!CompileFromBuf_LogWarn<StdCompilerINIRead>(mkNamingAdapt(Head, "Response"), ResultString, "Auth Reply"))
        return false;
    // Get message & account
    if (pMessage)
        pMessage->Copy(Head.getMessage());
    if (pAccount)
        pAccount->Copy(Head.getAccount());
    if (pRegister)
        *pRegister = Head.isStatusRegister();
    if (pLoginToken)
        pLoginToken->Copy(Head.getLoginToken());
    // No success?
    if (!Head.isSuccess())
        return false;
    // Check AUID
    if (!Head.getAUID() || !*Head.getAUID())
    {
        pMessage->Ref(LoadResStr("IDS_MSG_LEAGUESERVERREPLYWITHOUTA"));
        return false;
    }
    // Success
    if (pAUID)
        pAUID->Copy(Head.getAUID());
    FBIDList.AddFBID(Head.getFBID(), Head.getAccount());
    return true;
}

References C4LeagueFBIDList::AddFBID(), StdStrBuf::Copy(), C4LeagueResponseHead::getAccount(), C4LeagueResponseHead::getAUID(), C4LeagueResponseHead::getFBID(), C4LeagueResponseHead::getLoginToken(), C4LeagueResponseHead::getMessage(), C4LeagueResponseHead::isStatusRegister(), C4LeagueResponseHead::isSuccess(), LoadResStr(), mkNamingAdapt(), StdStrBuf::Ref(), and C4HTTPClient::ResultString.

Referenced by C4Network2::LeaguePlrAuth().

Here is the call graph for this function:

Here is the caller graph for this function:

getCSID()

const char* C4LeagueClient::getCSID ( ) const

inline

Definition at line 215 of file C4League.h.

{ return CSID.getData(); }

References StdStrBuf::getData().

Here is the call graph for this function:

getCurrentAction()

C4LeagueAction C4LeagueClient::getCurrentAction ( ) const

inline

Definition at line 216 of file C4League.h.

{ return eCurrAction; }

Referenced by C4Network2::Execute(), C4Network2::LeagueUpdateProcessReply(), and C4Network2::LeagueWaitNotBusy().

Here is the caller graph for this function:

getDownloadedSize()

size_t C4HTTPClient::getDownloadedSize ( ) const

inlineinherited

Definition at line 90 of file C4HTTP.h.

{ return iDownloadedSize; }

Referenced by C4DownloadDlg::OnIdle().

Here is the caller graph for this function:

GetEndReply()

bool C4LeagueClient::GetEndReply	(	StdStrBuf *	pMessage,
		class C4RoundResultsPlayers *	pRoundResults
	)

Definition at line 390 of file C4League.cpp.

{
    // Parse response head
    C4LeagueResponseHead Head;
    if (!CompileFromBuf_LogWarn<StdCompilerINIRead>(mkNamingAdapt(Head, "Response"), ResultString, "End Reply"))
        return false;
    // Get message
    if (pMessage)
        pMessage->Copy(Head.getMessage());
    if (pRoundResults)
        CompileFromBuf_LogWarn<StdCompilerINIRead>(mkNamingAdapt(mkNamingAdapt(*pRoundResults, "PlayerInfos"), "Response"), ResultString, "Round Results");
    // Done
    return Head.isSuccess();
}

References StdStrBuf::Copy(), C4LeagueResponseHead::getMessage(), C4LeagueResponseHead::isSuccess(), mkNamingAdapt(), and C4HTTPClient::ResultString.

Referenced by C4Network2::LeagueEnd().

Here is the call graph for this function:

Here is the caller graph for this function:

GetError()

virtual const char* C4HTTPClient::GetError ( ) const

inlinevirtualinherited

Definition at line 96 of file C4HTTP.h.

{ return Error.getData(); }

References C4HTTPClient::Error, and StdStrBuf::getData().

Referenced by C4DownloadDlg::GetError(), C4Network2::InitLeague(), C4Game::InitNetworkFromAddress(), C4Network2::LeagueEnd(), C4Network2::LeaguePlrAuthCheck(), C4Network2::LeagueStart(), C4Network2::LeagueUpdate(), C4Network2::LeagueUpdateProcessReply(), C4StartupNetListEntry::OnReference(), and C4StartupNetListEntry::SetRefQuery().

Here is the call graph for this function:

Here is the caller graph for this function:

GetFDs()

void C4HTTPClient::GetFDs ( std::vector< struct pollfd > &  pollfds )

overridevirtualinherited

Reimplemented from StdSchedulerProc.

Definition at line 135 of file C4HTTP.cpp.

{
    for (const auto& kv : sockets)
    {
        pollfd pfd;
        pfd.fd = kv.first;
        pfd.revents = 0;
        switch (kv.second)
        {
        case CURL_POLL_IN:
            pfd.events = POLLIN; break;
        case CURL_POLL_OUT:
            pfd.events = POLLOUT; break;
        case CURL_POLL_INOUT:
            pfd.events = POLLIN | POLLOUT; break;
        default:
            pfd.events = 0;
        }
        pollfds.push_back(pfd);
    }
}

GetNextTick()

C4TimeMilliseconds C4HTTPClient::GetNextTick ( C4TimeMilliseconds  tNow )

overridevirtualinherited

Reimplemented from StdSchedulerProc.

Definition at line 125 of file C4HTTP.cpp.

{
    long timeout;
    curl_multi_timeout(MultiHandle, &timeout);
    if (timeout < 0)
        timeout = 1000;
    return tNow + timeout;
}

GetReferences()

bool C4Network2RefClient::GetReferences ( C4Network2Reference **&  rpReferences, int32_t &  rRefCount  )

inherited

Definition at line 292 of file C4Network2Reference.cpp.

{
    // Sanity check
    if (isBusy() || !isSuccess()) return false;
    // local update test
    try
    {
        // Create compiler
        StdCompilerINIRead Comp;
        Comp.setInput(ResultString);
        Comp.Begin();
        // Read reference count
        Comp.Value(mkNamingCountAdapt(rRefCount, "Reference"));
        // Create reference array and initialize
        rpReferences = new C4Network2Reference *[rRefCount];
        for (int i = 0; i < rRefCount; i++)
            rpReferences[i] = nullptr;
        // Get references
        Comp.Value(mkNamingAdapt(mkArrayAdaptMap(rpReferences, rRefCount, mkPtrAdaptNoNull<C4Network2Reference>), "Reference"));
        mkPtrAdaptNoNull<C4Network2Reference>(*rpReferences);
        // Done
        Comp.End();
    }
    catch (StdCompiler::Exception *pExc)
    {
        SetError(pExc->Msg.getData());
        return false;
    }
    // Set source ip
    for (int i = 0; i < rRefCount; i++)
        rpReferences[i]->SetSourceAddress(getServerAddress());
    // Done
    ResetError();
    return true;
}

References StdCompilerINIRead::Begin(), StdCompilerINIRead::End(), StdStrBuf::getData(), C4HTTPClient::getServerAddress(), C4HTTPClient::isBusy(), C4HTTPClient::isSuccess(), mkArrayAdaptMap(), mkNamingAdapt(), mkNamingCountAdapt(), StdCompiler::Exception::Msg, C4HTTPClient::ResetError(), C4HTTPClient::ResultString, C4HTTPClient::SetError(), StdCompilerINIRead::setInput(), and StdCompiler::Value().

Referenced by C4Game::InitNetworkFromAddress(), and C4StartupNetListEntry::OnReference().

Here is the call graph for this function:

Here is the caller graph for this function:

GetReportDisconnectReply()

bool C4LeagueClient::GetReportDisconnectReply

(

StdStrBuf *

pMessage

)

Definition at line 500 of file C4League.cpp.

{
    // Parse response head
    C4LeagueResponseHead Head;
    if (!CompileFromBuf_LogWarn<StdCompilerINIRead>(mkNamingAdapt(Head, "Response"), ResultString, "Report Disconnect"))
        return false;
    // Get message
    if (pMessage)
        pMessage->Copy(Head.getMessage());
    // Done
    return Head.isSuccess();
}

References StdStrBuf::Copy(), C4LeagueResponseHead::getMessage(), C4LeagueResponseHead::isSuccess(), mkNamingAdapt(), and C4HTTPClient::ResultString.

Referenced by C4Network2::LeagueNotifyDisconnect().

Here is the call graph for this function:

Here is the caller graph for this function:

getResultBin()

const StdBuf& C4HTTPClient::getResultBin ( ) const

inlineinherited

Definition at line 91 of file C4HTTP.h.

{ assert(fBinary); return ResultBin; }

References C4HTTPClient::ResultBin.

Referenced by C4DownloadDlg::ShowModal().

Here is the caller graph for this function:

getResultString()

const char* C4HTTPClient::getResultString ( ) const

inlineinherited

Definition at line 92 of file C4HTTP.h.

{ assert(!fBinary); return ResultString.getData(); }

References StdStrBuf::getData(), and C4HTTPClient::ResultString.

Here is the call graph for this function:

getServerAddress()

const C4NetIO::addr_t& C4HTTPClient::getServerAddress ( ) const

inlineinherited

Definition at line 95 of file C4HTTP.h.

{ return ServerAddr; }

Referenced by C4Network2RefClient::GetReferences().

Here is the caller graph for this function:

getServerName()

const char* C4HTTPClient::getServerName ( ) const

inlineinherited

Definition at line 94 of file C4HTTP.h.

{ return ServerName.getData(); }

References StdStrBuf::getData().

Referenced by C4StartupNetListEntry::GetJoinAddress(), C4Network2::LeagueEnd(), C4Network2::LeaguePlrAuth(), C4Network2::LeagueStart(), and C4StartupNetListEntry::SetRefQuery().

Here is the call graph for this function:

Here is the caller graph for this function:

GetStartReply()

bool C4LeagueClient::GetStartReply	(	StdStrBuf *	pMessage,
		StdStrBuf *	pLeague,
		StdStrBuf *	pStreamingAddr,
		int32_t *	pSeed,
		int32_t *	pMaxPlayers
	)

Definition at line 312 of file C4League.cpp.

{
    if (!isSuccess() || eCurrAction != C4LA_Start) return false;
    // Parse response head
    C4LeagueResponseHeadStart Head;
    if (!CompileFromBuf_LogWarn<StdCompilerINIRead>(mkNamingAdapt(Head, "Response"), ResultString, "Start Reply"))
        return false;
    // Get message, league and seed
    if (pMessage)
        pMessage->Copy(Head.getMessage());
    if (pLeague)
        pLeague->Copy(Head.getLeague());
    if (pStreamingAddr)
        pStreamingAddr->Copy(Head.getStreamingAddr());
    if (pSeed && Head.haveSeed())
        *pSeed = Head.getSeed();
    if (pMaxPlayers)
        *pMaxPlayers = Head.getMaxPlayers();
    // No success?
    if (!Head.isSuccess())
        return false;
    // Got no CSID or empty CSID?
    if (!Head.getCSID() || !*Head.getCSID() || *Head.getCSID() == '\0')
    {
        if (pMessage)
            pMessage->Copy(LoadResStr("IDS_LGA_INVALIDRESPONSE3"));
        return false;
    }
    // So save back CSID
    CSID = Head.getCSID();
    return true;
}

References C4LA_Start, StdStrBuf::Copy(), C4LeagueResponseHead::getCSID(), C4LeagueResponseHeadStart::getLeague(), C4LeagueResponseHeadStart::getMaxPlayers(), C4LeagueResponseHead::getMessage(), C4LeagueResponseHeadStart::getSeed(), C4LeagueResponseHeadStart::getStreamingAddr(), C4LeagueResponseHeadStart::haveSeed(), C4HTTPClient::isSuccess(), C4LeagueResponseHead::isSuccess(), LoadResStr(), mkNamingAdapt(), and C4HTTPClient::ResultString.

Referenced by C4Network2::LeagueStart().

Here is the call graph for this function:

Here is the caller graph for this function:

getTotalSize()

size_t C4HTTPClient::getTotalSize ( ) const

inlineinherited

Definition at line 89 of file C4HTTP.h.

{ return iTotalSize; }

Referenced by C4DownloadDlg::OnIdle().

Here is the caller graph for this function:

GetUpdateReply()

bool C4LeagueClient::GetUpdateReply	(	StdStrBuf *	pMessage,
		C4ClientPlayerInfos *	pPlayerLeagueInfos
	)

Definition at line 360 of file C4League.cpp.

{
    C4LeagueResponseHeadUpdate Reply;
    if (!CompileFromBuf_LogWarn<StdCompilerINIRead>(mkNamingAdapt(Reply, "Response"), ResultString, "Update Reply"))
        return false;
    // Get message
    if (pMessage)
        pMessage->Copy(Reply.getMessage());
    // get plr infos
    if (pPlayerLeagueInfos)
        *pPlayerLeagueInfos = Reply.GetPlrInfos();
    // Success
    return true;
}

References StdStrBuf::Copy(), C4LeagueResponseHead::getMessage(), C4LeagueResponseHeadUpdate::GetPlrInfos(), mkNamingAdapt(), and C4HTTPClient::ResultString.

Referenced by C4Network2::LeagueUpdateProcessReply().

Here is the call graph for this function:

Here is the caller graph for this function:

getURL()

const char* C4HTTPClient::getURL ( ) const

inlineinherited

Definition at line 93 of file C4HTTP.h.

{ return URL.getData(); }

References StdStrBuf::getData().

Referenced by C4DownloadDlg::OnIdle().

Here is the call graph for this function:

Here is the caller graph for this function:

Init()

bool C4HTTPClient::Init ( )

inherited

Definition at line 42 of file C4HTTP.cpp.

{
    MultiHandle = curl_multi_init();
    if (!MultiHandle) return false;
#ifdef STDSCHEDULER_USE_EVENTS
    if ((Event = WSACreateEvent()) == WSA_INVALID_EVENT)
    {
        SetError("could not create socket event");
        curl_multi_cleanup(MultiHandle);
        return false;
    }
#endif
    curl_multi_setopt(MultiHandle, CURLMOPT_SOCKETFUNCTION, &C4HTTPClient::SSocketCallback);
    curl_multi_setopt(MultiHandle, CURLMOPT_SOCKETDATA, this);
    return true;
}

References C4HTTPClient::SetError().

Referenced by C4StartupNetDlg::CheckVersionUpdate(), C4Network2::InitLeague(), C4Game::InitNetworkFromAddress(), C4StartupNetListEntry::SetRefQuery(), C4DownloadDlg::ShowModal(), and C4Network2::StartStreaming().

Here is the call graph for this function:

Here is the caller graph for this function:

isBusy()

bool C4HTTPClient::isBusy ( ) const

inlineinherited

Definition at line 86 of file C4HTTP.h.

{ return !!CurlHandle; }

Referenced by C4StartupNetListEntry::Execute(), C4Network2::Execute(), C4Network2RefClient::GetReferences(), C4Network2UpdateClient::GetUpdateURL(), C4Network2UpdateClient::GetVersion(), C4Game::InitNetworkFromAddress(), C4Network2::LeagueEnd(), C4Network2::LeaguePlrAuth(), C4Network2::LeaguePlrAuthCheck(), C4Network2::LeagueStart(), C4Network2::LeagueUpdate(), C4Network2::LeagueUpdateProcessReply(), C4Network2::LeagueWaitNotBusy(), C4DownloadDlg::OnIdle(), C4StartupNetListEntry::OnReference(), and C4Network2::StreamOut().

Here is the caller graph for this function:

isConnected()

bool C4HTTPClient::isConnected ( ) const

inlineinherited

Definition at line 87 of file C4HTTP.h.

{ return iDownloadedSize + iTotalSize != 0; }

Referenced by C4DownloadDlg::OnIdle().

Here is the caller graph for this function:

IsLowPriority()

virtual bool StdSchedulerProc::IsLowPriority ( )

inlinevirtualinherited

Definition at line 82 of file StdScheduler.h.

{ return false; }

IsNotify()

virtual bool StdSchedulerProc::IsNotify ( )

inlinevirtualinherited

Reimplemented in CStdNotifyProc, and C4NetIO.

Definition at line 83 of file StdScheduler.h.

{ return false; }

IsSignaled()

bool StdSchedulerProc::IsSignaled ( )

inherited

isSuccess()

bool C4HTTPClient::isSuccess ( ) const

inlineinherited

Definition at line 88 of file C4HTTP.h.

{ return fSuccess; }

Referenced by C4Network2RefClient::GetReferences(), GetStartReply(), C4Network2UpdateClient::GetUpdateURL(), C4Network2UpdateClient::GetVersion(), C4Game::InitNetworkFromAddress(), C4Network2::LeagueEnd(), C4Network2::LeaguePlrAuthCheck(), C4Network2::LeagueStart(), C4Network2::LeagueUpdateProcessReply(), C4DownloadDlg::OnIdle(), C4StartupNetListEntry::OnReference(), and C4Network2::StreamOut().

Here is the caller graph for this function:

Query() [1/2]

bool C4HTTPClient::Query ( const char *  szData, bool  fBinary  )

inlineinherited

Definition at line 84 of file C4HTTP.h.

{ return Query(StdBuf(szData, SLen(szData)), fBinary); }

References C4HTTPClient::Query(), and SLen().

Referenced by C4HTTPClient::Query().

Here is the call graph for this function:

Here is the caller graph for this function:

Query() [2/2]

bool C4HTTPClient::Query ( const StdBuf &  Data, bool  fBinary  )

inherited

Definition at line 158 of file C4HTTP.cpp.

{
    if (URL.isNull()) return false;
    // Cancel previous request
    if (CurlHandle)
        Cancel("Cancelled");
    // No result known yet
    ResultString.Clear();
    // store mode
    this->fBinary = fBinary;
    // Create request
    CURL *curl = curl_easy_init();
    if (!curl) return false;
#ifdef C4HTTP_DEBUG
    curl_easy_setopt(curl, CURLOPT_VERBOSE, 1);
#endif
    curl_easy_setopt(curl, CURLOPT_URL, URL.getData());
    curl_easy_setopt(curl, CURLOPT_ACCEPT_ENCODING, "");
    curl_easy_setopt(curl, CURLOPT_USERAGENT, C4ENGINENAME "/" C4VERSION );
    curl_easy_setopt(curl, CURLOPT_TIMEOUT, C4HTTPQueryTimeout);
    curl_slist *headers = nullptr;
    headers = curl_slist_append(headers, "Accept-Charset: utf-8");
    headers = curl_slist_append(headers, FormatString("Accept-Language: %s", Config.General.LanguageEx).getData());
    if (!headerAcceptedResponseType.empty())
        headers = curl_slist_append(headers, headerAcceptedResponseType.c_str());
 
    if (Data.getSize())
    {
        RequestData = Data;
        curl_easy_setopt(curl, CURLOPT_POSTFIELDS, RequestData.getData());
        curl_easy_setopt(curl, CURLOPT_POSTFIELDSIZE, RequestData.getSize());
        // Disable the Expect: 100-Continue header which curl automatically
        // adds for POST requests.
        headers = curl_slist_append(headers, "Expect:");
        headers = curl_slist_append(headers, "Content-Type: text/plain; charset=utf-8");
    }
 
    curl_easy_setopt(curl, CURLOPT_HTTPHEADER, headers);
    curl_easy_setopt(curl, CURLOPT_WRITEFUNCTION, &C4HTTPClient::SWriteCallback);
    curl_easy_setopt(curl, CURLOPT_WRITEDATA, this);
    curl_easy_setopt(curl, CURLOPT_XFERINFOFUNCTION, &C4HTTPClient::SProgressCallback);
    curl_easy_setopt(curl, CURLOPT_XFERINFODATA, this);
    Error.Clear();
    Error.SetLength(CURL_ERROR_SIZE);
    *Error.getMData() = '\0';
    curl_easy_setopt(curl, CURLOPT_ERRORBUFFER, Error.getMData());
 
    curl_multi_add_handle(MultiHandle, curl);
    CurlHandle = curl;
    iDownloadedSize = iTotalSize = 0;
 
    int running;
    curl_multi_socket_action(MultiHandle, CURL_SOCKET_TIMEOUT, 0, &running);
 
    return true;
}

References C4HTTPQueryTimeout, C4HTTPClient::Cancel(), StdStrBuf::Clear(), Config, C4HTTPClient::Error, FormatString(), C4Config::General, StdBuf::getData(), StdStrBuf::getData(), StdStrBuf::getMData(), StdBuf::getSize(), StdStrBuf::isNull(), C4ConfigGeneral::LanguageEx, C4HTTPClient::ResultString, and StdStrBuf::SetLength().

Referenced by Auth(), AuthCheck(), End(), C4Network2RefClient::QueryReferences(), C4Network2UpdateClient::QueryUpdateURL(), ReportDisconnect(), C4DownloadDlg::ShowModal(), Start(), C4Network2::StreamOut(), and Update().

Here is the call graph for this function:

Here is the caller graph for this function:

QueryReferences()

bool C4Network2RefClient::QueryReferences ( )

inherited

Definition at line 286 of file C4Network2Reference.cpp.

{
    // Perform an Query query
    return Query(nullptr, false);
}

References C4HTTPClient::Query().

Referenced by C4Game::InitNetworkFromAddress().

Here is the call graph for this function:

Here is the caller graph for this function:

ReportDisconnect()

bool C4LeagueClient::ReportDisconnect	(	const C4ClientPlayerInfos &	rSendPlayerFBIDs,
		C4LeagueDisconnectReason	eReason
	)

Definition at line 485 of file C4League.cpp.

{
    // Build header
    eCurrAction = C4LA_ReportDisconnect;
    C4LeagueReportDisconnectHead Head(CSID.getData(), eReason);
    // Create query
    StdStrBuf QueryText = DecompileToBuf<StdCompilerINIWrite>(
                            mkInsertAdapt(
                              mkNamingAdapt(Head, "Request"),
                              mkNamingAdapt(DisconnectData(FBIDList, rFeedbackClient), "PlayerInfos"),
                              false));
    // Perform query
    return Query(QueryText.getData(), false);
}

References C4LA_ReportDisconnect, StdStrBuf::getData(), mkInsertAdapt(), mkNamingAdapt(), and C4HTTPClient::Query().

Referenced by C4Network2::LeagueNotifyDisconnect().

Here is the call graph for this function:

Here is the caller graph for this function:

ResetCurrentAction()

void C4LeagueClient::ResetCurrentAction ( )

inline

Definition at line 217 of file C4League.h.

{ eCurrAction = C4LA_None; }

References C4LA_None.

Referenced by C4Network2::LeagueUpdateProcessReply().

Here is the caller graph for this function:

ResetError()

void C4HTTPClient::ResetError ( )

inlineinherited

Definition at line 97 of file C4HTTP.h.

{ Error.Clear(); }

References StdStrBuf::Clear(), and C4HTTPClient::Error.

Referenced by C4Network2RefClient::GetReferences().

Here is the call graph for this function:

Here is the caller graph for this function:

SetError()

void C4HTTPClient::SetError ( const char *  strnError )

inlineprotectedinherited

Definition at line 80 of file C4HTTP.h.

{ Error = strnError; }

References C4HTTPClient::Error.

Referenced by C4Network2RefClient::GetReferences(), C4Network2UpdateClient::GetUpdateURL(), C4Network2UpdateClient::GetVersion(), C4HTTPClient::Init(), and C4HTTPClient::SetServer().

Here is the caller graph for this function:

SetExpectedResponseType()

void C4HTTPClient::SetExpectedResponseType ( C4HTTPClient::ResponseType  type )

inherited

Definition at line 315 of file C4HTTP.cpp.

{
    switch (type)
    {
    case C4HTTPClient::ResponseType::XML:
        headerAcceptedResponseType = "Accept: application/xml";
        break;
    case C4HTTPClient::ResponseType::NoPreference: // fallthrough
    default:
        headerAcceptedResponseType = "";
        break;
    };
}

SetNotify()

void C4HTTPClient::SetNotify ( class C4InteractiveThread *  pnNotify )

inlineinherited

Definition at line 106 of file C4HTTP.h.

{ pNotify = pnNotify; }

Referenced by C4StartupNetDlg::CheckVersionUpdate(), and C4StartupNetListEntry::SetRefQuery().

Here is the caller graph for this function:

SetServer()

bool C4HTTPClient::SetServer ( const char *  szServerAddress )

inherited

Definition at line 298 of file C4HTTP.cpp.

{
    static std::regex HostnameRegex(R"(^(:?[a-z]+:\/\/)?([^/:]+).*)", std::regex::icase);
    std::cmatch match;
    if (std::regex_match(szServerAddress, match, HostnameRegex))
    {
        // CURL validates URLs only on connect.
        URL.Copy(szServerAddress);
        ServerName.Copy(match[2].str().c_str());
        return true;
    }
    // The HostnameRegex above is pretty stupid, so we will reject only very
    // malformed URLs immediately.
    SetError("Malformed URL");
    return false;
}

References StdStrBuf::Copy(), and C4HTTPClient::SetError().

Referenced by C4StartupNetDlg::CheckVersionUpdate(), C4Network2::InitLeague(), C4Game::InitNetworkFromAddress(), C4StartupNetListEntry::SetRefQuery(), C4DownloadDlg::ShowModal(), and C4Network2::StreamOut().

Here is the call graph for this function:

Here is the caller graph for this function:

Start()

bool C4LeagueClient::Start

(

const C4Network2Reference &

Ref

)

Definition at line 298 of file C4League.cpp.

{
    // Create query
    eCurrAction = C4LA_Start;
    C4LeagueRequestHead Head(eCurrAction);
    StdStrBuf QueryText = DecompileToBuf<StdCompilerINIWrite>(
                            mkInsertAdapt(
                              mkNamingAdapt(Head, "Request"),
                              mkNamingAdapt(mkDecompileAdapt(Ref), "Reference"),
                              false));
    // Perform query
    return Query(QueryText.getData(), false);
}

References C4LA_Start, StdStrBuf::getData(), mkDecompileAdapt(), mkInsertAdapt(), mkNamingAdapt(), and C4HTTPClient::Query().

Referenced by C4Network2::LeagueStart().

Here is the call graph for this function:

Here is the caller graph for this function:

TimerInterval()

virtual uint32_t StdSchedulerProc::TimerInterval ( )

inlinevirtualinherited

Reimplemented in CStdTimerProc.

Definition at line 84 of file StdScheduler.h.

{ return 0; }

Update()

bool C4LeagueClient::Update

(

const C4Network2Reference &

Ref

)

Definition at line 345 of file C4League.cpp.

{
    assert(CSID.getLength());
    // Create query
    eCurrAction = C4LA_Update;
    C4LeagueRequestHead Head(eCurrAction, CSID.getData());
    StdStrBuf QueryText = DecompileToBuf<StdCompilerINIWrite>(
                            mkInsertAdapt(
                              mkNamingAdapt(Head, "Request"),
                              mkNamingAdapt(mkDecompileAdapt(Ref), "Reference"),
                              false));
    // Perform query
    return Query(QueryText.getData(), false);
}

References C4LA_Update, StdStrBuf::getData(), StdStrBuf::getLength(), mkDecompileAdapt(), mkInsertAdapt(), mkNamingAdapt(), and C4HTTPClient::Query().

Referenced by C4Network2::LeagueUpdate().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

Error

StdCopyStrBuf C4HTTPClient::Error

protectedinherited

Definition at line 79 of file C4HTTP.h.

Referenced by C4HTTPClient::Cancel(), C4HTTPClient::Execute(), C4HTTPClient::GetError(), C4HTTPClient::Query(), C4HTTPClient::ResetError(), and C4HTTPClient::SetError().

ResultBin

StdCopyBuf C4HTTPClient::ResultBin

protectedinherited

Definition at line 77 of file C4HTTP.h.

Referenced by C4HTTPClient::Clear(), and C4HTTPClient::getResultBin().

ResultString

StdCopyStrBuf C4HTTPClient::ResultString

protectedinherited

Definition at line 78 of file C4HTTP.h.

Referenced by C4HTTPClient::Clear(), GetAuthCheckReply(), GetAuthReply(), GetEndReply(), C4Network2RefClient::GetReferences(), GetReportDisconnectReply(), C4HTTPClient::getResultString(), GetStartReply(), GetUpdateReply(), C4Network2UpdateClient::GetUpdateURL(), C4Network2UpdateClient::GetVersion(), and C4HTTPClient::Query().

---

The documentation for this class was generated from the following files:

• C4League.h
• C4League.cpp