wavelength 1.0.0
Loading...
Searching...
No Matches
ClearGameListFilterTask Class Reference

Step that clears each filter of LobbyRT::mActiveFilters whose field LobbyRT::mFilters does not filter. More...

#include <cleargamelistfiltertask.h>

Inheritance diagram for ClearGameListFilterTask:
Collaboration diagram for ClearGameListFilterTask:

Public Member Functions

 ~ClearGameListFilterTask () override=default
 Destroy the object.
Public Member Functions inherited from NetTask
 NetTask ()
 Construct a task outside any NetMultiTask.
void Finish (bool bSucceeded, int nResult)
 End the task, and record a failure in the result of the NetMultiTask that runs it.
NetMultiTask * GetParent () const
void SetParent (NetMultiTask *pParent)
 Set the NetMultiTask that runs the task.
Public Member Functions inherited from Task
 Task ()
 Construct an idle task.
virtual ~Task ()
 Release the task.
int Poll ()
 Report the state after giving a running task one poll.
void Start ()
 Enter the running state and call OnStart(), unless the task is already running.
void Stop ()
 Call OnStop() when the task is running, and return to the idle state.
void Finish (bool bSucceeded)
 End the task from outside its poll, and call OnStop() when it was running.
int GetState () const
 Report mState.

Static Public Member Functions

static void OnResponse (int nConnection, int nType, int nSize, const rtMediusResponse *pResponse)
 Count down the requests of the step the response is tagged with, and finish it after an error or the last response.
static bool HasField (int nField, const std::vector< RTFilter > *pFilters)
 Report whether a list of filters filters a field.
Static Public Member Functions inherited from NetTask
static void MakeTag (NetTask *pTask, char *pszTag)
 Create the next tag of a task and copy its text.
static void RemoveTag (NetTask *pTask)
 Remove the first tag of a task.
static NetTask * FindTag (const char *pszTag)
 Find the task of a tag.

Protected Member Functions

void OnStart () override
 Send a request for each filter to clear, or finish when there is none.
Protected Member Functions inherited from NetTask
void OnStop () override
 Remove the tag of the task.
Protected Member Functions inherited from Task
virtual void OnPoll ()
 Advance the work, and set mState to kStateDone when it finishes.

Additional Inherited Members

Public Types inherited from Task
enum  State { kStateIdle = 0 , kStateRunning = 1 , kStateDone = 2 , kStateFailed = 3 }
 Values of mState. More...
Static Public Attributes inherited from NetTask
static std::list< NetTaskTag > sTags
 The tags MakeTag() created and RemoveTag() has not removed.
static int sNextTag
 The number the next tag takes.

Detailed Description

Step that clears each filter of LobbyRT::mActiveFilters whose field LobbyRT::mFilters does not filter.

The RTTI includes the name and records NetTask as the base. The vtable is at 0x003d51b8 and the object is 0x10 bytes. The step fails with JoinChatroomResultMsg::kResultFailed.

Constructor & Destructor Documentation

◆ ~ClearGameListFilterTask()

ClearGameListFilterTask::~ClearGameListFilterTask ( )
overridedefault

Destroy the object.

Ghidra address:
NTSC-U/C: 0x0039c6b0
Ghidra address:
PAL: 0x0040b368

Member Function Documentation

◆ OnResponse()

void ClearGameListFilterTask::OnResponse ( int nConnection,
int nType,
int nSize,
const rtMediusResponse * pResponse )
static

Count down the requests of the step the response is tagged with, and finish it after an error or the last response.

The name is inferred.

Parameters
nConnectionThe connection.
nTypeThe kind of response.
nSizeThe size of the response.
pResponseThe response.
Ghidra address:
NTSC-U/C: 0x002664d0
Ghidra address:
PAL: 0x0026ffe8

◆ HasField()

bool ClearGameListFilterTask::HasField ( int nField,
const std::vector< RTFilter > * pFilters )
static

Report whether a list of filters filters a field.

The name is inferred.

Parameters
nFieldOne of RTFilter::Field.
pFiltersThe filters.
Returns
Whether a filter has the field.
Ghidra address:
NTSC-U/C: 0x00266360
Ghidra address:
PAL: 0x0026fe78

◆ OnStart()

void ClearGameListFilterTask::OnStart ( )
overrideprotectedvirtual

Send a request for each filter to clear, or finish when there is none.

Ghidra address:
NTSC-U/C: 0x002663a0
Ghidra address:
PAL: 0x0026feb8

Reimplemented from Task.


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