Kodi Documentation 22.0
Kodi is an open source media player and entertainment hub.
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
PVR::CPVRProvidersContainer Class Reference

#include <PVRProviders.h>

Inheritance diagram for PVR::CPVRProvidersContainer:
PVR::CPVRProviders

Public Member Functions

bool UpdateFromClient (const std::shared_ptr< CPVRProvider > &provider)
 Add a provider to this container or update the provider if already present in this container.
 
std::shared_ptr< CPVRProvider > GetByClient (int iClientId, int iUniqueId) const
 Get the provider denoted by given client id and unique client provider id.
 
std::vector< std::shared_ptr< CPVRProvider > > GetProvidersList () const
 
std::size_t GetNumProviders () const
 

Protected Member Functions

void InsertEntry (const std::shared_ptr< CPVRProvider > &newProvider, ProviderUpdateMode updateMode)
 

Protected Attributes

CCriticalSection m_critSection
 
int m_iLastId = 0
 
std::vector< std::shared_ptr< CPVRProvider > > m_providers
 

Member Function Documentation

◆ GetByClient()

std::shared_ptr< CPVRProvider > CPVRProvidersContainer::GetByClient ( int iClientId,
int iUniqueId ) const

Get the provider denoted by given client id and unique client provider id.

Parameters
iClientIdThe client id.
iUniqueIdThe client provider id.
Returns
the provider if found, null otherwise.

◆ GetNumProviders()

std::size_t CPVRProvidersContainer::GetNumProviders ( ) const

Get the number of providers in this container

Returns
The total number of providers

◆ GetProvidersList()

std::vector< std::shared_ptr< CPVRProvider > > CPVRProvidersContainer::GetProvidersList ( ) const

Get all providers in this container

Returns
The list of all providers

◆ InsertEntry()

void CPVRProvidersContainer::InsertEntry ( const std::shared_ptr< CPVRProvider > & newProvider,
ProviderUpdateMode updateMode )
protected

◆ UpdateFromClient()

bool CPVRProvidersContainer::UpdateFromClient ( const std::shared_ptr< CPVRProvider > & provider)

Add a provider to this container or update the provider if already present in this container.

Parameters
Theprovider
Returns
True, if the update was successful. False, otherwise.

Member Data Documentation

◆ m_critSection

CCriticalSection PVR::CPVRProvidersContainer::m_critSection
mutableprotected

◆ m_iLastId

int PVR::CPVRProvidersContainer::m_iLastId = 0
protected

◆ m_providers

std::vector<std::shared_ptr<CPVRProvider> > PVR::CPVRProvidersContainer::m_providers
protected
The documentation for this class was generated from the following files: