OpenDDS::DCPS::ThreadSynch Class Reference

#include <ThreadSynch.h>

Inheritance diagram for OpenDDS::DCPS::ThreadSynch:

Collaboration diagram for OpenDDS::DCPS::ThreadSynch:

Public Member Functions
virtual	~ThreadSynch ()
int	register_worker (ThreadSynchWorker &worker)
void	unregister_worker ()
	Our owner, the worker_, is breaking our relationship. More...
virtual void	work_available ()=0

Protected Member Functions
	ThreadSynch (ThreadSynchResource *resource)
int	wait_on_clogged_resource ()
virtual int	register_worker_i ()
virtual void	unregister_worker_i ()
WeakRcHandle< ThreadSynchWorker >	worker ()
	Access the worker implementation directly. More...

Private Attributes
WeakRcHandle< ThreadSynchWorker >	worker_
unique_ptr< ThreadSynchResource >	resource_

Detailed Description

This class is the base class for different ThreadSynch stratege, currently only the thread per connection strategy is implemented and used.

Notes for object ownership: 1) Pointer to TransportSendStrategy object (as ThreadSynchWorker) directly but not reference counted. It won't have access problem during it lifetime because the TransportSendStrategy object owns this ThreadSynch object. 2) The ThreadSynch object is created by the ThreadSynchResource object and it owns the ThreadSynchResource object.

Definition at line 34 of file ThreadSynch.h.

Constructor & Destructor Documentation

~ThreadSynch()

OpenDDS::DCPS::ThreadSynch::~ThreadSynch ( )

virtual

Definition at line 15 of file ThreadSynch.cpp.

References DBG_ENTRY_LVL.

{
  DBG_ENTRY_LVL("ThreadSynch","~ThreadSynch",6);
}

ThreadSynch()

ACE_INLINE OpenDDS::DCPS::ThreadSynch::ThreadSynch ( ThreadSynchResource *  resource )

protected

Note that we allow the ThreadSynchResource pointer to be NULL to support the NullSynch case.

Definition at line 14 of file ThreadSynch.inl.

References ACE_INLINE, and DBG_ENTRY_LVL.

  : resource_(resource)
{
  DBG_ENTRY_LVL("ThreadSynch","ThreadSynch",6);
}

Member Function Documentation

register_worker()

ACE_INLINE int OpenDDS::DCPS::ThreadSynch::register_worker

(

ThreadSynchWorker &

worker

)

The worker must introduce himself to this ThreadSynch object. It is the worker object that "owns" this ThreadSynch object. Returns 0 for success, -1 for failure.

Definition at line 28 of file ThreadSynch.inl.

References ACE_INLINE, DBG_ENTRY_LVL, OpenDDS::DCPS::ThreadSynchWorker::get_handle(), register_worker_i(), resource_, worker(), and worker_.

{
  DBG_ENTRY_LVL("ThreadSynch","register_worker",6);
  this->worker_ = worker;
  if (resource_)
    resource_->set_handle(worker.get_handle());
  return this->register_worker_i();
}

register_worker_i()

int OpenDDS::DCPS::ThreadSynch::register_worker_i ( )

protectedvirtual

The default implementation is to do nothing here. The subclass may override the implementation in order to do something when the worker registers. Returns 0 for success, -1 for failure.

Reimplemented in OpenDDS::DCPS::PerConnectionSynch.

Definition at line 21 of file ThreadSynch.cpp.

References DBG_ENTRY_LVL.

Referenced by register_worker().

{
  DBG_ENTRY_LVL("ThreadSynch","register_worker_i",6);
  // Default implementation is to do nothing here.  Subclass may override.
  return 0;
}

unregister_worker()

ACE_INLINE void OpenDDS::DCPS::ThreadSynch::unregister_worker

(

)

Our owner, the worker_, is breaking our relationship.

Definition at line 38 of file ThreadSynch.inl.

References ACE_INLINE, DBG_ENTRY_LVL, and unregister_worker_i().

{
  DBG_ENTRY_LVL("ThreadSynch","unregister_worker",6);
  this->unregister_worker_i();
}

unregister_worker_i()

void OpenDDS::DCPS::ThreadSynch::unregister_worker_i ( )

protectedvirtual

The default implementation is to do nothing here. The subclass may override the implementation in order to do something when the worker unregisters.

Reimplemented in OpenDDS::DCPS::PerConnectionSynch, and OpenDDS::DCPS::PoolSynch.

Definition at line 29 of file ThreadSynch.cpp.

References DBG_ENTRY_LVL.

Referenced by unregister_worker().

{
  DBG_ENTRY_LVL("ThreadSynch","unregister_worker_i",6);
  // Default implementation is to do nothing here.  Subclass may override.
}

wait_on_clogged_resource()

ACE_INLINE int OpenDDS::DCPS::ThreadSynch::wait_on_clogged_resource ( )

protected

Definition at line 46 of file ThreadSynch.inl.

References ACE_ERROR, DBG_ENTRY_LVL, LM_ERROR, and resource_.

Referenced by OpenDDS::DCPS::PerConnectionSynch::svc().

{
  DBG_ENTRY_LVL("ThreadSynch","wait_on_clogged_resource",6);

  int result = -1;

  if (this->resource_) {
    result = this->resource_->wait_to_unclog();

  } else {
    ACE_ERROR((LM_ERROR,
               "(%P|%t) ERROR: ThreadSynch cannot wait on a NULL clogged resource.\n"));
  }

  return result;
}

work_available()

virtual void OpenDDS::DCPS::ThreadSynch::work_available ( )

pure virtual

The ThreadSynchWorker would like to have its perform_work() called from the appropriate thread once the ThreadSynchResource claims that it is_ready_for_work().

Implemented in OpenDDS::DCPS::ReactorSynch, OpenDDS::DCPS::PerConnectionSynch, OpenDDS::DCPS::PoolSynch, and OpenDDS::DCPS::NullSynch.

Referenced by OpenDDS::DCPS::TcpSendStrategy::schedule_output().

worker()

ACE_INLINE OpenDDS::DCPS::WeakRcHandle< OpenDDS::DCPS::ThreadSynchWorker > OpenDDS::DCPS::ThreadSynch::worker ( )

protected

Access the worker implementation directly.

Definition at line 22 of file ThreadSynch.inl.

References ACE_INLINE, and worker_.

Referenced by OpenDDS::DCPS::ReactorSynch::ReactorSynch(), register_worker(), OpenDDS::DCPS::PerConnectionSynch::svc(), and OpenDDS::DCPS::ReactorSynch::~ReactorSynch().

{
  return worker_;
}

Member Data Documentation

resource_

unique_ptr<ThreadSynchResource> OpenDDS::DCPS::ThreadSynch::resource_

private

Definition at line 75 of file ThreadSynch.h.

Referenced by register_worker(), and wait_on_clogged_resource().

worker_

WeakRcHandle<ThreadSynchWorker> OpenDDS::DCPS::ThreadSynch::worker_

private

Definition at line 74 of file ThreadSynch.h.

Referenced by register_worker(), and worker().

---

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

• ThreadSynch.h
• ThreadSynch.cpp
• ThreadSynch.inl