Kodi Documentation 22.0
Kodi is an open source media player and entertainment hub.
Loading...
Searching...
No Matches
CZeroconfBrowser Class Referenceabstract

this class provides support for zeroconf browsing More...

#include <ZeroconfBrowser.h>

Inheritance diagram for CZeroconfBrowser:
CZeroconfBrowserAndroid CZeroconfBrowserAvahi CZeroconfBrowserDarwin CZeroconfBrowserDummy CZeroconfBrowserMDNS

Classes

class  ZeroconfService
 

Public Member Functions

void Start ()
 
void Stop ()
 
std::vector< ZeroconfServiceGetFoundServices ()
 
bool ResolveService (ZeroconfService &fr_service, double f_timeout=1.0)
 
virtual void ProcessResults ()
 

Static Public Member Functions

static CZeroconfBrowserGetInstance ()
 
static void ReleaseInstance ()
 
static bool IsInstantiated ()
 
bool AddServiceType (const std::string &fcr_service_type)
 
bool RemoveServiceType (const std::string &fcr_service_type)
 
 CZeroconfBrowser ()
 
 CZeroconfBrowser (const CZeroconfBrowser &)=delete
 
CZeroconfBrowseroperator= (const CZeroconfBrowser &)=delete
 
virtual ~CZeroconfBrowser ()
 
virtual bool doAddServiceType (const std::string &fcr_service_type)=0
 
virtual bool doRemoveServiceType (const std::string &fcr_service_type)=0
 
virtual std::vector< ZeroconfServicedoGetFoundServices ()=0
 
virtual bool doResolveService (ZeroconfService &fr_service, double f_timeout)=0
 

Detailed Description

this class provides support for zeroconf browsing

Constructor & Destructor Documentation

◆ CZeroconfBrowser() [1/2]

CZeroconfBrowser::CZeroconfBrowser ( )
protected

◆ CZeroconfBrowser() [2/2]

CZeroconfBrowser::CZeroconfBrowser ( const CZeroconfBrowser & )
protecteddelete

◆ ~CZeroconfBrowser()

CZeroconfBrowser::~CZeroconfBrowser ( )
protectedvirtual

Member Function Documentation

◆ AddServiceType()

bool CZeroconfBrowser::AddServiceType ( const std::string & fcr_service_type)

methods for browsing and getting results of it

adds a service type for browsing

Parameters
fcr_service_typethe service type as string, e.g. _smb._tcp.
Returns
false if it was already there

◆ doAddServiceType()

virtual bool CZeroconfBrowser::doAddServiceType ( const std::string & fcr_service_type)
protectedpure virtual

Implemented in CZeroconfBrowserAndroid.

◆ doGetFoundServices()

virtual std::vector< ZeroconfService > CZeroconfBrowser::doGetFoundServices ( )
protectedpure virtual

Implemented in CZeroconfBrowserAndroid.

◆ doRemoveServiceType()

virtual bool CZeroconfBrowser::doRemoveServiceType ( const std::string & fcr_service_type)
protectedpure virtual

Implemented in CZeroconfBrowserAndroid.

◆ doResolveService()

virtual bool CZeroconfBrowser::doResolveService ( ZeroconfService & fr_service,
double f_timeout )
protectedpure virtual

Implemented in CZeroconfBrowserAndroid.

◆ GetFoundServices()

std::vector< CZeroconfBrowser::ZeroconfService > CZeroconfBrowser::GetFoundServices ( )

returns the list of found services if this is updated, the following message with "zeroconf://" as path is sent: CGUIMessage message(GUI_MSG_NOTIFY_ALL, 0, 0, GUI_MSG_UPDATE_PATH);

◆ GetInstance()

CZeroconfBrowser * CZeroconfBrowser::GetInstance ( )
static

◆ IsInstantiated()

static bool CZeroconfBrowser::IsInstantiated ( )
inlinestatic

◆ operator=()

CZeroconfBrowser & CZeroconfBrowser::operator= ( const CZeroconfBrowser & )
protecteddelete

◆ ProcessResults()

virtual void CZeroconfBrowser::ProcessResults ( )
inlinevirtual

◆ ReleaseInstance()

void CZeroconfBrowser::ReleaseInstance ( )
static

◆ RemoveServiceType()

bool CZeroconfBrowser::RemoveServiceType ( const std::string & fcr_service_type)

remove the specified service from discovery

Parameters
fcr_service_typethe service type as string, e.g. _smb._tcp.
Returns
if it was not found

◆ ResolveService()

bool CZeroconfBrowser::ResolveService ( ZeroconfService & fr_service,
double f_timeout = 1.0 )

◆ Start()

void CZeroconfBrowser::Start ( )

◆ Stop()

void CZeroconfBrowser::Stop ( )

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