#include <ContentFilteredTopicImpl.h>

Inheritance diagram for OpenDDS::DCPS::ContentFilteredTopicImpl:

[legend]

Collaboration diagram for OpenDDS::DCPS::ContentFilteredTopicImpl:

[legend]

Public Member Functions
	ContentFilteredTopicImpl (const char name, DDS::Topic_ptr related_topic, const char filter_expression, DomainParticipantImpl *participant)

virtual	~ContentFilteredTopicImpl ()

char *	get_filter_expression ()

DDS::ReturnCode_t	get_expression_parameters (DDS::StringSeq &parameters)

DDS::ReturnCode_t	set_expression_parameters (const DDS::StringSeq &parameters)

DDS::Topic_ptr	get_related_topic ()

template<typename Sample >
bool	filter (const Sample &s, bool sample_only_has_key_fields) const

void	add_reader (DataReaderImpl &reader)

void	remove_reader (DataReaderImpl &reader)

const char *	get_filter_class_name () const

Public Member Functions inherited from DDS::ContentFilteredTopic
ReturnCode_t	get_expression_parameters (inout StringSeq params)

ReturnCode_t	set_expression_parameters (in StringSeq expression_parameters)

Public Member Functions inherited from OpenDDS::DCPS::LocalObjectBase
virtual void	_add_ref ()

virtual void	_remove_ref ()

virtual CORBA::ULong	_refcount_value () const

Public Member Functions inherited from CORBA::LocalObject
virtual	~LocalObject (void)

virtual CORBA::Boolean	_non_existent (void)

virtual char *	_repository_id (void)

virtual CORBA::InterfaceDef_ptr	_get_interface (void)

virtual CORBA::Object_ptr	_get_component (void)

virtual void	_create_request (CORBA::Context_ptr ctx, const char *operation, CORBA::NVList_ptr arg_list, CORBA::NamedValue_ptr result, CORBA::Request_ptr &request, CORBA::Flags req_flags)

virtual void	_create_request (CORBA::Context_ptr ctx, const char *operation, CORBA::NVList_ptr arg_list, CORBA::NamedValue_ptr result, CORBA::ExceptionList_ptr exclist, CORBA::ContextList_ptr ctxtlist, CORBA::Request_ptr &request, CORBA::Flags req_flags)

virtual CORBA::Request_ptr	_request (const char *operation)

CORBA::Policy_ptr	_get_policy (CORBA::PolicyType type)

CORBA::Policy_ptr	_get_cached_policy (TAO_Cached_Policy_Type type)

CORBA::Object_ptr	_set_policy_overrides (const CORBA::PolicyList &policies, CORBA::SetOverrideType set_add)

CORBA::PolicyList *	_get_policy_overrides (const CORBA::PolicyTypeSeq &types)

CORBA::Boolean	_validate_connection (CORBA::PolicyList_out inconsistent_policies)

virtual CORBA::ULong	_hash (CORBA::ULong maximum)

virtual CORBA::Boolean	_is_equivalent (CORBA::Object_ptr other_obj)

virtual CORBA::ORB_ptr	_get_orb (void)

virtual TAO::ObjectKey *	_key (void)

Public Member Functions inherited from CORBA::Object
virtual	~Object (void)

virtual TAO_Abstract_ServantBase *	_servant (void) const

virtual CORBA::Boolean	_is_collocated (void) const

virtual CORBA::Boolean	_is_local (void) const

	Object (TAO_Stub p, CORBA::Boolean collocated=false, TAO_Abstract_ServantBase servant=0, TAO_ORB_Core *orb_core=0)

	Object (IOP::IOR ior, TAO_ORB_Core orb_core)

virtual TAO_Stub *	_stubobj (void) const

virtual TAO_Stub *	_stubobj (void)

virtual void	_proxy_broker (TAO::Object_Proxy_Broker *proxy_broker)

virtual CORBA::Boolean	marshal (TAO_OutputCDR &cdr)

CORBA::Boolean	is_evaluated (void) const

TAO_ORB_Core *	orb_core (void) const

IOP::IOR *	steal_ior (void)

const IOP::IOR &	ior (void) const

virtual bool	can_convert_to_ior (void) const

virtual char *	convert_to_ior (bool use_omg_ior_format, const char *ior_prefix) const

void	_decr_refcount (void)

virtual CORBA::Boolean	_is_a (const char *logical_type_id)

virtual const char *	_interface_repository_id (void) const

CORBA::Policy_ptr	_get_policy (CORBA::PolicyType type)

CORBA::Policy_ptr	_get_cached_policy (TAO_Cached_Policy_Type type)

CORBA::Object_ptr	_set_policy_overrides (const CORBA::PolicyList &policies, CORBA::SetOverrideType set_add)

CORBA::PolicyList *	_get_policy_overrides (const CORBA::PolicyTypeSeq &types)

CORBA::Boolean	_validate_connection (CORBA::PolicyList_out inconsistent_policies)

Public Member Functions inherited from OpenDDS::DCPS::RcObject
virtual	~RcObject ()

long	ref_count () const

WeakObject *	_get_weak_object () const

Public Member Functions inherited from OpenDDS::DCPS::TopicDescriptionImpl
	TopicDescriptionImpl (const char topic_name, const char type_name, TypeSupport_ptr type_support, DomainParticipantImpl *participant)

virtual	~TopicDescriptionImpl ()

virtual char *	get_type_name ()

virtual char *	get_name ()

virtual DDS::DomainParticipant_ptr	get_participant ()

OpenDDS::DCPS::TypeSupport_ptr	get_type_support ()

bool	has_entity_refs () const

void	add_entity_ref ()

void	remove_entity_ref ()

Private Member Functions
typedef	OPENDDS_VECTOR (WeakRcHandle< DataReaderImpl >) Readers

Private Attributes
OPENDDS_STRING	filter_expression_

FilterEvaluator	filter_eval_

DDS::StringSeq	expression_parameters_

DDS::Topic_var	related_topic_

Readers	readers_

ACE_Recursive_Thread_Mutex	lock_
	Concurrent access to expression_parameters_ and readers_. More...

Additional Inherited Members
Public Types inherited from OpenDDS::DCPS::LocalObject< DDS::ContentFilteredTopic >
typedef DDS::ContentFilteredTopic ::_ptr_type	_ptr_type

typedef DDS::ContentFilteredTopic ::_var_type	_var_type

Public Types inherited from CORBA::LocalObject
typedef LocalObject_ptr	_ptr_type

typedef LocalObject_var	_var_type

typedef LocalObject_out	_out_type

Public Types inherited from CORBA::Object
typedef Object_ptr	_ptr_type

typedef Object_var	_var_type

typedef Object_out	_out_type

Public Types inherited from OpenDDS::DCPS::LocalObject< DDS::TopicDescription >
typedef DDS::TopicDescription ::_ptr_type	_ptr_type

typedef DDS::TopicDescription ::_var_type	_var_type

Static Public Member Functions inherited from OpenDDS::DCPS::LocalObject< DDS::ContentFilteredTopic >
static _ptr_type	_narrow (CORBA::Object_ptr obj)

Static Public Member Functions inherited from CORBA::LocalObject
static LocalObject_ptr	_duplicate (LocalObject_ptr obj)

static LocalObject_ptr	_nil (void)

static LocalObject_ptr	_narrow (CORBA::Object_ptr obj)

Static Public Member Functions inherited from CORBA::Object
static CORBA::Boolean	marshal (const Object_ptr x, TAO_OutputCDR &cdr)

static void	_tao_any_destructor (void *)

static CORBA::Boolean	is_nil_i (CORBA::Object_ptr obj)

static void	tao_object_initialize (Object *)

static CORBA::Object_ptr	_duplicate (CORBA::Object_ptr obj)

static CORBA::Object_ptr	_nil (void)

static CORBA::Object_ptr	_narrow (CORBA::Object_ptr obj)

Static Public Member Functions inherited from OpenDDS::DCPS::LocalObject< DDS::TopicDescription >
static _ptr_type	_narrow (CORBA::Object_ptr obj)

Protected Member Functions inherited from CORBA::LocalObject
	LocalObject (void)

Protected Member Functions inherited from CORBA::Object
	Object (int dummy=0)

TAO::Object_Proxy_Broker *	proxy_broker () const

Protected Member Functions inherited from OpenDDS::DCPS::RcObject
	RcObject ()

Protected Attributes inherited from CORBA::Object
ACE_Atomic_Op< TAO_SYNCH_MUTEX, unsigned long >	refcount_

Protected Attributes inherited from OpenDDS::DCPS::TopicDescriptionImpl
ACE_CString	topic_name_
	The name of the topic. More...

ACE_CString	type_name_
	The datatype of the topic. More...

DomainParticipantImpl *	participant_
	The participant that creates this topic. More...

OpenDDS::DCPS::TypeSupport_var	type_support_
	The type_support for this topic. More...

Atomic< ACE_UINT32 >	entity_refs_
	The number of entities using this topic. More...

Detailed Description

Definition at line 29 of file ContentFilteredTopicImpl.h.

Constructor & Destructor Documentation

◆ ContentFilteredTopicImpl()

OpenDDS::DCPS::ContentFilteredTopicImpl::ContentFilteredTopicImpl	(	const char *	name,
		DDS::Topic_ptr	related_topic,
		const char *	filter_expression,
		DomainParticipantImpl *	participant
	)

Definition at line 21 of file ContentFilteredTopicImpl.cpp.

References _duplicate(), ACE_DEBUG, ACE_TEXT(), OpenDDS::DCPS::DCPS_debug_level, filter_eval_, LM_DEBUG, and OpenDDS::DCPS::FilterEvaluator::number_parameters().

   : TopicDescriptionImpl(name,
       CORBA::String_var(related_topic->get_type_name()),
       dynamic_cast<TopicDescriptionImpl*>(related_topic)->get_type_support(),
       participant)
   , filter_expression_(filter_expression)
   , filter_eval_(filter_expression, false /*allowOrderBy*/)
   , related_topic_(DDS::Topic::_duplicate(related_topic))
 {
   if (DCPS_debug_level > 5) {
     ACE_DEBUG((LM_DEBUG,
       ACE_TEXT("(%P|%t) ContentFilteredTopicImpl::ContentFilteredTopicImpl() - ")
       ACE_TEXT("Creating cft with filter <%C> which requires <%d> parameters\n"),
       filter_expression, filter_eval_.number_parameters()));
   }
 }

◆ ~ContentFilteredTopicImpl()

virtual OpenDDS::DCPS::ContentFilteredTopicImpl::~ContentFilteredTopicImpl ( )

inlinevirtual

Definition at line 36 of file ContentFilteredTopicImpl.h.

36 {}

Member Function Documentation

◆ add_reader()

void OpenDDS::DCPS::ContentFilteredTopicImpl::add_reader ( DataReaderImpl & reader )

Definition at line 124 of file ContentFilteredTopicImpl.cpp.

References ACE_GUARD, lock_, and readers_.

Referenced by OpenDDS::DCPS::DataReaderImpl::enable_filtering().

 {
   // readers_ does not own or reference-count the reader because
   // the readers reference this CFT and this CFT can't be removed
   // until all readers are gone (DomainParticipant::delete_contentfilteredtopic)
   ACE_GUARD(ACE_Recursive_Thread_Mutex, guard, lock_);
   readers_.push_back(reader);
 }

◆ filter()

template<typename Sample >

bool OpenDDS::DCPS::ContentFilteredTopicImpl::filter	(	const Sample &	s,
		bool	sample_only_has_key_fields
	)		const

inline

Returns true if the sample matches the filter.

Definition at line 50 of file ContentFilteredTopicImpl.h.

References ACE_GUARD_RETURN, and lock_.

   {
     ACE_GUARD_RETURN(ACE_Recursive_Thread_Mutex, guard, lock_, false);
     /*
      * Omit the sample from results if the filter references non-key fields
      * and the sample only has key fields.
      */
     TypeSupportImpl* const ts = dynamic_cast<TypeSupportImpl*>(type_support_.in());
     if (!ts || (sample_only_has_key_fields && filter_eval_.has_non_key_fields(*ts))) {
       return false;
     }
     return filter_eval_.eval(s, expression_parameters_);
   }

◆ get_expression_parameters()

DDS::ReturnCode_t OpenDDS::DCPS::ContentFilteredTopicImpl::get_expression_parameters ( DDS::StringSeq & parameters )

Definition at line 46 of file ContentFilteredTopicImpl.cpp.

References ACE_GUARD_RETURN, expression_parameters_, lock_, DDS::RETCODE_OK, and DDS::RETCODE_OUT_OF_RESOURCES.

 {
   ACE_GUARD_RETURN(ACE_Recursive_Thread_Mutex, guard, lock_,
     DDS::RETCODE_OUT_OF_RESOURCES);
   params = expression_parameters_;
   return DDS::RETCODE_OK;
 }

◆ get_filter_class_name()

const char* OpenDDS::DCPS::ContentFilteredTopicImpl::get_filter_class_name ( ) const

inline

Definition at line 67 of file ContentFilteredTopicImpl.h.

   {
     return filter_eval_.usesExtendedGrammar () ? "OPENDDSSQL" : "DDSSQL";
   }

◆ get_filter_expression()

char * OpenDDS::DCPS::ContentFilteredTopicImpl::get_filter_expression ( )

Implements DDS::ContentFilteredTopic.

Definition at line 40 of file ContentFilteredTopicImpl.cpp.

References filter_expression_, and CORBA::string_dup().

 {
   return CORBA::string_dup(filter_expression_.c_str());
 }

◆ get_related_topic()

DDS::Topic_ptr OpenDDS::DCPS::ContentFilteredTopicImpl::get_related_topic ( )

Implements DDS::ContentFilteredTopic.

Definition at line 118 of file ContentFilteredTopicImpl.cpp.

References related_topic_.

Referenced by OpenDDS::DCPS::SubscriberImpl::create_datareader().

 {
   return DDS::Topic::_duplicate(related_topic_);
 }

◆ OPENDDS_VECTOR()

typedef OpenDDS::DCPS::ContentFilteredTopicImpl::OPENDDS_VECTOR ( WeakRcHandle< DataReaderImpl > )

private

◆ remove_reader()

void OpenDDS::DCPS::ContentFilteredTopicImpl::remove_reader ( DataReaderImpl & reader )

Definition at line 134 of file ContentFilteredTopicImpl.cpp.

References ACE_GUARD, lock_, OPENDDS_END_VERSIONED_NAMESPACE_DECL, readers_, and OpenDDS::DCPS::remove().

 {
   ACE_GUARD(ACE_Recursive_Thread_Mutex, guard, lock_);
   Readers::iterator end = readers_.end();
   readers_.erase(std::remove(readers_.begin(), end, reader), end);
 }

◆ set_expression_parameters()

DDS::ReturnCode_t OpenDDS::DCPS::ContentFilteredTopicImpl::set_expression_parameters ( const DDS::StringSeq & parameters )

Definition at line 61 of file ContentFilteredTopicImpl.cpp.

References ACE_ERROR, ACE_GUARD_RETURN, ACE_TEXT(), OpenDDS::DCPS::DCPS_debug_level, expression_parameters_, filter_eval_, LM_ERROR, lock_, OpenDDS::DCPS::FilterEvaluator::number_parameters(), readers_, DDS::RETCODE_ERROR, DDS::RETCODE_OK, DDS::RETCODE_OUT_OF_RESOURCES, and OpenDDS::DCPS::swap().

 {
   ACE_GUARD_RETURN(ACE_Recursive_Thread_Mutex, guard, lock_,
     DDS::RETCODE_OUT_OF_RESOURCES);
 
   const CORBA::ULong len = p.length();
 
   // Check sequence of strings that give values to the 'parameters' (i.e., "%n" tokens)
   // in the filter_expression matches the size of the parameter sequence.
   // The tokens start with 0 which means that when the maximum number used is 1 we need
   // two parameters: %0 and %1
   if (len != filter_eval_.number_parameters()) {
     if (DCPS_debug_level > 1) {
         ACE_ERROR((LM_ERROR,
           ACE_TEXT("(%P|%t) ContentFilteredTopicImpl::set_expression_parameters() - ")
           ACE_TEXT("passed incorrect set of filter parameters, expected %d received %d\n"),
           filter_eval_.number_parameters(), len));
     }
     return DDS::RETCODE_ERROR;
   }
 
   if (len == expression_parameters_.length()) {
     const char* const* p_buf = p.get_buffer();
     char* const* e_buf = expression_parameters_.get_buffer();
 #ifdef _MSC_VER
 #pragma warning(push)
 #pragma warning(disable : 4996)
 #endif
     if (std::equal(&p_buf[0], &p_buf[len], &e_buf[0], string_equal)) {
       // no change, bail out now to avoid remote InfoRepo calls
       return DDS::RETCODE_OK;
     }
 #ifdef _MSC_VER
 #pragma warning(pop)
 #endif
   }
 
   expression_parameters_ = p;
 
   Readers readers_still_alive;
 
   for (Readers::iterator iter = readers_.begin(),
        end = readers_.end(); iter != end; ++iter) {
     DataReaderImpl_rch reader = iter->lock();
     if (reader) {
       reader->update_subscription_params(p);
       readers_still_alive.push_back(*iter);
     }
   }
 
   using namespace std;
   swap(readers_, readers_still_alive);
 
   return DDS::RETCODE_OK;
 }

Member Data Documentation

◆ expression_parameters_

DDS::StringSeq OpenDDS::DCPS::ContentFilteredTopicImpl::expression_parameters_

private

Definition at line 75 of file ContentFilteredTopicImpl.h.

Referenced by get_expression_parameters(), and set_expression_parameters().

◆ filter_eval_

FilterEvaluator OpenDDS::DCPS::ContentFilteredTopicImpl::filter_eval_

private

Definition at line 74 of file ContentFilteredTopicImpl.h.

Referenced by ContentFilteredTopicImpl(), and set_expression_parameters().

◆ filter_expression_

OPENDDS_STRING OpenDDS::DCPS::ContentFilteredTopicImpl::filter_expression_

private

Definition at line 73 of file ContentFilteredTopicImpl.h.

Referenced by get_filter_expression().

◆ lock_

ACE_Recursive_Thread_Mutex OpenDDS::DCPS::ContentFilteredTopicImpl::lock_

mutableprivate

Concurrent access to expression_parameters_ and readers_.

Definition at line 81 of file ContentFilteredTopicImpl.h.

Referenced by add_reader(), get_expression_parameters(), remove_reader(), and set_expression_parameters().

◆ readers_

Readers OpenDDS::DCPS::ContentFilteredTopicImpl::readers_

private

Definition at line 78 of file ContentFilteredTopicImpl.h.

Referenced by add_reader(), remove_reader(), and set_expression_parameters().

◆ related_topic_

DDS::Topic_var OpenDDS::DCPS::ContentFilteredTopicImpl::related_topic_

private

Definition at line 76 of file ContentFilteredTopicImpl.h.

Referenced by get_related_topic().

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

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ContentFilteredTopicImpl()

◆ ~ContentFilteredTopicImpl()

Member Function Documentation

◆ add_reader()

◆ filter()

◆ get_expression_parameters()

◆ get_filter_class_name()

◆ get_filter_expression()

◆ get_related_topic()

◆ OPENDDS_VECTOR()

◆ remove_reader()

◆ set_expression_parameters()

Member Data Documentation

◆ expression_parameters_

◆ filter_eval_

◆ filter_expression_

◆ lock_

◆ readers_

◆ related_topic_