cricket::PortInterface Class Reference

#include <portinterface.h>

Inheritance diagram for cricket::PortInterface:

Public Types
enum	CandidateOrigin {   ORIGIN_THIS_PORT, ORIGIN_OTHER_PORT, ORIGIN_MESSAGE, ORIGIN_THIS_PORT,   ORIGIN_OTHER_PORT, ORIGIN_MESSAGE }
enum	CandidateOrigin {   ORIGIN_THIS_PORT, ORIGIN_OTHER_PORT, ORIGIN_MESSAGE, ORIGIN_THIS_PORT,   ORIGIN_OTHER_PORT, ORIGIN_MESSAGE }

Public Member Functions
virtual	~PortInterface ()
virtual const std::string &	Type () const =0
virtual rtc::Network *	Network () const =0
virtual void	SetIceRole (IceRole role)=0
virtual IceRole	GetIceRole () const =0
virtual void	SetIceTiebreaker (uint64_t tiebreaker)=0
virtual uint64_t	IceTiebreaker () const =0
virtual bool	SharedSocket () const =0
virtual bool	SupportsProtocol (const std::string &protocol) const =0
virtual void	PrepareAddress ()=0
virtual Connection *	GetConnection (const rtc::SocketAddress &remote_addr)=0
virtual Connection *	CreateConnection (const Candidate &remote_candidate, CandidateOrigin origin)=0
virtual int	SetOption (rtc::Socket::Option opt, int value)=0
virtual int	GetOption (rtc::Socket::Option opt, int *value)=0
virtual int	GetError ()=0
virtual ProtocolType	GetProtocol () const =0
virtual const std::vector< Candidate > &	Candidates () const =0
virtual int	SendTo (const void *data, size_t size, const rtc::SocketAddress &addr, const rtc::PacketOptions &options, bool payload)=0
virtual void	SendBindingResponse (StunMessage *request, const rtc::SocketAddress &addr)=0
virtual void	SendBindingErrorResponse (StunMessage *request, const rtc::SocketAddress &addr, int error_code, const std::string &reason)=0
virtual void	EnablePortPackets ()=0
virtual std::string	ToString () const =0
virtual	~PortInterface ()
virtual const std::string &	Type () const =0
virtual rtc::Network *	Network () const =0
virtual void	SetIceRole (IceRole role)=0
virtual IceRole	GetIceRole () const =0
virtual void	SetIceTiebreaker (uint64_t tiebreaker)=0
virtual uint64_t	IceTiebreaker () const =0
virtual bool	SharedSocket () const =0
virtual bool	SupportsProtocol (const std::string &protocol) const =0
virtual void	PrepareAddress ()=0
virtual Connection *	GetConnection (const rtc::SocketAddress &remote_addr)=0
virtual Connection *	CreateConnection (const Candidate &remote_candidate, CandidateOrigin origin)=0
virtual int	SetOption (rtc::Socket::Option opt, int value)=0
virtual int	GetOption (rtc::Socket::Option opt, int *value)=0
virtual int	GetError ()=0
virtual ProtocolType	GetProtocol () const =0
virtual const std::vector< Candidate > &	Candidates () const =0
virtual int	SendTo (const void *data, size_t size, const rtc::SocketAddress &addr, const rtc::PacketOptions &options, bool payload)=0
virtual void	SendBindingResponse (StunMessage *request, const rtc::SocketAddress &addr)=0
virtual void	SendBindingErrorResponse (StunMessage *request, const rtc::SocketAddress &addr, int error_code, const std::string &reason)=0
virtual void	EnablePortPackets ()=0
virtual std::string	ToString () const =0

Public Attributes
sigslot::signal6< PortInterface *, const rtc::SocketAddress &, ProtocolType, IceMessage *, const std::string &, bool >	SignalUnknownAddress
sigslot::signal1< PortInterface * >	SignalDestroyed
sigslot::signal1< PortInterface * >	SignalRoleConflict
sigslot::signal4< PortInterface *, const char *, size_t, const rtc::SocketAddress & >	SignalReadPacket
sigslot::signal1< const rtc::SentPacket & >	SignalSentPacket

Protected Member Functions
	PortInterface ()
	PortInterface ()

Member Enumeration Documentation

CandidateOrigin [1/2]

enum cricket::PortInterface::CandidateOrigin

Enumerator
ORIGIN_THIS_PORT
ORIGIN_OTHER_PORT
ORIGIN_MESSAGE
ORIGIN_THIS_PORT
ORIGIN_OTHER_PORT
ORIGIN_MESSAGE

CandidateOrigin [2/2]

enum cricket::PortInterface::CandidateOrigin

Enumerator
ORIGIN_THIS_PORT
ORIGIN_OTHER_PORT
ORIGIN_MESSAGE
ORIGIN_THIS_PORT
ORIGIN_OTHER_PORT
ORIGIN_MESSAGE

Constructor & Destructor Documentation

~PortInterface() [1/2]

virtual cricket::PortInterface::~PortInterface ( )

inlinevirtual

PortInterface() [1/2]

cricket::PortInterface::PortInterface ( )

inlineprotected

~PortInterface() [2/2]

virtual cricket::PortInterface::~PortInterface ( )

inlinevirtual

PortInterface() [2/2]

cricket::PortInterface::PortInterface ( )

inlineprotected

Member Function Documentation

Candidates() [1/2]

virtual const std::vector<Candidate>& cricket::PortInterface::Candidates ( ) const

pure virtual

Implemented in cricket::Port, and cricket::Port.

Candidates() [2/2]

virtual const std::vector<Candidate>& cricket::PortInterface::Candidates ( ) const

pure virtual

Implemented in cricket::Port, and cricket::Port.

CreateConnection() [1/2]

virtual Connection* cricket::PortInterface::CreateConnection ( const Candidate &  remote_candidate, CandidateOrigin  origin  )

pure virtual

Implemented in TestPort, cricket::TurnPort, cricket::TurnPort, cricket::UDPPort, cricket::UDPPort, cricket::RelayPort, cricket::RelayPort, cricket::TCPPort, and cricket::TCPPort.

CreateConnection() [2/2]

virtual Connection* cricket::PortInterface::CreateConnection ( const Candidate &  remote_candidate, CandidateOrigin  origin  )

pure virtual

Implemented in TestPort, cricket::TurnPort, cricket::TurnPort, cricket::UDPPort, cricket::UDPPort, cricket::RelayPort, cricket::RelayPort, cricket::TCPPort, and cricket::TCPPort.

EnablePortPackets() [1/2]

virtual void cricket::PortInterface::EnablePortPackets ( )

pure virtual

Implemented in cricket::Port, and cricket::Port.

EnablePortPackets() [2/2]

virtual void cricket::PortInterface::EnablePortPackets ( )

pure virtual

Implemented in cricket::Port, and cricket::Port.

GetConnection() [1/2]

virtual Connection* cricket::PortInterface::GetConnection ( const rtc::SocketAddress &  remote_addr )

pure virtual

Implemented in cricket::Port, and cricket::Port.

GetConnection() [2/2]

virtual Connection* cricket::PortInterface::GetConnection ( const rtc::SocketAddress &  remote_addr )

pure virtual

Implemented in cricket::Port, and cricket::Port.

GetError() [1/2]

virtual int cricket::PortInterface::GetError ( )

pure virtual

Implemented in TestPort, cricket::TurnPort, cricket::TurnPort, cricket::UDPPort, cricket::UDPPort, cricket::RelayPort, cricket::RelayPort, cricket::TCPPort, and cricket::TCPPort.

GetError() [2/2]

virtual int cricket::PortInterface::GetError ( )

pure virtual

Implemented in TestPort, cricket::TurnPort, cricket::TurnPort, cricket::UDPPort, cricket::UDPPort, cricket::RelayPort, cricket::RelayPort, cricket::TCPPort, and cricket::TCPPort.

GetIceRole() [1/2]

virtual IceRole cricket::PortInterface::GetIceRole ( ) const

pure virtual

Implemented in cricket::Port, and cricket::Port.

GetIceRole() [2/2]

virtual IceRole cricket::PortInterface::GetIceRole ( ) const

pure virtual

Implemented in cricket::Port, and cricket::Port.

GetOption() [1/2]

virtual int cricket::PortInterface::GetOption ( rtc::Socket::Option  opt, int *  value  )

pure virtual

Implemented in TestPort, cricket::TurnPort, cricket::TurnPort, cricket::UDPPort, cricket::UDPPort, cricket::RelayPort, cricket::RelayPort, cricket::TCPPort, and cricket::TCPPort.

GetOption() [2/2]

virtual int cricket::PortInterface::GetOption ( rtc::Socket::Option  opt, int *  value  )

pure virtual

Implemented in TestPort, cricket::TurnPort, cricket::TurnPort, cricket::UDPPort, cricket::UDPPort, cricket::RelayPort, cricket::RelayPort, cricket::TCPPort, and cricket::TCPPort.

GetProtocol() [1/2]

virtual ProtocolType cricket::PortInterface::GetProtocol ( ) const

pure virtual

Implemented in TestPort, cricket::UDPPort, cricket::UDPPort, cricket::TurnPort, cricket::TurnPort, cricket::RelayPort, cricket::RelayPort, cricket::TCPPort, and cricket::TCPPort.

GetProtocol() [2/2]

virtual ProtocolType cricket::PortInterface::GetProtocol ( ) const

pure virtual

Implemented in TestPort, cricket::UDPPort, cricket::UDPPort, cricket::TurnPort, cricket::TurnPort, cricket::RelayPort, cricket::RelayPort, cricket::TCPPort, and cricket::TCPPort.

IceTiebreaker() [1/2]

virtual uint64_t cricket::PortInterface::IceTiebreaker ( ) const

pure virtual

Implemented in cricket::Port, and cricket::Port.

IceTiebreaker() [2/2]

virtual uint64_t cricket::PortInterface::IceTiebreaker ( ) const

pure virtual

Implemented in cricket::Port, and cricket::Port.

Network() [1/2]

virtual rtc::Network* cricket::PortInterface::Network ( ) const

pure virtual

Implemented in cricket::Port, and cricket::Port.

Network() [2/2]

virtual rtc::Network* cricket::PortInterface::Network ( ) const

pure virtual

Implemented in cricket::Port, and cricket::Port.

PrepareAddress() [1/2]

virtual void cricket::PortInterface::PrepareAddress ( )

pure virtual

Implemented in cricket::StunPort, cricket::StunPort, TestPort, cricket::TurnPort, cricket::TurnPort, cricket::UDPPort, cricket::UDPPort, cricket::RelayPort, cricket::RelayPort, cricket::TCPPort, and cricket::TCPPort.

PrepareAddress() [2/2]

virtual void cricket::PortInterface::PrepareAddress ( )

pure virtual

Implemented in cricket::StunPort, cricket::StunPort, TestPort, cricket::TurnPort, cricket::TurnPort, cricket::UDPPort, cricket::UDPPort, cricket::RelayPort, cricket::RelayPort, cricket::TCPPort, and cricket::TCPPort.

SendBindingErrorResponse() [1/2]

virtual void cricket::PortInterface::SendBindingErrorResponse ( StunMessage *  request, const rtc::SocketAddress &  addr, int  error_code, const std::string &  reason  )

pure virtual

Implemented in cricket::Port, and cricket::Port.

SendBindingErrorResponse() [2/2]

virtual void cricket::PortInterface::SendBindingErrorResponse ( StunMessage *  request, const rtc::SocketAddress &  addr, int  error_code, const std::string &  reason  )

pure virtual

Implemented in cricket::Port, and cricket::Port.

SendBindingResponse() [1/2]

virtual void cricket::PortInterface::SendBindingResponse ( StunMessage *  request, const rtc::SocketAddress &  addr  )

pure virtual

Implemented in cricket::Port, cricket::Port, cricket::TestUDPPort, and cricket::TestUDPPort.

SendBindingResponse() [2/2]

virtual void cricket::PortInterface::SendBindingResponse ( StunMessage *  request, const rtc::SocketAddress &  addr  )

pure virtual

Implemented in cricket::Port, cricket::Port, cricket::TestUDPPort, and cricket::TestUDPPort.

SendTo() [1/2]

virtual int cricket::PortInterface::SendTo ( const void *  data, size_t  size, const rtc::SocketAddress &  addr, const rtc::PacketOptions &  options, bool  payload  )

pure virtual

Implemented in TestPort, cricket::UDPPort, cricket::UDPPort, cricket::TurnPort, cricket::TurnPort, cricket::RelayPort, cricket::RelayPort, cricket::TCPPort, and cricket::TCPPort.

SendTo() [2/2]

virtual int cricket::PortInterface::SendTo ( const void *  data, size_t  size, const rtc::SocketAddress &  addr, const rtc::PacketOptions &  options, bool  payload  )

pure virtual

Implemented in TestPort, cricket::UDPPort, cricket::UDPPort, cricket::TurnPort, cricket::TurnPort, cricket::RelayPort, cricket::RelayPort, cricket::TCPPort, and cricket::TCPPort.

SetIceRole() [1/2]

virtual void cricket::PortInterface::SetIceRole ( IceRole  role )

pure virtual

Implemented in cricket::Port, and cricket::Port.

SetIceRole() [2/2]

virtual void cricket::PortInterface::SetIceRole ( IceRole  role )

pure virtual

Implemented in cricket::Port, and cricket::Port.

SetIceTiebreaker() [1/2]

virtual void cricket::PortInterface::SetIceTiebreaker ( uint64_t  tiebreaker )

pure virtual

Implemented in cricket::Port, and cricket::Port.

SetIceTiebreaker() [2/2]

virtual void cricket::PortInterface::SetIceTiebreaker ( uint64_t  tiebreaker )

pure virtual

Implemented in cricket::Port, and cricket::Port.

SetOption() [1/2]

virtual int cricket::PortInterface::SetOption ( rtc::Socket::Option  opt, int  value  )

pure virtual

Implemented in TestPort, cricket::TurnPort, cricket::TurnPort, cricket::UDPPort, cricket::UDPPort, cricket::RelayPort, cricket::RelayPort, cricket::TCPPort, and cricket::TCPPort.

SetOption() [2/2]

virtual int cricket::PortInterface::SetOption ( rtc::Socket::Option  opt, int  value  )

pure virtual

Implemented in TestPort, cricket::TurnPort, cricket::TurnPort, cricket::UDPPort, cricket::UDPPort, cricket::RelayPort, cricket::RelayPort, cricket::TCPPort, and cricket::TCPPort.

SharedSocket() [1/2]

virtual bool cricket::PortInterface::SharedSocket ( ) const

pure virtual

Implemented in cricket::Port, and cricket::Port.

SharedSocket() [2/2]

virtual bool cricket::PortInterface::SharedSocket ( ) const

pure virtual

Implemented in cricket::Port, and cricket::Port.

SupportsProtocol() [1/2]

virtual bool cricket::PortInterface::SupportsProtocol ( const std::string &  protocol ) const

pure virtual

Implemented in TestPort, cricket::TurnPort, cricket::TurnPort, cricket::UDPPort, cricket::UDPPort, cricket::RelayPort, cricket::RelayPort, cricket::TCPPort, and cricket::TCPPort.

SupportsProtocol() [2/2]

virtual bool cricket::PortInterface::SupportsProtocol ( const std::string &  protocol ) const

pure virtual

Implemented in TestPort, cricket::TurnPort, cricket::TurnPort, cricket::UDPPort, cricket::UDPPort, cricket::RelayPort, cricket::RelayPort, cricket::TCPPort, and cricket::TCPPort.

ToString() [1/2]

virtual std::string cricket::PortInterface::ToString ( ) const

pure virtual

Implemented in cricket::Port, and cricket::Port.

ToString() [2/2]

virtual std::string cricket::PortInterface::ToString ( ) const

pure virtual

Implemented in cricket::Port, and cricket::Port.

Type() [1/2]

virtual const std::string& cricket::PortInterface::Type ( ) const

pure virtual

Implemented in cricket::Port, and cricket::Port.

Type() [2/2]

virtual const std::string& cricket::PortInterface::Type ( ) const

pure virtual

Implemented in cricket::Port, and cricket::Port.

Member Data Documentation

SignalDestroyed

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

SignalReadPacket

sigslot::signal4< PortInterface *, const char *, size_t, const rtc::SocketAddress & > cricket::PortInterface::SignalReadPacket

SignalRoleConflict

sigslot::signal1< PortInterface * > cricket::PortInterface::SignalRoleConflict

SignalSentPacket

sigslot::signal1< const rtc::SentPacket & > cricket::PortInterface::SignalSentPacket

SignalUnknownAddress

sigslot::signal6< PortInterface *, const rtc::SocketAddress &, ProtocolType, IceMessage *, const std::string &, bool > cricket::PortInterface::SignalUnknownAddress

---

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

• DerivedData/WebKit/Build/Products/Debug/usr/local/include/webrtc/p2p/base/portinterface.h