Primary interface for application message processing, as well as input and output message queueing. More...

#include <Task_T.h>

Inheritance diagram for ACE_Task< ACE_SYNCH_DECL, TIME_POLICY >:

[legend]

Collaboration diagram for ACE_Task< ACE_SYNCH_DECL, TIME_POLICY >:

[legend]

Public Member Functions
	ACE_Task (ACE_Thread_Manager thr_mgr=0, ACE_Message_Queue< ACE_SYNCH_USE, TIME_POLICY > mq=0)

virtual	~ACE_Task ()
	Destructor.

ACE_Message_Queue< ACE_SYNCH_USE, TIME_POLICY > *	msg_queue ()
	Gets the message queue associated with this task.

void	msg_queue (ACE_Message_Queue< ACE_SYNCH_USE, TIME_POLICY > *)
	Sets the message queue associated with this task.

ACE_Time_Value_T< TIME_POLICY >	gettimeofday () const

void	set_time_policy (TIME_POLICY const &time_policy)

int	putq (ACE_Message_Block , ACE_Time_Value timeout=0)

int	getq (ACE_Message_Block &mb, ACE_Time_Value timeout=0)

int	ungetq (ACE_Message_Block , ACE_Time_Value timeout=0)

int	reply (ACE_Message_Block mb, ACE_Time_Value tv=0)

int	put_next (ACE_Message_Block msg, ACE_Time_Value timeout=0)

const ACE_TCHAR *	name () const

virtual ACE_Task< ACE_SYNCH_USE, TIME_POLICY > *	next ()
	Get next Task pointer.

void	next (ACE_Task< ACE_SYNCH_USE, TIME_POLICY > *)
	Set next Task pointer.

ACE_Task< ACE_SYNCH_USE, TIME_POLICY > *	sibling ()

virtual int	flush (u_long flag=ACE_Task_Flags::ACE_FLUSHALL)

void	water_marks (ACE_IO_Cntl_Msg::ACE_IO_Cntl_Cmds, size_t)
	Manipulate watermarks.

void	dump () const
	Dump the state of an object.

Public Member Functions inherited from ACE_Task_Base
	ACE_Task_Base (ACE_Thread_Manager *=0)
	Constructor.

virtual	~ACE_Task_Base ()
	Destructor.

virtual int	open (void *args=0)
	Default ACE_Task open routine.

virtual int	close (u_long flags=0)
	Default ACE_Task close routine.

virtual int	module_closed ()

virtual int	put (ACE_Message_Block , ACE_Time_Value =0)
	Default ACE_Task put routine.

virtual int	svc ()
	Run by a daemon thread to handle deferred processing.

virtual int	activate (long flags=THR_NEW_LWP\|THR_JOINABLE\|THR_INHERIT_SCHED, int n_threads=1, int force_active=0, long priority=ACE_DEFAULT_THREAD_PRIORITY, int grp_id=-1, ACE_Task_Base task=0, ACE_hthread_t thread_handles[]=0, void stack[]=0, size_t stack_size[]=0, ACE_thread_t thread_ids[]=0, const char *thr_name[]=0)

virtual int	wait ()
	Wait for all threads running in a task to exit.

virtual int	suspend ()
	Suspend a task.

virtual int	resume ()
	Resume a suspended task.

int	grp_id () const
	Get the current group id.

void	grp_id (int)
	Set the current group id.

ACE_Thread_Manager *	thr_mgr () const
	Get the thread manager associated with this Task.

void	thr_mgr (ACE_Thread_Manager *)
	Set the thread manager associated with this Task.

int	is_reader () const
	True if queue is a reader, else false.

int	is_writer () const
	True if queue is a writer, else false.

size_t	thr_count () const

ACE_thread_t	last_thread () const

Public Member Functions inherited from ACE_Service_Object
	ACE_Service_Object (ACE_Reactor *=0)
	Constructor.

virtual	~ACE_Service_Object ()
	Destructor.

Public Member Functions inherited from ACE_Event_Handler
virtual	~ACE_Event_Handler ()=default
	Destructor is virtual to enable proper cleanup.

virtual ACE_HANDLE	get_handle () const
	Get the I/O handle.

virtual void	set_handle (ACE_HANDLE)
	Set the I/O handle.

virtual int	priority () const

virtual void	priority (int priority)
	Set the priority of the Event_Handler.

virtual int	handle_input (ACE_HANDLE fd=ACE_INVALID_HANDLE)
	Called when input events occur (e.g., connection or data).

virtual int	handle_output (ACE_HANDLE fd=ACE_INVALID_HANDLE)

virtual int	handle_exception (ACE_HANDLE fd=ACE_INVALID_HANDLE)
	Called when an exceptional events occur (e.g., SIGURG).

virtual int	handle_timeout (const ACE_Time_Value &current_time, const void *act=0)

virtual int	handle_exit (ACE_Process *)
	Called when a process exits.

virtual int	handle_close (ACE_HANDLE handle, ACE_Reactor_Mask close_mask)

virtual int	handle_signal (int signum, siginfo_t =0, ucontext_t =0)

virtual int	resume_handler ()

virtual int	handle_qos (ACE_HANDLE=ACE_INVALID_HANDLE)

virtual int	handle_group_qos (ACE_HANDLE=ACE_INVALID_HANDLE)

virtual void	reactor (ACE_Reactor *reactor)
	Set the event demultiplexors.

virtual ACE_Reactor *	reactor () const
	Get the event demultiplexors.

virtual ACE_Reactor_Timer_Interface *	reactor_timer_interface () const
	Get only the reactor's timer related interface.

virtual Reference_Count	add_reference ()
	Increment reference count on the handler.

virtual Reference_Count	remove_reference ()
	Decrement reference count on the handler.

Reference_Counting_Policy &	reference_counting_policy ()
	Current Reference_Counting_Policy.

Public Member Functions inherited from ACE_Shared_Object
	ACE_Shared_Object ()
	Constructor.

virtual	~ACE_Shared_Object ()
	Destructor.

virtual int	init (int argc, ACE_TCHAR *argv[])
	Initializes object when dynamic linking occurs.

virtual int	fini ()
	Terminates object when dynamic unlinking occurs.

virtual int	info (ACE_TCHAR **info_string, size_t length=0) const
	Returns information on a service object.

Public Attributes
ACE_Message_Queue< ACE_SYNCH_USE, TIME_POLICY > *	msg_queue_
	Queue of messages on the ACE_Task..

bool	delete_msg_queue_
	true if should delete Message_Queue, false otherwise.

ACE_Module< ACE_SYNCH_USE, TIME_POLICY > *	mod_
	Back-pointer to the enclosing module.

ACE_Task< ACE_SYNCH_USE, TIME_POLICY > *	next_
	Pointer to adjacent ACE_Task.

	ACE_ALLOC_HOOK_DECLARE
	Declare the dynamic allocation hooks.

Public Attributes inherited from ACE_Service_Object
	ACE_ALLOC_HOOK_DECLARE
	Declare the dynamic allocation hooks.

Private Member Functions
void	operator= (const ACE_Task< ACE_SYNCH_USE, TIME_POLICY > &)=delete

	ACE_Task (const ACE_Task< ACE_SYNCH_USE, TIME_POLICY > &)=delete

Friends
class	ACE_Module< ACE_SYNCH_USE, TIME_POLICY >

class	ACE_Module_Type

Additional Inherited Members
Public Types inherited from ACE_Event_Handler
enum	{ LO_PRIORITY = 0 , HI_PRIORITY = 10 , NULL_MASK = 0 , READ_MASK = (1 << 0) , WRITE_MASK = (1 << 1) , EXCEPT_MASK = (1 << 2) , ACCEPT_MASK = (1 << 3) , CONNECT_MASK = (1 << 4) , TIMER_MASK = (1 << 5) , QOS_MASK = (1 << 6) , GROUP_QOS_MASK = (1 << 7) , SIGNAL_MASK = (1 << 8) , ALL_EVENTS_MASK , RWE_MASK , DONT_CALL = (1 << 9) }

enum	{ ACE_EVENT_HANDLER_NOT_RESUMED = -1 , ACE_REACTOR_RESUMES_HANDLER = 0 , ACE_APPLICATION_RESUMES_HANDLER }

typedef long	Reference_Count
	Reference count type.

Static Public Member Functions inherited from ACE_Task_Base
static ACE_THR_FUNC_RETURN	svc_run (void *)
	Routine that runs the service routine as a daemon thread.

static void	cleanup (void object, void params)

Static Public Member Functions inherited from ACE_Event_Handler
static ACE_THR_FUNC_RETURN	read_adapter (void *event_handler)

static int	register_stdin_handler (ACE_Event_Handler eh, ACE_Reactor reactor, ACE_Thread_Manager *thr_mgr, int flags=THR_DETACHED)

static int	remove_stdin_handler (ACE_Reactor reactor, ACE_Thread_Manager thr_mgr)
	Performs the inverse of the register_stdin_handler() method.

Protected Types inherited from ACE_Event_Handler
typedef std::atomic< Reference_Count >	Atomic_Reference_Count
	Typedef for implementation of reference counting.

Protected Member Functions inherited from ACE_Event_Handler
	ACE_Event_Handler (ACE_Reactor *=nullptr, int priority=ACE_Event_Handler::LO_PRIORITY)
	Force ACE_Event_Handler to be an abstract base class.

Protected Attributes inherited from ACE_Task_Base
size_t	thr_count_

ACE_Thread_Manager *	thr_mgr_
	Multi-threading manager.

u_long	flags_
	ACE_Task flags.

int	grp_id_
	This maintains the group id of the Task.

ACE_thread_t	last_thread_id_
	Holds the thread ID of the last thread to exit svc() in this object.

Protected Attributes inherited from ACE_Event_Handler
Atomic_Reference_Count	reference_count_
	Reference count.

Detailed Description

template<ACE_SYNCH_DECL, class TIME_POLICY = ACE_System_Time_Policy>
class ACE_Task< ACE_SYNCH_DECL, TIME_POLICY >

Primary interface for application message processing, as well as input and output message queueing.

This class serves as the basis for passive and active objects in ACE.

Constructor & Destructor Documentation

◆ ACE_Task() [1/2]

template<ACE_SYNCH_DECL , class TIME_POLICY >

ACE_Task< ACE_SYNCH_DECL, TIME_POLICY >::ACE_Task	(	ACE_Thread_Manager *	thr_mgr = 0,
		ACE_Message_Queue< ACE_SYNCH_USE, TIME_POLICY > *	mq = 0 )

Initialize a Task, supplying a thread manager and a message queue. If the user doesn't supply a ACE_Message_Queue pointer then we'll allocate one dynamically. Otherwise, we'll use the one passed as a parameter.

◆ ~ACE_Task()

template<ACE_SYNCH_DECL , class TIME_POLICY >

ACE_Task< ACE_SYNCH_DECL, TIME_POLICY >::~ACE_Task ( )

virtual

Destructor.

◆ ACE_Task() [2/2]

template<ACE_SYNCH_DECL , class TIME_POLICY = ACE_System_Time_Policy>

ACE_Task< ACE_SYNCH_DECL, TIME_POLICY >::ACE_Task ( const ACE_Task< ACE_SYNCH_USE, TIME_POLICY > & )

privatedelete

Member Function Documentation

◆ dump()

template<ACE_SYNCH_DECL , class TIME_POLICY = ACE_System_Time_Policy>

class TIME_POLICY void ACE_Task< ACE_SYNCH_DECL, TIME_POLICY >::dump ( ) const

Dump the state of an object.

◆ flush()

template<ACE_SYNCH_DECL , class TIME_POLICY >

int ACE_Task< ACE_SYNCH_DECL, TIME_POLICY >::flush ( u_long flag = ACE_Task_Flags::ACE_FLUSHALL )

inlinevirtual

Flush the task's queue, i.e., free all of the enqueued message blocks and unblocks any threads waiting on the queue. Note that if this conflicts with the C++ iostream <flush> function, just rewrite the iostream function as ::<flush>.

◆ getq()

template<ACE_SYNCH_DECL , class TIME_POLICY >

int ACE_Task< ACE_SYNCH_DECL, TIME_POLICY >::getq	(	ACE_Message_Block *&	mb,
		ACE_Time_Value *	timeout = 0 )

inline

Extract the first message from the queue (blocking). Note that timeout uses <{absolute}> time rather than <{relative}> time. Returns number of items in queue if the call succeeds or -1 otherwise.

◆ gettimeofday()

template<ACE_SYNCH_DECL , class TIME_POLICY >

ACE_Time_Value_T< TIME_POLICY > ACE_Task< ACE_SYNCH_DECL, TIME_POLICY >::gettimeofday ( ) const

Get the current time of day according to the queue's TIME_POLICY. Allows users to initialize timeout values using correct time policy.

◆ msg_queue() [1/2]

template<ACE_SYNCH_DECL , class TIME_POLICY >

ACE_Message_Queue< ACE_SYNCH_USE, TIME_POLICY > * ACE_Task< ACE_SYNCH_DECL, TIME_POLICY >::msg_queue ( )

Gets the message queue associated with this task.

◆ msg_queue() [2/2]

template<ACE_SYNCH_DECL , class TIME_POLICY >

void ACE_Task< ACE_SYNCH_DECL, TIME_POLICY >::msg_queue ( ACE_Message_Queue< ACE_SYNCH_USE, TIME_POLICY > * mq )

inline

Sets the message queue associated with this task.

◆ name()

template<ACE_SYNCH_DECL , class TIME_POLICY >

const ACE_TCHAR * ACE_Task< ACE_SYNCH_DECL, TIME_POLICY >::name ( ) const

Return the name of the enclosing Module if there's one associated with the Task, else returns 0.

◆ next() [1/2]

template<ACE_SYNCH_DECL , class TIME_POLICY >

ACE_Task< ACE_SYNCH_USE, TIME_POLICY > * ACE_Task< ACE_SYNCH_DECL, TIME_POLICY >::next ( )

inlinevirtual

Get next Task pointer.

◆ next() [2/2]

template<ACE_SYNCH_DECL , class TIME_POLICY >

void ACE_Task< ACE_SYNCH_DECL, TIME_POLICY >::next ( ACE_Task< ACE_SYNCH_USE, TIME_POLICY > * q )

inline

Set next Task pointer.

◆ operator=()

template<ACE_SYNCH_DECL , class TIME_POLICY = ACE_System_Time_Policy>

void ACE_Task< ACE_SYNCH_DECL, TIME_POLICY >::operator= ( const ACE_Task< ACE_SYNCH_USE, TIME_POLICY > & )

privatedelete

◆ put_next()

template<ACE_SYNCH_DECL , class TIME_POLICY >

int ACE_Task< ACE_SYNCH_DECL, TIME_POLICY >::put_next	(	ACE_Message_Block *	msg,
		ACE_Time_Value *	timeout = 0 )

inline

Transfer message to the adjacent ACE_Task in a ACE_Stream. Note that timeout uses <{absolute}> time rather than <{relative}> time.

◆ putq()

template<ACE_SYNCH_DECL , class TIME_POLICY >

int ACE_Task< ACE_SYNCH_DECL, TIME_POLICY >::putq	(	ACE_Message_Block *	mb,
		ACE_Time_Value *	timeout = 0 )

inline

Insert message into the message queue. Note that timeout uses <{absolute}> time rather than <{relative}> time.

◆ reply()

template<ACE_SYNCH_DECL , class TIME_POLICY >

int ACE_Task< ACE_SYNCH_DECL, TIME_POLICY >::reply	(	ACE_Message_Block *	mb,
		ACE_Time_Value *	tv = 0 )

inline

Turn the message around, sending it in the opposite direction in the stream. To do this, the message is put onto the task next in the stream after this task's sibling.

Parameters

mb	Pointer to the block that is used in the reply.
tv	The absolute time at which the put operation used to send the message block to the next module in the stream will time out. If 0, this call blocks until it can be completed.

◆ set_time_policy()

template<ACE_SYNCH_DECL , class TIME_POLICY >

void ACE_Task< ACE_SYNCH_DECL, TIME_POLICY >::set_time_policy ( TIME_POLICY const & time_policy )

Allows applications to control how the timer queue gets the time of day.

◆ sibling()

template<ACE_SYNCH_DECL , class TIME_POLICY >

ACE_Task< ACE_SYNCH_USE, TIME_POLICY > * ACE_Task< ACE_SYNCH_DECL, TIME_POLICY >::sibling ( )

Return the Task's sibling if there's one associated with the Task's Module, else returns 0.

◆ ungetq()

template<ACE_SYNCH_DECL , class TIME_POLICY >

int ACE_Task< ACE_SYNCH_DECL, TIME_POLICY >::ungetq	(	ACE_Message_Block *	mb,
		ACE_Time_Value *	timeout = 0 )

inline

Return a message to the queue. Note that timeout uses <{absolute}> time rather than <{relative}> time.

◆ water_marks()

template<ACE_SYNCH_DECL , class TIME_POLICY >

void ACE_Task< ACE_SYNCH_DECL, TIME_POLICY >::water_marks	(	ACE_IO_Cntl_Msg::ACE_IO_Cntl_Cmds	cmd,
		size_t	wm_size )

inline

Manipulate watermarks.

Friends And Related Symbol Documentation

◆ ACE_Module< ACE_SYNCH_USE, TIME_POLICY >

template<ACE_SYNCH_DECL , class TIME_POLICY = ACE_System_Time_Policy>

friend class ACE_Module< ACE_SYNCH_USE, TIME_POLICY >

friend

◆ ACE_Module_Type

template<ACE_SYNCH_DECL , class TIME_POLICY = ACE_System_Time_Policy>

friend class ACE_Module_Type

friend

Member Data Documentation

◆ ACE_ALLOC_HOOK_DECLARE

template<ACE_SYNCH_DECL , class TIME_POLICY = ACE_System_Time_Policy>

ACE_Task< ACE_SYNCH_DECL, TIME_POLICY >::ACE_ALLOC_HOOK_DECLARE

Declare the dynamic allocation hooks.

◆ delete_msg_queue_

template<ACE_SYNCH_DECL , class TIME_POLICY = ACE_System_Time_Policy>

bool ACE_Task< ACE_SYNCH_DECL, TIME_POLICY >::delete_msg_queue_

true if should delete Message_Queue, false otherwise.

◆ mod_

template<ACE_SYNCH_DECL , class TIME_POLICY = ACE_System_Time_Policy>

ACE_Module<ACE_SYNCH_USE, TIME_POLICY>* ACE_Task< ACE_SYNCH_DECL, TIME_POLICY >::mod_

Back-pointer to the enclosing module.

◆ msg_queue_

template<ACE_SYNCH_DECL , class TIME_POLICY = ACE_System_Time_Policy>

ACE_Message_Queue<ACE_SYNCH_USE, TIME_POLICY>* ACE_Task< ACE_SYNCH_DECL, TIME_POLICY >::msg_queue_

Queue of messages on the ACE_Task..

◆ next_

template<ACE_SYNCH_DECL , class TIME_POLICY = ACE_System_Time_Policy>

ACE_Task<ACE_SYNCH_USE, TIME_POLICY>* ACE_Task< ACE_SYNCH_DECL, TIME_POLICY >::next_

Pointer to adjacent ACE_Task.

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

Public Member Functions

Public Attributes

Private Member Functions

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ACE_Task() [1/2]

◆ ~ACE_Task()

◆ ACE_Task() [2/2]

Member Function Documentation

◆ dump()

◆ flush()

◆ getq()

◆ gettimeofday()

◆ msg_queue() [1/2]

◆ msg_queue() [2/2]

◆ name()

◆ next() [1/2]

◆ next() [2/2]

◆ operator=()

◆ put_next()

◆ putq()

◆ reply()

◆ set_time_policy()

◆ sibling()

◆ ungetq()

◆ water_marks()

Friends And Related Symbol Documentation

◆ ACE_Module< ACE_SYNCH_USE, TIME_POLICY >

◆ ACE_Module_Type

Member Data Documentation

◆ ACE_ALLOC_HOOK_DECLARE

◆ delete_msg_queue_

◆ mod_

◆ msg_queue_

◆ next_