ACE_Module(3) · carta

NAME

ACE_Module - An abstraction for managing a bi-directional flow of messages.

SYNOPSIS

#include <ace/Module.h>
template<ACE_SYNCH_DECL>
class ACE_Module : public ACE_Module_Base
{
  public:
    friend class ACE_Shutup_GPlusPlus; // Turn off g++ warning;
    ACE_Module (void);
    ~ACE_Module (void);
    ACE_Module (
        const ASYS_TCHAR *module_name,
        ACE_Task<ACE_SYNCH_USE> *writer = 0,
        ACE_Task<ACE_SYNCH_USE> *reader = 0,
        void *args = 0,
        int flags = M_DELETE
        );
    int open (
        const ASYS_TCHAR *module_name,
        ACE_Task<ACE_SYNCH_USE> *writer = 0,
        ACE_Task<ACE_SYNCH_USE> *reader = 0,
        void *a = 0,
        int flags = M_DELETE
        );
    int close (int flags = M_DELETE_NONE);
    ACE_Task<ACE_SYNCH_USE> *writer (void);
    void writer (
        ACE_Task<ACE_SYNCH_USE> *q,
        int flags = M_DELETE_WRITER
        );
    ACE_Task<ACE_SYNCH_USE> *reader (void);
    void reader (
        ACE_Task<ACE_SYNCH_USE> *q,
        int flags = M_DELETE_READER
        );
    ACE_Task<ACE_SYNCH_USE> *sibling (ACE_Task<ACE_SYNCH_USE> *orig);
    const ASYS_TCHAR *name (void) const;
    void name (const ASYS_TCHAR *);
    void *arg (void) const;
    void arg (void *);
    void link (ACE_Module<ACE_SYNCH_USE> *m);
    ACE_Module<ACE_SYNCH_USE> *next (void);
    void next (ACE_Module<ACE_SYNCH_USE> *m);
    void dump (void) const;
    ACE_ALLOC_HOOK_DECLARE;
  private:
    int close_i (int which, int flags);
    ACE_Task<ACE_SYNCH_USE> *q_pair_[2];
    ASYS_TCHAR name_[MAXNAMLEN + 1];
    ACE_Module<ACE_SYNCH_USE> *next_;
    void *arg_;
    int flags_;
};

DESCRIPTION

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.

Initialization and termination methods.

ACE_Module (void);

Create an empty Module.

~ACE_Module (void);

Shutdown the Module.

ACE_Module (
    const ASYS_TCHAR *module_name,
    ACE_Task<ACE_SYNCH_USE> *writer = 0,
    ACE_Task<ACE_SYNCH_USE> *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.

int open (
    const ASYS_TCHAR *module_name,
    ACE_Task<ACE_SYNCH_USE> *writer = 0,
    ACE_Task<ACE_SYNCH_USE> *reader = 0,
    void *a = 0,
    int flags = M_DELETE
    );

Create an initialized 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.

int 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.

ACE_Task manipulation routines

ACE_Task<ACE_SYNCH_USE> *writer (void);

Get the writer task.

void writer (ACE_Task<ACE_SYNCH_USE> *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.

ACE_Task<ACE_SYNCH_USE> *reader (void);

Get the reader task.

void reader (ACE_Task<ACE_SYNCH_USE> *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.

ACE_Task<ACE_SYNCH_USE> *sibling (ACE_Task<ACE_SYNCH_USE> *orig);

Set and get pointer to sibling ACE_Task in an ACE_Module

Identify the module

const ASYS_TCHAR *name (void) const;

Get the module name.

void name (const ASYS_TCHAR *);

Set the module name.

Argument to the Tasks.

void *arg (void) const;

Get the argument passed to the tasks.

void arg (void *);

Set the argument passed to the tasks.

void link (ACE_Module<ACE_SYNCH_USE> *m);

Link to other modules in the ustream stack

ACE_Module<ACE_SYNCH_USE> *next (void);

Get the next pointer to the module above in the stream.

void next (ACE_Module<ACE_SYNCH_USE> *m);

Set the next pointer to the module above in the stream.

void dump (void) const;

Dump the state of an object.

ACE_ALLOC_HOOK_DECLARE;

Declare the dynamic allocation hooks.

AUTHOR

Doug Schmidt

LIBRARY

ace