OpenDDS::ICE Namespace Reference

Classes
class	ActiveFoundationSet
class	Agent
struct	AgentHolder
class	AgentImpl
struct	AgentInfo
class	AgentInfoListener
struct	Candidate
struct	CandidatePair
struct	Checklist
class	Configuration
struct	ConnectivityCheck
struct	DeferredTriggeredCheck
class	Endpoint
struct	EndpointManager
struct	GuidPair
struct	ScheduleTimerCommand
class	ServerReflexiveStateMachine
struct	Task

Typedefs
typedef std::vector< FoundationType >	FoundationList
typedef std::pair< std::string, std::string >	FoundationType
typedef DCPS::RcHandle< Checklist >	ChecklistPtr
typedef DCPS::RcHandle< EndpointManager >	EndpointManagerPtr
typedef std::set< GuidPair >	GuidSetType
typedef DCPS::RcHandle< Task >	TaskPtr
typedef DCPS::WeakRcHandle< Task >	WeakTaskPtr

Enumerations
enum	AgentType { FULL = 0x0, LITE = 0x1 }
enum	CandidateType { HOST = 0x0, SERVER_REFLEXIVE = 0x1, PEER_REFLEXIVE = 0x2, RELAYED = 0x3 }

Functions
typedef	OPENDDS_MAP (OPENDDS_STRING, ICE::AgentInfo) AgentInfoMap
bool	operator== (const ConnectivityCheck &a_cc, const STUN::TransactionId &a_tid)
bool	operator== (const ConnectivityCheck &a_cc, const CandidatePair &a_cp)
std::ostream &	operator<< (std::ostream &stream, const GuidPair &guidp)
bool	candidates_sorted (const Candidate &x, const Candidate &y)
bool	candidates_equal (const Candidate &x, const Candidate &y)
ACE_UINT32	local_priority (const ACE_INET_Addr &addr)
Candidate	make_host_candidate (const ACE_INET_Addr &address)
Candidate	make_server_reflexive_candidate (const ACE_INET_Addr &address, const ACE_INET_Addr &base, const ACE_INET_Addr &server_address)
Candidate	make_peer_reflexive_candidate (const ACE_INET_Addr &address, const ACE_INET_Addr &base, const ACE_INET_Addr &server_address, ACE_UINT32 priority)
Candidate	make_peer_reflexive_candidate (const ACE_INET_Addr &address, ACE_UINT32 priority, size_t q)
typedef	OPENDDS_VECTOR (ACE_INET_Addr) AddressListType

Typedef Documentation

ChecklistPtr

typedef DCPS::RcHandle<Checklist> OpenDDS::ICE::ChecklistPtr

Definition at line 288 of file Checklist.h.

EndpointManagerPtr

typedef DCPS::RcHandle<EndpointManager> OpenDDS::ICE::EndpointManagerPtr

Definition at line 260 of file EndpointManager.h.

FoundationList

typedef std::vector<FoundationType> OpenDDS::ICE::FoundationList

Definition at line 33 of file AgentImpl.h.

FoundationType

typedef std::pair<std::string, std::string> OpenDDS::ICE::FoundationType

Definition at line 34 of file Checklist.h.

GuidSetType

typedef std::set<GuidPair> OpenDDS::ICE::GuidSetType

Definition at line 58 of file RTPS/ICE/Ice.h.

TaskPtr

typedef DCPS::RcHandle<Task> OpenDDS::ICE::TaskPtr

Definition at line 38 of file Task.h.

WeakTaskPtr

typedef DCPS::WeakRcHandle<Task> OpenDDS::ICE::WeakTaskPtr

Definition at line 39 of file Task.h.

Enumeration Type Documentation

AgentType

enum OpenDDS::ICE::AgentType

Enumerator
FULL
LITE

Definition at line 30 of file Ice.h.

               {
  FULL = 0x0,
  LITE = 0x1,
};

CandidateType

enum OpenDDS::ICE::CandidateType

Enumerator
HOST
SERVER_REFLEXIVE
PEER_REFLEXIVE
RELAYED

Definition at line 35 of file Ice.h.

                   {
  HOST = 0x0,
  SERVER_REFLEXIVE = 0x1,
  PEER_REFLEXIVE = 0x2,
  RELAYED = 0x3,
};

Function Documentation

candidates_equal()

bool OpenDDS::ICE::candidates_equal	(	const Candidate &	x,
		const Candidate &	y
	)

Definition at line 34 of file Ice.cpp.

References OpenDDS::ICE::Candidate::address, and OpenDDS::ICE::Candidate::base.

Referenced by OpenDDS::ICE::EndpointManager::regenerate_agent_info().

{
  return x.address == y.address && x.base == y.base;
}

candidates_sorted()

bool OpenDDS::ICE::candidates_sorted	(	const Candidate &	x,
		const Candidate &	y
	)

Definition at line 21 of file Ice.cpp.

References OpenDDS::ICE::Candidate::address, OpenDDS::ICE::Candidate::base, and OpenDDS::ICE::Candidate::priority.

Referenced by OpenDDS::ICE::Checklist::generate_triggered_check(), OpenDDS::ICE::EndpointManager::regenerate_agent_info(), and OpenDDS::ICE::Checklist::success_response().

{
  if (x.address != y.address) {
    return x.address < y.address;
  }

  if (x.base != y.base) {
    return x.base < y.base;
  }

  return x.priority > y.priority;
}

local_priority()

ACE_UINT32 OpenDDS::ICE::local_priority

(

const ACE_INET_Addr &

addr

)

Definition at line 56 of file Ice.cpp.

References ACE_Addr::get_type().

Referenced by OpenDDS::ICE::ConnectivityCheck::ConnectivityCheck(), make_host_candidate(), and make_server_reflexive_candidate().

{
  if (addr.get_type() == AF_INET6) {
    return 65535;
  }
  return 65534;
}

make_host_candidate()

Candidate OpenDDS::ICE::make_host_candidate

(

const ACE_INET_Addr &

address

)

Definition at line 64 of file Ice.cpp.

References OpenDDS::ICE::Candidate::address, OpenDDS::ICE::Candidate::base, OpenDDS::ICE::Candidate::foundation, HOST, OpenDDS::DCPS::LogAddr::ip(), local_priority(), OpenDDS::ICE::Candidate::priority, and OpenDDS::ICE::Candidate::type.

Referenced by OpenDDS::ICE::EndpointManager::regenerate_agent_info().

{
  Candidate candidate;
  candidate.address = address;
  candidate.foundation = std::string("H") + DCPS::LogAddr::ip(address) + "U";
  // See https://tools.ietf.org/html/rfc8445#section-5.1.2.1 for an explanation of the formula below.
  candidate.priority = (126 << 24) + (local_priority(address) << 8) + ((256 - 1) << 0); // No local preference, component 1.
  candidate.type = HOST;
  candidate.base = address;
  return candidate;
}

make_peer_reflexive_candidate() [1/2]

Candidate OpenDDS::ICE::make_peer_reflexive_candidate	(	const ACE_INET_Addr &	address,
		const ACE_INET_Addr &	base,
		const ACE_INET_Addr &	server_address,
		ACE_UINT32	priority
	)

Definition at line 88 of file Ice.cpp.

References OpenDDS::ICE::Candidate::address, OpenDDS::ICE::Candidate::base, OpenDDS::ICE::Candidate::foundation, OpenDDS::DCPS::LogAddr::ip(), PEER_REFLEXIVE, OpenDDS::ICE::Candidate::priority, and OpenDDS::ICE::Candidate::type.

Referenced by OpenDDS::ICE::Checklist::generate_triggered_check(), and OpenDDS::ICE::Checklist::success_response().

{
  Candidate candidate;
  candidate.address = address;
  candidate.foundation = std::string("P") + DCPS::LogAddr::ip(base) + "_" + DCPS::LogAddr::ip(server_address) + "U";
  candidate.priority = priority;
  candidate.type = PEER_REFLEXIVE;
  candidate.base = base;
  return candidate;
}

make_peer_reflexive_candidate() [2/2]

Candidate OpenDDS::ICE::make_peer_reflexive_candidate	(	const ACE_INET_Addr &	address,
		ACE_UINT32	priority,
		size_t	q
	)

Definition at line 99 of file Ice.cpp.

References OpenDDS::ICE::Candidate::address, OpenDDS::ICE::Candidate::foundation, PEER_REFLEXIVE, OpenDDS::ICE::Candidate::priority, OpenDDS::DCPS::to_dds_string(), and OpenDDS::ICE::Candidate::type.

{
  Candidate candidate;
  candidate.address = address;
  candidate.foundation = std::string("Q") + OpenDDS::DCPS::to_dds_string(q) + "U";
  candidate.priority = priority;
  candidate.type = PEER_REFLEXIVE;
  return candidate;
}

make_server_reflexive_candidate()

Candidate OpenDDS::ICE::make_server_reflexive_candidate	(	const ACE_INET_Addr &	address,
		const ACE_INET_Addr &	base,
		const ACE_INET_Addr &	server_address
	)

Definition at line 76 of file Ice.cpp.

References OpenDDS::ICE::Candidate::address, OpenDDS::ICE::Candidate::base, OpenDDS::ICE::Candidate::foundation, OpenDDS::DCPS::LogAddr::ip(), local_priority(), OpenDDS::ICE::Candidate::priority, SERVER_REFLEXIVE, and OpenDDS::ICE::Candidate::type.

Referenced by OpenDDS::ICE::EndpointManager::regenerate_agent_info().

{
  Candidate candidate;
  candidate.address = address;
  candidate.foundation = std::string("S") + DCPS::LogAddr::ip(base) + "_" + DCPS::LogAddr::ip(server_address) + "U";
  // See https://tools.ietf.org/html/rfc8445#section-5.1.2.1 for an explanation of the formula below.
  candidate.priority = (100 << 24) + (local_priority(address) << 8) + ((256 - 1) << 0); // No local preference, component 1.
  candidate.type = SERVER_REFLEXIVE;
  candidate.base = base;
  return candidate;
}

OPENDDS_MAP()

typedef OpenDDS::ICE::OPENDDS_MAP	(	OPENDDS_STRING	,
		ICE::AgentInfo
	)

Referenced by OpenDDS::ICE::AgentInfo::operator!=(), and OpenDDS::DCPS::RtpsUdpDataLink::ReaderInfo::ReaderInfo().

OPENDDS_VECTOR()

typedef OpenDDS::ICE::OPENDDS_VECTOR

(

ACE_INET_Addr

)

Referenced by OpenDDS::ICE::AgentInfo::AgentInfo(), OpenDDS::DCPS::RtpsUdpDataLink::datareader_dispatch(), OpenDDS::DCPS::RtpsUdpDataLink::datawriter_dispatch(), and OpenDDS::DCPS::RtpsUdpDataLink::MetaSubmessage::reset_destination().

operator<<()

std::ostream& OpenDDS::ICE::operator<< ( std::ostream &  stream, const GuidPair &  guidp  )

inline

Definition at line 146 of file Checklist.h.

References OpenDDS::ICE::GuidPair::local, and OpenDDS::ICE::GuidPair::remote.

{
  stream << guidp.local << ':' << guidp.remote;
  return stream;
}

operator==() [1/2]

bool OpenDDS::ICE::operator== ( const ConnectivityCheck &  a_cc, const STUN::TransactionId &  a_tid  )

inline

Definition at line 135 of file Checklist.h.

References OpenDDS::ICE::ConnectivityCheck::request(), and OpenDDS::STUN::Message::transaction_id.

{
  return a_cc.request().transaction_id == a_tid;
}

operator==() [2/2]

bool OpenDDS::ICE::operator== ( const ConnectivityCheck &  a_cc, const CandidatePair &  a_cp  )

inline

Definition at line 140 of file Checklist.h.

References OpenDDS::ICE::ConnectivityCheck::candidate_pair().

{
  return a_cc.candidate_pair() == a_cp;
}