cricket::PortAllocatorSession Class Reference

#include <portallocator.h>

Inheritance diagram for cricket::PortAllocatorSession:

Public Member Functions
	PortAllocatorSession (const std::string &content_name, int component, const std::string &ice_ufrag, const std::string &ice_pwd, uint32_t flags)
virtual	~PortAllocatorSession ()
uint32_t	flags () const
void	set_flags (uint32_t flags)
std::string	content_name () const
int	component () const
const std::string &	ice_ufrag () const
const std::string &	ice_pwd () const
bool	pooled () const
virtual void	SetCandidateFilter (uint32_t filter)=0
virtual void	StartGettingPorts ()=0
virtual void	StopGettingPorts ()=0
virtual bool	IsGettingPorts ()=0
virtual void	ClearGettingPorts ()=0
virtual bool	IsCleared () const
virtual bool	IsStopped () const
virtual void	RegatherOnFailedNetworks ()
virtual void	RegatherOnAllNetworks ()
virtual std::vector< PortInterface * >	ReadyPorts () const =0
virtual std::vector< Candidate >	ReadyCandidates () const =0
virtual bool	CandidatesAllocationDone () const =0
virtual void	PruneAllPorts ()
virtual uint32_t	generation ()
virtual void	set_generation (uint32_t generation)
	PortAllocatorSession (const std::string &content_name, int component, const std::string &ice_ufrag, const std::string &ice_pwd, uint32_t flags)
virtual	~PortAllocatorSession ()
uint32_t	flags () const
void	set_flags (uint32_t flags)
std::string	content_name () const
int	component () const
const std::string &	ice_ufrag () const
const std::string &	ice_pwd () const
bool	pooled () const
virtual void	SetCandidateFilter (uint32_t filter)=0
virtual void	StartGettingPorts ()=0
virtual void	StopGettingPorts ()=0
virtual bool	IsGettingPorts ()=0
virtual void	ClearGettingPorts ()=0
virtual bool	IsCleared () const
virtual bool	IsStopped () const
virtual void	RegatherOnFailedNetworks ()
virtual void	RegatherOnAllNetworks ()
virtual std::vector< PortInterface * >	ReadyPorts () const =0
virtual std::vector< Candidate >	ReadyCandidates () const =0
virtual bool	CandidatesAllocationDone () const =0
virtual void	PruneAllPorts ()
virtual uint32_t	generation ()
virtual void	set_generation (uint32_t generation)
Public Member Functions inherited from sigslot::has_slots<>
	has_slots ()
	has_slots ()
	~has_slots ()
	~has_slots ()
Public Member Functions inherited from sigslot::has_slots_interface
void	signal_connect (_signal_base_interface *sender)
void	signal_disconnect (_signal_base_interface *sender)
void	disconnect_all ()
void	signal_connect (_signal_base_interface *sender)
void	signal_disconnect (_signal_base_interface *sender)
void	disconnect_all ()

Public Attributes
sigslot::signal2< PortAllocatorSession *, PortInterface * >	SignalPortReady
sigslot::signal2< PortAllocatorSession *, const std::vector< PortInterface * > & >	SignalPortsPruned
sigslot::signal2< PortAllocatorSession *, const std::vector< Candidate > & >	SignalCandidatesReady
sigslot::signal2< PortAllocatorSession *, const std::vector< Candidate > & >	SignalCandidatesRemoved
sigslot::signal1< PortAllocatorSession * >	SignalCandidatesAllocationDone
sigslot::signal2< PortAllocatorSession *, IceRegatheringReason >	SignalIceRegathering
sigslot::signal1< PortAllocatorSession * >	SignalDestroyed

Protected Member Functions
virtual void	UpdateIceParametersInternal ()
const std::string &	username () const
const std::string &	password () const
virtual void	UpdateIceParametersInternal ()
const std::string &	username () const
const std::string &	password () const
Protected Member Functions inherited from sigslot::has_slots_interface
	has_slots_interface (signal_connect_t conn, signal_disconnect_t disc, disconnect_all_t disc_all)
virtual	~has_slots_interface ()
	has_slots_interface (signal_connect_t conn, signal_disconnect_t disc, disconnect_all_t disc_all)
virtual	~has_slots_interface ()

Friends
class	PortAllocator

Constructor & Destructor Documentation

PortAllocatorSession() [1/2]

cricket::PortAllocatorSession::PortAllocatorSession	(	const std::string &	content_name,
		int	component,
		const std::string &	ice_ufrag,
		const std::string &	ice_pwd,
		uint32_t	flags
	)

~PortAllocatorSession() [1/2]

virtual cricket::PortAllocatorSession::~PortAllocatorSession ( )

inlinevirtual

PortAllocatorSession() [2/2]

cricket::PortAllocatorSession::PortAllocatorSession	(	const std::string &	content_name,
		int	component,
		const std::string &	ice_ufrag,
		const std::string &	ice_pwd,
		uint32_t	flags
	)

~PortAllocatorSession() [2/2]

virtual cricket::PortAllocatorSession::~PortAllocatorSession ( )

inlinevirtual

Member Function Documentation

CandidatesAllocationDone() [1/2]

virtual bool cricket::PortAllocatorSession::CandidatesAllocationDone ( ) const

pure virtual

Implemented in cricket::FakePortAllocatorSession, cricket::FakePortAllocatorSession, cricket::BasicPortAllocatorSession, and cricket::BasicPortAllocatorSession.

CandidatesAllocationDone() [2/2]

virtual bool cricket::PortAllocatorSession::CandidatesAllocationDone ( ) const

pure virtual

Implemented in cricket::FakePortAllocatorSession, cricket::FakePortAllocatorSession, cricket::BasicPortAllocatorSession, and cricket::BasicPortAllocatorSession.

ClearGettingPorts() [1/2]

virtual void cricket::PortAllocatorSession::ClearGettingPorts ( )

pure virtual

Implemented in cricket::FakePortAllocatorSession, cricket::FakePortAllocatorSession, cricket::BasicPortAllocatorSession, and cricket::BasicPortAllocatorSession.

ClearGettingPorts() [2/2]

virtual void cricket::PortAllocatorSession::ClearGettingPorts ( )

pure virtual

Implemented in cricket::FakePortAllocatorSession, cricket::FakePortAllocatorSession, cricket::BasicPortAllocatorSession, and cricket::BasicPortAllocatorSession.

component() [1/2]

int cricket::PortAllocatorSession::component ( ) const

inline

component() [2/2]

int cricket::PortAllocatorSession::component ( ) const

inline

content_name() [1/2]

std::string cricket::PortAllocatorSession::content_name ( ) const

inline

content_name() [2/2]

std::string cricket::PortAllocatorSession::content_name ( ) const

inline

flags() [1/2]

uint32_t cricket::PortAllocatorSession::flags ( ) const

inline

flags() [2/2]

uint32_t cricket::PortAllocatorSession::flags ( ) const

inline

generation() [1/2]

virtual uint32_t cricket::PortAllocatorSession::generation ( )

inlinevirtual

generation() [2/2]

virtual uint32_t cricket::PortAllocatorSession::generation ( )

inlinevirtual

ice_pwd() [1/2]

const std::string& cricket::PortAllocatorSession::ice_pwd ( ) const

inline

ice_pwd() [2/2]

const std::string& cricket::PortAllocatorSession::ice_pwd ( ) const

inline

ice_ufrag() [1/2]

const std::string& cricket::PortAllocatorSession::ice_ufrag ( ) const

inline

ice_ufrag() [2/2]

const std::string& cricket::PortAllocatorSession::ice_ufrag ( ) const

inline

IsCleared() [1/2]

virtual bool cricket::PortAllocatorSession::IsCleared ( ) const

inlinevirtual

Reimplemented in cricket::BasicPortAllocatorSession, and cricket::BasicPortAllocatorSession.

IsCleared() [2/2]

virtual bool cricket::PortAllocatorSession::IsCleared ( ) const

inlinevirtual

Reimplemented in cricket::BasicPortAllocatorSession, and cricket::BasicPortAllocatorSession.

IsGettingPorts() [1/2]

virtual bool cricket::PortAllocatorSession::IsGettingPorts ( )

pure virtual

Implemented in cricket::FakePortAllocatorSession, cricket::FakePortAllocatorSession, cricket::BasicPortAllocatorSession, and cricket::BasicPortAllocatorSession.

IsGettingPorts() [2/2]

virtual bool cricket::PortAllocatorSession::IsGettingPorts ( )

pure virtual

Implemented in cricket::FakePortAllocatorSession, cricket::FakePortAllocatorSession, cricket::BasicPortAllocatorSession, and cricket::BasicPortAllocatorSession.

IsStopped() [1/2]

virtual bool cricket::PortAllocatorSession::IsStopped ( ) const

inlinevirtual

Reimplemented in cricket::BasicPortAllocatorSession, and cricket::BasicPortAllocatorSession.

IsStopped() [2/2]

virtual bool cricket::PortAllocatorSession::IsStopped ( ) const

inlinevirtual

Reimplemented in cricket::BasicPortAllocatorSession, and cricket::BasicPortAllocatorSession.

password() [1/2]

const std::string& cricket::PortAllocatorSession::password ( ) const

inlineprotected

password() [2/2]

const std::string& cricket::PortAllocatorSession::password ( ) const

inlineprotected

pooled() [1/2]

bool cricket::PortAllocatorSession::pooled ( ) const

inline

pooled() [2/2]

bool cricket::PortAllocatorSession::pooled ( ) const

inline

PruneAllPorts() [1/2]

virtual void cricket::PortAllocatorSession::PruneAllPorts ( )

inlinevirtual

Reimplemented in cricket::FakePortAllocatorSession, cricket::FakePortAllocatorSession, cricket::BasicPortAllocatorSession, and cricket::BasicPortAllocatorSession.

PruneAllPorts() [2/2]

virtual void cricket::PortAllocatorSession::PruneAllPorts ( )

inlinevirtual

Reimplemented in cricket::FakePortAllocatorSession, cricket::FakePortAllocatorSession, cricket::BasicPortAllocatorSession, and cricket::BasicPortAllocatorSession.

ReadyCandidates() [1/2]

virtual std::vector<Candidate> cricket::PortAllocatorSession::ReadyCandidates ( ) const

pure virtual

Implemented in cricket::FakePortAllocatorSession, cricket::FakePortAllocatorSession, cricket::BasicPortAllocatorSession, and cricket::BasicPortAllocatorSession.

ReadyCandidates() [2/2]

virtual std::vector<Candidate> cricket::PortAllocatorSession::ReadyCandidates ( ) const

pure virtual

Implemented in cricket::FakePortAllocatorSession, cricket::FakePortAllocatorSession, cricket::BasicPortAllocatorSession, and cricket::BasicPortAllocatorSession.

ReadyPorts() [1/2]

virtual std::vector<PortInterface*> cricket::PortAllocatorSession::ReadyPorts ( ) const

pure virtual

Implemented in cricket::FakePortAllocatorSession, cricket::FakePortAllocatorSession, cricket::BasicPortAllocatorSession, and cricket::BasicPortAllocatorSession.

ReadyPorts() [2/2]

virtual std::vector<PortInterface*> cricket::PortAllocatorSession::ReadyPorts ( ) const

pure virtual

Implemented in cricket::FakePortAllocatorSession, cricket::FakePortAllocatorSession, cricket::BasicPortAllocatorSession, and cricket::BasicPortAllocatorSession.

RegatherOnAllNetworks() [1/2]

virtual void cricket::PortAllocatorSession::RegatherOnAllNetworks ( )

inlinevirtual

RegatherOnAllNetworks() [2/2]

virtual void cricket::PortAllocatorSession::RegatherOnAllNetworks ( )

inlinevirtual

RegatherOnFailedNetworks() [1/2]

virtual void cricket::PortAllocatorSession::RegatherOnFailedNetworks ( )

inlinevirtual

Reimplemented in cricket::BasicPortAllocatorSession, and cricket::BasicPortAllocatorSession.

RegatherOnFailedNetworks() [2/2]

virtual void cricket::PortAllocatorSession::RegatherOnFailedNetworks ( )

inlinevirtual

Reimplemented in cricket::BasicPortAllocatorSession, and cricket::BasicPortAllocatorSession.

set_flags() [1/2]

void cricket::PortAllocatorSession::set_flags ( uint32_t  flags )

inline

set_flags() [2/2]

void cricket::PortAllocatorSession::set_flags ( uint32_t  flags )

inline

set_generation() [1/2]

virtual void cricket::PortAllocatorSession::set_generation ( uint32_t  generation )

inlinevirtual

set_generation() [2/2]

virtual void cricket::PortAllocatorSession::set_generation ( uint32_t  generation )

inlinevirtual

SetCandidateFilter() [1/2]

virtual void cricket::PortAllocatorSession::SetCandidateFilter ( uint32_t  filter )

pure virtual

Implemented in cricket::FakePortAllocatorSession, cricket::FakePortAllocatorSession, cricket::BasicPortAllocatorSession, and cricket::BasicPortAllocatorSession.

SetCandidateFilter() [2/2]

virtual void cricket::PortAllocatorSession::SetCandidateFilter ( uint32_t  filter )

pure virtual

Implemented in cricket::FakePortAllocatorSession, cricket::FakePortAllocatorSession, cricket::BasicPortAllocatorSession, and cricket::BasicPortAllocatorSession.

StartGettingPorts() [1/2]

virtual void cricket::PortAllocatorSession::StartGettingPorts ( )

pure virtual

Implemented in cricket::FakePortAllocatorSession, cricket::FakePortAllocatorSession, cricket::BasicPortAllocatorSession, and cricket::BasicPortAllocatorSession.

StartGettingPorts() [2/2]

virtual void cricket::PortAllocatorSession::StartGettingPorts ( )

pure virtual

Implemented in cricket::FakePortAllocatorSession, cricket::FakePortAllocatorSession, cricket::BasicPortAllocatorSession, and cricket::BasicPortAllocatorSession.

StopGettingPorts() [1/2]

virtual void cricket::PortAllocatorSession::StopGettingPorts ( )

pure virtual

Implemented in cricket::FakePortAllocatorSession, cricket::FakePortAllocatorSession, cricket::BasicPortAllocatorSession, and cricket::BasicPortAllocatorSession.

StopGettingPorts() [2/2]

virtual void cricket::PortAllocatorSession::StopGettingPorts ( )

pure virtual

Implemented in cricket::FakePortAllocatorSession, cricket::FakePortAllocatorSession, cricket::BasicPortAllocatorSession, and cricket::BasicPortAllocatorSession.

UpdateIceParametersInternal() [1/2]

virtual void cricket::PortAllocatorSession::UpdateIceParametersInternal ( )

inlineprotectedvirtual

Reimplemented in cricket::FakePortAllocatorSession, cricket::FakePortAllocatorSession, cricket::BasicPortAllocatorSession, and cricket::BasicPortAllocatorSession.

UpdateIceParametersInternal() [2/2]

virtual void cricket::PortAllocatorSession::UpdateIceParametersInternal ( )

inlineprotectedvirtual

Reimplemented in cricket::FakePortAllocatorSession, cricket::FakePortAllocatorSession, cricket::BasicPortAllocatorSession, and cricket::BasicPortAllocatorSession.

username() [1/2]

const std::string& cricket::PortAllocatorSession::username ( ) const

inlineprotected

username() [2/2]

const std::string& cricket::PortAllocatorSession::username ( ) const

inlineprotected

Friends And Related Function Documentation

PortAllocator

PortAllocator

friend

Member Data Documentation

SignalCandidatesAllocationDone

sigslot::signal1< PortAllocatorSession * > cricket::PortAllocatorSession::SignalCandidatesAllocationDone

SignalCandidatesReady

sigslot::signal2< PortAllocatorSession *, const std::vector< Candidate > & > cricket::PortAllocatorSession::SignalCandidatesReady

SignalCandidatesRemoved

sigslot::signal2< PortAllocatorSession *, const std::vector< Candidate > & > cricket::PortAllocatorSession::SignalCandidatesRemoved

SignalDestroyed

sigslot::signal1< PortAllocatorSession * > cricket::PortAllocatorSession::SignalDestroyed

SignalIceRegathering

sigslot::signal2< PortAllocatorSession *, IceRegatheringReason > cricket::PortAllocatorSession::SignalIceRegathering

SignalPortReady

sigslot::signal2< PortAllocatorSession *, PortInterface * > cricket::PortAllocatorSession::SignalPortReady

SignalPortsPruned

sigslot::signal2< PortAllocatorSession *, const std::vector< PortInterface * > & > cricket::PortAllocatorSession::SignalPortsPruned

---

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

• DerivedData/WebKit/Build/Products/Debug/usr/local/include/webrtc/p2p/base/portallocator.h
• Source/ThirdParty/libwebrtc/Source/webrtc/p2p/base/portallocator.cc