Kodi Documentation 22.0
Kodi is an open source media player and entertainment hub.
No Matches
PingResponseWaiter Class Reference
Inheritance diagram for PingResponseWaiter:
WaitCondition IJobCallback

Public Member Functions

 PingResponseWaiter (bool async, const CWakeOnAccess::WakeUpEntry &server)
 ~PingResponseWaiter () override
bool SuccessWaiting () const override
void OnJobComplete (unsigned int jobID, bool success, CJob *job) override
 The callback used when a job completes.
- Public Member Functions inherited from WaitCondition
virtual ~WaitCondition ()=default

Static Public Member Functions

static bool Ping (const CWakeOnAccess::WakeUpEntry &server, unsigned timeOutMs=2000)

Constructor & Destructor Documentation

◆ PingResponseWaiter()

PingResponseWaiter::PingResponseWaiter ( bool async,
const CWakeOnAccess::WakeUpEntry & server )

◆ ~PingResponseWaiter()

PingResponseWaiter::~PingResponseWaiter ( )

Member Function Documentation

◆ OnJobComplete()

void PingResponseWaiter::OnJobComplete ( unsigned int jobID,
bool success,
CJob * job )

The callback used when a job completes.

OnJobComplete is called at the completion of the job's DoWork() function, and is used to return information to the caller on the result of the job. On returning form this function the CJobManager will destroy this job.

jobIDthe unique id of the job (as retrieved from CJobManager::AddJob)
successthe result from the DoWork call
jobthe job that has been processed. The job will be destroyed after this function returns
See also
CJobManager and CJob

Implements IJobCallback.

◆ Ping()

static bool PingResponseWaiter::Ping ( const CWakeOnAccess::WakeUpEntry & server,
unsigned timeOutMs = 2000 )

◆ SuccessWaiting()

bool PingResponseWaiter::SuccessWaiting ( ) const

Reimplemented from WaitCondition.

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