OpenDDS::DCPS::ThreadSynchWorker Class Reference

#include <ThreadSynchWorker.h>

Inheritance diagram for OpenDDS::DCPS::ThreadSynchWorker:

[legend]

Collaboration diagram for OpenDDS::DCPS::ThreadSynchWorker:

[legend]

List of all members.

Public Types
enum	WorkOutcome { WORK_OUTCOME_MORE_TO_DO, WORK_OUTCOME_NO_MORE_TO_DO, WORK_OUTCOME_CLOGGED_RESOURCE, WORK_OUTCOME_BROKEN_RESOURCE }
Public Member Functions
virtual	~ThreadSynchWorker ()
virtual WorkOutcome	perform_work ()=0
virtual void	schedule_output ()
	Indicate that queued data is available to be sent.
std::size_t	id () const
	DataLink reference value for diagnostics.
virtual ACE_HANDLE	get_handle ()=0
Protected Member Functions
	ThreadSynchWorker (std::size_t id=0)
Private Attributes
std::size_t	id_

---

Detailed Description

Definition at line 22 of file ThreadSynchWorker.h.

---

Member Enumeration Documentation

enum OpenDDS::DCPS::ThreadSynchWorker::WorkOutcome

Enumerator:

WORK_OUTCOME_MORE_TO_DO
WORK_OUTCOME_NO_MORE_TO_DO
WORK_OUTCOME_CLOGGED_RESOURCE
WORK_OUTCOME_BROKEN_RESOURCE

Definition at line 28 of file ThreadSynchWorker.h.

                   {
    WORK_OUTCOME_MORE_TO_DO,
    WORK_OUTCOME_NO_MORE_TO_DO,
    WORK_OUTCOME_CLOGGED_RESOURCE,
    WORK_OUTCOME_BROKEN_RESOURCE
  };

---

Constructor & Destructor Documentation

OpenDDS::DCPS::ThreadSynchWorker::~ThreadSynchWorker

(

)

[virtual]

Definition at line 15 of file ThreadSynchWorker.cpp.

References DBG_ENTRY_LVL.

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

ACE_INLINE OpenDDS::DCPS::ThreadSynchWorker::ThreadSynchWorker

(

std::size_t

id = 0

)

[protected]

Definition at line 11 of file ThreadSynchWorker.inl.

References DBG_ENTRY_LVL.

 : id_(id)
{
  DBG_ENTRY_LVL("ThreadSynchWorker","ThreadSynchWorker",6);
}

---

Member Function Documentation

virtual ACE_HANDLE OpenDDS::DCPS::ThreadSynchWorker::get_handle

(

)

[pure virtual]

Implemented in OpenDDS::DCPS::TransportSendStrategy, and OpenDDS::DCPS::TcpSendStrategy.

Referenced by OpenDDS::DCPS::ThreadSynch::register_worker().

Here is the caller graph for this function:

ACE_INLINE std::size_t OpenDDS::DCPS::ThreadSynchWorker::id

(

void

)

const

DataLink reference value for diagnostics.

Definition at line 19 of file ThreadSynchWorker.inl.

References DBG_ENTRY_LVL, and id_.

Referenced by OpenDDS::DCPS::ScheduleOutputHandler::handle_exception().

{
  DBG_ENTRY_LVL("ThreadSynchWorker","id",6);

  return id_;
}

Here is the caller graph for this function:

virtual WorkOutcome OpenDDS::DCPS::ThreadSynchWorker::perform_work

(

)

[pure virtual]

Implemented in OpenDDS::DCPS::TransportSendStrategy.

ACE_INLINE void OpenDDS::DCPS::ThreadSynchWorker::schedule_output

(

)

[virtual]

Indicate that queued data is available to be sent.

Reimplemented in OpenDDS::DCPS::TcpSendStrategy.

Definition at line 28 of file ThreadSynchWorker.inl.

References DBG_ENTRY_LVL.

{
  DBG_ENTRY_LVL("ThreadSynchWorker","schedule_output",6);
}

---

Member Data Documentation

std::size_t OpenDDS::DCPS::ThreadSynchWorker::id_ [private]

Definition at line 50 of file ThreadSynchWorker.h.

Referenced by id().

---

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

• ThreadSynchWorker.h
• ThreadSynchWorker.cpp
• ThreadSynchWorker.inl