#include <serverbrowser.h>

Inheritance diagram for IServerBrowser:

Collaboration diagram for IServerBrowser:

Classes
class	CServerEntry

Public Types
enum	{ SORT_NAME = 0 , SORT_PING , SORT_MAP , SORT_GAMETYPE , SORT_NUMPLAYERS , SORT_NUMFRIENDS , SORT_FAVORITES }
enum	{ QUICK_SERVERNAME = 1 , QUICK_PLAYER = 2 , QUICK_MAPNAME = 4 }
enum	{ TYPE_INTERNET = 0 , TYPE_LAN , TYPE_FAVORITES , TYPE_FAVORITE_COMMUNITY_1 , TYPE_FAVORITE_COMMUNITY_2 , TYPE_FAVORITE_COMMUNITY_3 , TYPE_FAVORITE_COMMUNITY_4 , TYPE_FAVORITE_COMMUNITY_5 , NUM_TYPES }
enum	{ LAN_PORT_BEGIN = 8303 , LAN_PORT_END = 8310 }

Public Member Functions
virtual void	Refresh (int Type, bool Force=false)=0
virtual bool	IsRefreshing () const =0
virtual bool	IsGettingServerlist () const =0
virtual bool	IsServerlistError () const =0
virtual int	LoadingProgression () const =0
virtual int	NumServers () const =0
virtual const CServerInfo *	Get (int Index) const =0
virtual int	Players (const CServerInfo &Item) const =0
virtual int	Max (const CServerInfo &Item) const =0
virtual int	NumSortedServers () const =0
virtual int	NumSortedPlayers () const =0
virtual const CServerInfo *	SortedGet (int Index) const =0
virtual const std::vector< CCommunity > &	Communities () const =0
virtual const CCommunity *	Community (const char *pCommunityId) const =0
virtual std::vector< const CCommunity * >	SelectedCommunities () const =0
virtual std::vector< const CCommunity * >	FavoriteCommunities () const =0
virtual std::vector< const CCommunity * >	CurrentCommunities () const =0
virtual unsigned	CurrentCommunitiesHash () const =0
virtual bool	DDNetInfoAvailable () const =0
virtual std::optional< SHA256_DIGEST >	DDNetInfoSha256 () const =0
virtual ICommunityCache &	CommunityCache ()=0
virtual const ICommunityCache &	CommunityCache () const =0
virtual IFilterList &	FavoriteCommunitiesFilter ()=0
virtual IFilterList &	CommunitiesFilter ()=0
virtual IFilterList &	CountriesFilter ()=0
virtual IFilterList &	TypesFilter ()=0
virtual const IFilterList &	FavoriteCommunitiesFilter () const =0
virtual const IFilterList &	CommunitiesFilter () const =0
virtual const IFilterList &	CountriesFilter () const =0
virtual const IFilterList &	TypesFilter () const =0
virtual void	CleanFilters ()=0
virtual CServerEntry *	Find (const NETADDR &Addr)=0
virtual int	GetCurrentType ()=0
virtual const char *	GetTutorialServer ()=0
Public Member Functions inherited from IInterface
	IInterface ()
virtual void	Shutdown ()
virtual	~IInterface ()=default

Static Public Member Functions
static const char *	InterfaceName ()

Static Public Attributes
static constexpr const char *	COMMUNITY_DDNET = "ddnet"
static constexpr const char *	COMMUNITY_NONE = "none"
static constexpr const char *	COMMUNITY_COUNTRY_NONE = "none"
static constexpr const char *	COMMUNITY_TYPE_NONE = "None"
static constexpr const char *	COMMUNITY_ALL = "all"
static constexpr const char *	SEARCH_EXCLUDE_TOKEN = ";"

Additional Inherited Members
Protected Member Functions inherited from IInterface
IKernel *	Kernel ()

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Enumerator
LAN_PORT_BEGIN
LAN_PORT_END

◆ anonymous enum

anonymous enum

Enumerator
QUICK_SERVERNAME
QUICK_PLAYER
QUICK_MAPNAME

◆ anonymous enum

anonymous enum

Enumerator
SORT_NAME
SORT_PING
SORT_MAP
SORT_GAMETYPE
SORT_NUMPLAYERS
SORT_NUMFRIENDS
SORT_FAVORITES

◆ anonymous enum

anonymous enum

Enumerator
TYPE_INTERNET
TYPE_LAN
TYPE_FAVORITES
TYPE_FAVORITE_COMMUNITY_1
TYPE_FAVORITE_COMMUNITY_2
TYPE_FAVORITE_COMMUNITY_3
TYPE_FAVORITE_COMMUNITY_4
TYPE_FAVORITE_COMMUNITY_5
NUM_TYPES

Member Function Documentation

◆ CleanFilters()

virtual void IServerBrowser::CleanFilters ( )

pure virtual

Implemented in CServerBrowser.

◆ Communities()

virtual const std::vector< CCommunity > & IServerBrowser::Communities ( ) const

pure virtual

Implemented in CServerBrowser.

◆ CommunitiesFilter() [1/2]

virtual const IFilterList & IServerBrowser::CommunitiesFilter ( ) const

pure virtual

Implemented in CServerBrowser.

◆ CommunitiesFilter() [2/2]

virtual IFilterList & IServerBrowser::CommunitiesFilter ( )

pure virtual

Implemented in CServerBrowser.

◆ Community()

virtual const CCommunity * IServerBrowser::Community ( const char * pCommunityId ) const

pure virtual

Implemented in CServerBrowser.

◆ CommunityCache() [1/2]

virtual const ICommunityCache & IServerBrowser::CommunityCache ( ) const

pure virtual

Implemented in CServerBrowser.

◆ CommunityCache() [2/2]

virtual ICommunityCache & IServerBrowser::CommunityCache ( )

pure virtual

Implemented in CServerBrowser.

◆ CountriesFilter() [1/2]

virtual const IFilterList & IServerBrowser::CountriesFilter ( ) const

pure virtual

Implemented in CServerBrowser.

◆ CountriesFilter() [2/2]

virtual IFilterList & IServerBrowser::CountriesFilter ( )

pure virtual

Implemented in CServerBrowser.

◆ CurrentCommunities()

virtual std::vector< const CCommunity * > IServerBrowser::CurrentCommunities ( ) const

pure virtual

Implemented in CServerBrowser.

◆ CurrentCommunitiesHash()

virtual unsigned IServerBrowser::CurrentCommunitiesHash ( ) const

pure virtual

Implemented in CServerBrowser.

◆ DDNetInfoAvailable()

virtual bool IServerBrowser::DDNetInfoAvailable ( ) const

pure virtual

Implemented in CServerBrowser.

◆ DDNetInfoSha256()

virtual std::optional< SHA256_DIGEST > IServerBrowser::DDNetInfoSha256 ( ) const

pure virtual

Implemented in CServerBrowser.

◆ FavoriteCommunities()

virtual std::vector< const CCommunity * > IServerBrowser::FavoriteCommunities ( ) const

pure virtual

Implemented in CServerBrowser.

◆ FavoriteCommunitiesFilter() [1/2]

virtual const IFilterList & IServerBrowser::FavoriteCommunitiesFilter ( ) const

pure virtual

Implemented in CServerBrowser.

◆ FavoriteCommunitiesFilter() [2/2]

virtual IFilterList & IServerBrowser::FavoriteCommunitiesFilter ( )

pure virtual

Implemented in CServerBrowser.

◆ Find()

virtual CServerEntry * IServerBrowser::Find ( const NETADDR & Addr )

pure virtual

Implemented in CServerBrowser.

◆ Get()

virtual const CServerInfo * IServerBrowser::Get ( int Index ) const

pure virtual

Implemented in CServerBrowser.

◆ GetCurrentType()

virtual int IServerBrowser::GetCurrentType ( )

pure virtual

Implemented in CServerBrowser.

◆ GetTutorialServer()

virtual const char * IServerBrowser::GetTutorialServer ( )

pure virtual

Implemented in CServerBrowser.

◆ InterfaceName()

const char * IServerBrowser::InterfaceName ( )

inlinestatic

◆ IsGettingServerlist()

virtual bool IServerBrowser::IsGettingServerlist ( ) const

pure virtual

Implemented in CServerBrowser.

◆ IsRefreshing()

virtual bool IServerBrowser::IsRefreshing ( ) const

pure virtual

Implemented in CServerBrowser.

◆ IsServerlistError()

virtual bool IServerBrowser::IsServerlistError ( ) const

pure virtual

Implemented in CServerBrowser.

◆ LoadingProgression()

virtual int IServerBrowser::LoadingProgression ( ) const

pure virtual

Implemented in CServerBrowser.

◆ Max()

virtual int IServerBrowser::Max ( const CServerInfo & Item ) const

pure virtual

Implemented in CServerBrowser.

◆ NumServers()

virtual int IServerBrowser::NumServers ( ) const

pure virtual

Implemented in CServerBrowser.

◆ NumSortedPlayers()

virtual int IServerBrowser::NumSortedPlayers ( ) const

pure virtual

Implemented in CServerBrowser.

◆ NumSortedServers()

virtual int IServerBrowser::NumSortedServers ( ) const

pure virtual

Implemented in CServerBrowser.

◆ Players()

virtual int IServerBrowser::Players ( const CServerInfo & Item ) const

pure virtual

Implemented in CServerBrowser.

◆ Refresh()

virtual void IServerBrowser::Refresh	(	int	Type,
		bool	Force = false )

pure virtual

Implemented in CServerBrowser.

◆ SelectedCommunities()

virtual std::vector< const CCommunity * > IServerBrowser::SelectedCommunities ( ) const

pure virtual

Implemented in CServerBrowser.

◆ SortedGet()

virtual const CServerInfo * IServerBrowser::SortedGet ( int Index ) const

pure virtual

Implemented in CServerBrowser.

◆ TypesFilter() [1/2]

virtual const IFilterList & IServerBrowser::TypesFilter ( ) const

pure virtual

Implemented in CServerBrowser.

◆ TypesFilter() [2/2]

virtual IFilterList & IServerBrowser::TypesFilter ( )

pure virtual

Implemented in CServerBrowser.

Member Data Documentation

◆ COMMUNITY_ALL

const char* IServerBrowser::COMMUNITY_ALL = "all"

staticconstexpr

Special community value for country/type filters that affect all communities.

◆ COMMUNITY_COUNTRY_NONE

const char* IServerBrowser::COMMUNITY_COUNTRY_NONE = "none"

staticconstexpr

◆ COMMUNITY_DDNET

const char* IServerBrowser::COMMUNITY_DDNET = "ddnet"

staticconstexpr

◆ COMMUNITY_NONE

const char* IServerBrowser::COMMUNITY_NONE = "none"

staticconstexpr

◆ COMMUNITY_TYPE_NONE

const char* IServerBrowser::COMMUNITY_TYPE_NONE = "None"

staticconstexpr

◆ SEARCH_EXCLUDE_TOKEN

const char* IServerBrowser::SEARCH_EXCLUDE_TOKEN = ";"

staticconstexpr

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

src/engine/serverbrowser.h

Classes

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Additional Inherited Members

Member Enumeration Documentation

◆ anonymous enum

◆ anonymous enum

◆ anonymous enum

◆ anonymous enum

Member Function Documentation

◆ CleanFilters()

◆ Communities()

◆ CommunitiesFilter() [1/2]

◆ CommunitiesFilter() [2/2]

◆ Community()

◆ CommunityCache() [1/2]

◆ CommunityCache() [2/2]

◆ CountriesFilter() [1/2]

◆ CountriesFilter() [2/2]

◆ CurrentCommunities()

◆ CurrentCommunitiesHash()

◆ DDNetInfoAvailable()

◆ DDNetInfoSha256()

◆ FavoriteCommunities()

◆ FavoriteCommunitiesFilter() [1/2]

◆ FavoriteCommunitiesFilter() [2/2]

◆ Find()

◆ Get()

◆ GetCurrentType()

◆ GetTutorialServer()

◆ InterfaceName()

◆ IsGettingServerlist()

◆ IsRefreshing()

◆ IsServerlistError()

◆ LoadingProgression()

◆ Max()

◆ NumServers()

◆ NumSortedPlayers()

◆ NumSortedServers()

◆ Players()

◆ Refresh()

◆ SelectedCommunities()

◆ SortedGet()

◆ TypesFilter() [1/2]

◆ TypesFilter() [2/2]

Member Data Documentation

◆ COMMUNITY_ALL

◆ COMMUNITY_COUNTRY_NONE

◆ COMMUNITY_DDNET

◆ COMMUNITY_NONE

◆ COMMUNITY_TYPE_NONE

◆ SEARCH_EXCLUDE_TOKEN