An abstraction for managing a bi-directional flow of messages. More...
#include <Module.h>
Public Attributes | |
| ACE_ALLOC_HOOK_DECLARE | |
| Declare the dynamic allocation hooks. | |
Private Member Functions | |
| int | close_i (int which, int flags) |
Private Attributes | |
| ACE_Task< ACE_SYNCH_USE, TIME_POLICY > * | q_pair_ [2] |
| ACE_TCHAR | name_ [MAXPATHLEN+1] |
| Name of the ACE_Module. | |
| ACE_Module< ACE_SYNCH_USE, TIME_POLICY > * | next_ |
| Next ACE_Module in the stack. | |
| void * | arg_ |
| int | flags_ |
Additional Inherited Members | |
 Public Types inherited from ACE_Module_Base | |
| enum | { M_FLAGS_NOT_SET = 0 , M_DELETE_READER = 1 , M_DELETE_WRITER = 2 , M_DELETE = 3 , M_DELETE_NONE = 4 } |
Detailed Description
class ACE_Module< ACE_SYNCH_DECL, TIME_POLICY >
An abstraction for managing a bi-directional flow of messages.
This is based on the Module concept in System V Streams, which contains a pair of Tasks, one for handling upstream processing, one for handling downstream processing. In general, you shouldn't subclass from this class, but instead subclass from the ACE_Task.
Constructor & Destructor Documentation
◆ ACE_Module() [1/2]
Create an empty Module.
◆ ~ACE_Module()
|
virtual |
Shutdown the Module.
◆ ACE_Module() [2/2]
| ACE_Module< ACE_SYNCH_DECL, TIME_POLICY >::ACE_Module | ( | const ACE_TCHAR * | module_name, |
| ACE_Task< ACE_SYNCH_USE, TIME_POLICY > * | writer = 0, | ||
| ACE_Task< ACE_SYNCH_USE, TIME_POLICY > * | reader = 0, | ||
| void * | args = 0, | ||
| int | flags = M_DELETE ) |
Create an initialized module with module_name as its identity and reader and writer as its tasks.
Member Function Documentation
◆ arg() [1/2]
|
inline |
Get the argument passed to the tasks.
◆ arg() [2/2]
|
inline |
Set the argument passed to the tasks.
◆ close()
| int ACE_Module< ACE_SYNCH_DECL, TIME_POLICY >::close | ( | int | flags = M_DELETE_NONE | ) |
Close down the module and its tasks. The flags argument can be used to override the default behaviour, which depends on previous flags values in calls to c'tor, <open>, <reader>, and <writer>. A previous value M_DELETE[_XXX] can not be overridden. Should not be called from within <ACE_Task::module_closed>.
◆ close_i()
|
private |
Implements the close operation for either the reader or the writer task (depending on which).
◆ dump()
| class TIME_POLICY void ACE_Module< ACE_SYNCH_DECL, TIME_POLICY >::dump | ( | ) | const |
Dump the state of an object.
◆ link()
| void ACE_Module< ACE_SYNCH_DECL, TIME_POLICY >::link | ( | ACE_Module< ACE_SYNCH_USE, TIME_POLICY > * | m | ) |
Link to other modules in the ustream stack.
◆ name() [1/2]
|
inline |
Get the module name.
◆ name() [2/2]
|
inline |
Set the module name.
◆ next() [1/2]
|
inlinevirtual |
Get the next pointer to the module above in the stream.
◆ next() [2/2]
|
inlinevirtual |
Set the next pointer to the module above in the stream.
◆ open()
| int ACE_Module< ACE_SYNCH_DECL, TIME_POLICY >::open | ( | const ACE_TCHAR * | module_name, |
| ACE_Task< ACE_SYNCH_USE, TIME_POLICY > * | writer = 0, | ||
| ACE_Task< ACE_SYNCH_USE, TIME_POLICY > * | reader = 0, | ||
| void * | a = 0, | ||
| int | flags = M_DELETE ) |
Initialize the module with module_name as its identity and reader> and writer as its tasks. Previously register reader or writers or closed down and deleted according to the value of flags_. Should not be called from within <ACE_Task::module_closed>.
◆ reader() [1/2]
|
inline |
Get the reader task.
◆ reader() [2/2]
| void ACE_Module< ACE_SYNCH_DECL, TIME_POLICY >::reader | ( | ACE_Task< ACE_SYNCH_USE, TIME_POLICY > * | q, |
| int | flags = M_DELETE_READER ) |
Set the reader task. flags can be used to indicate that the module should delete the reader during a call to close or to the destructor. If a previous reader exists, it is closed. It may also be deleted, depending on the old flags_ value. Should not be called from within <ACE_Task::module_closed>.
◆ sibling()
| ACE_Task< ACE_SYNCH_USE, TIME_POLICY > * ACE_Module< ACE_SYNCH_DECL, TIME_POLICY >::sibling | ( | ACE_Task< ACE_SYNCH_USE, TIME_POLICY > * | orig | ) |
Set and get pointer to sibling ACE_Task in an ACE_Module.
◆ writer() [1/2]
|
inline |
Get the writer task.
◆ writer() [2/2]
| void ACE_Module< ACE_SYNCH_DECL, TIME_POLICY >::writer | ( | ACE_Task< ACE_SYNCH_USE, TIME_POLICY > * | q, |
| int | flags = M_DELETE_WRITER ) |
Set the writer task. flags can be used to indicate that the module should delete the writer during a call to close or to the destructor. If a previous writer exists, it is closed. It may also be deleted, depending on the old flags_ value. Should not be called from within <ACE_Task::module_closed>.
Member Data Documentation
◆ ACE_ALLOC_HOOK_DECLARE
| ACE_Module< ACE_SYNCH_DECL, TIME_POLICY >::ACE_ALLOC_HOOK_DECLARE |
Declare the dynamic allocation hooks.
◆ arg_
|
private |
Argument passed through to the reader and writer task when they are opened.
◆ flags_
|
private |
Holds flags which are used to determine if the reader and writer task have to be deleted on exit
◆ name_
|
private |
Name of the ACE_Module.
◆ next_
|
private |
Next ACE_Module in the stack.
◆ q_pair_
|
private |
Pair of Tasks that form the "read-side" and "write-side" of the ACE_Module partitioning.
The documentation for this class was generated from the following files:
