OpenDDS::ICE::ConnectivityCheck Struct Reference

#include <Checklist.h>

Collaboration diagram for OpenDDS::ICE::ConnectivityCheck:

Public Member Functions
	ConnectivityCheck (const CandidatePair &a_candidate_pair, const AgentInfo &a_local_agent_info, const AgentInfo &a_remote_agent_info, ACE_UINT64 a_ice_tie_breaker, const DCPS::MonotonicTimePoint &a_expiration_date)
const CandidatePair &	candidate_pair () const
const STUN::Message &	request () const
void	cancel ()
bool	cancelled () const
DCPS::MonotonicTimePoint	expiration_date () const
void	password (const std::string &a_password)

Private Attributes
CandidatePair	candidate_pair_
STUN::Message	request_
bool	cancelled_
DCPS::MonotonicTimePoint	expiration_date_

Detailed Description

Definition at line 99 of file Checklist.h.

Constructor & Destructor Documentation

ConnectivityCheck()

OpenDDS::ICE::ConnectivityCheck::ConnectivityCheck	(	const CandidatePair &	a_candidate_pair,
		const AgentInfo &	a_local_agent_info,
		const AgentInfo &	a_remote_agent_info,
		ACE_UINT64	a_ice_tie_breaker,
		const DCPS::MonotonicTimePoint &	a_expiration_date
	)

Definition at line 57 of file Checklist.cpp.

References OpenDDS::ICE::Candidate::address, OpenDDS::STUN::Message::append_attribute(), OpenDDS::STUN::BINDING, OpenDDS::STUN::Message::class_, OpenDDS::STUN::Message::generate_transaction_id(), OpenDDS::ICE::CandidatePair::local, OpenDDS::ICE::CandidatePair::local_is_controlling, OpenDDS::ICE::local_priority(), OpenDDS::STUN::make_fingerprint(), OpenDDS::STUN::make_ice_controlled(), OpenDDS::STUN::make_ice_controlling(), OpenDDS::STUN::make_message_integrity(), OpenDDS::STUN::make_priority(), OpenDDS::STUN::make_use_candidate(), OpenDDS::STUN::make_username(), OpenDDS::STUN::Message::method, OpenDDS::ICE::AgentInfo::password, OpenDDS::STUN::Message::password, OpenDDS::STUN::REQUEST, request_, OpenDDS::ICE::CandidatePair::use_candidate, and OpenDDS::ICE::AgentInfo::username.

  : candidate_pair_(a_candidate_pair), cancelled_(false), expiration_date_(a_expiration_date)
{
  request_.class_ = STUN::REQUEST;
  request_.method = STUN::BINDING;
  request_.generate_transaction_id();

  // No local preference, component 1.
  request_.append_attribute(STUN::make_priority((110 << 24) + (local_priority(a_candidate_pair.local.address) << 8) + ((256 - 1) << 0)));

  if (a_candidate_pair.local_is_controlling) {
    request_.append_attribute(STUN::make_ice_controlling(a_ice_tie_breaker));
  }

  else {
    request_.append_attribute(STUN::make_ice_controlled(a_ice_tie_breaker));
  }

  if (a_candidate_pair.local_is_controlling && a_candidate_pair.use_candidate) {
    request_.append_attribute(STUN::make_use_candidate());
  }

  request_.append_attribute(STUN::make_username(a_remote_agent_info.username + ":" + a_local_agent_info.username));
  request_.password = a_remote_agent_info.password;
  request_.append_attribute(STUN::make_message_integrity());
  request_.append_attribute(STUN::make_fingerprint());
}

Member Function Documentation

cancel()

void OpenDDS::ICE::ConnectivityCheck::cancel ( void  )

inline

Definition at line 112 of file Checklist.h.

  {
    cancelled_ = true;
  }

cancelled()

bool OpenDDS::ICE::ConnectivityCheck::cancelled ( ) const

inline

Definition at line 116 of file Checklist.h.

Referenced by OpenDDS::ICE::Checklist::do_next_check(), and OpenDDS::ICE::Checklist::succeeded().

  {
    return cancelled_;
  }

candidate_pair()

const CandidatePair& OpenDDS::ICE::ConnectivityCheck::candidate_pair ( ) const

inline

Definition at line 104 of file Checklist.h.

Referenced by OpenDDS::ICE::Checklist::do_next_check(), OpenDDS::ICE::Checklist::failed(), OpenDDS::ICE::operator==(), and OpenDDS::ICE::Checklist::succeeded().

  {
    return candidate_pair_;
  }

expiration_date()

DCPS::MonotonicTimePoint OpenDDS::ICE::ConnectivityCheck::expiration_date ( ) const

inline

Definition at line 120 of file Checklist.h.

Referenced by OpenDDS::ICE::Checklist::do_next_check().

  {
    return expiration_date_;
  }

password()

void OpenDDS::ICE::ConnectivityCheck::password ( const std::string &  a_password )

inline

Definition at line 124 of file Checklist.h.

Referenced by OpenDDS::ICE::Checklist::do_next_check().

  {
    request_.password = a_password;
  }

request()

const STUN::Message& OpenDDS::ICE::ConnectivityCheck::request ( ) const

inline

Definition at line 108 of file Checklist.h.

Referenced by OpenDDS::ICE::Checklist::do_next_check(), OpenDDS::ICE::operator==(), and OpenDDS::ICE::Checklist::succeeded().

  {
    return request_;
  }

Member Data Documentation

cancelled_

bool OpenDDS::ICE::ConnectivityCheck::cancelled_

private

Definition at line 131 of file Checklist.h.

candidate_pair_

CandidatePair OpenDDS::ICE::ConnectivityCheck::candidate_pair_

private

Definition at line 129 of file Checklist.h.

expiration_date_

DCPS::MonotonicTimePoint OpenDDS::ICE::ConnectivityCheck::expiration_date_

private

Definition at line 132 of file Checklist.h.

request_

STUN::Message OpenDDS::ICE::ConnectivityCheck::request_

private

Definition at line 130 of file Checklist.h.

Referenced by ConnectivityCheck().

---

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

• Checklist.h
• Checklist.cpp