Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members   Related Pages  

ACE_IO_Cntl_Msg Class Reference

Data format for IOCTL messages. More...

#include <IO_Cntl_Msg.h>

List of all members.

Public Types

typedef u_short ACE_IO_Cntl_Cmds
enum  {
  SET_LWM = 1, GET_LWM = 2, SET_HWM = 3, GET_HWM = 4,
  MOD_LINK = 5, MOD_UNLINK = 6
}

Public Methods

 ACE_IO_Cntl_Msg (ACE_IO_Cntl_Cmds c)
 Initialize the control message. More...

ACE_IO_Cntl_Cmds cmd (void)
 Get command. More...

void cmd (ACE_IO_Cntl_Cmds c)
 Set command. More...

size_t count (void)
 Get count. More...

void count (size_t c)
 Set count. More...

int error (void)
 Get error. More...

void error (int e)
 Set error. More...

int rval (void)
 Get return value. More...

void rval (int r)
 Set return value. More...

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


Public Attributes

 ACE_ALLOC_HOOK_DECLARE
 Declare the dynamic allocation hooks. More...


Private Attributes

ACE_IO_Cntl_Cmds cmd_
 Command. More...

size_t count_
 Count. More...

int error_
 Error. More...

int rval_
 Return value. More...

Detailed Description

Data format for IOCTL messages.

Definition at line 32 of file IO_Cntl_Msg.h.

Member Typedef Documentation

typedef u_short ACE_IO_Cntl_Msg::ACE_IO_Cntl_Cmds
 

Definition at line 51 of file IO_Cntl_Msg.h.

Referenced by ACE_Stream_Tail::control, ACE_Stream_Head::control, ACE_Stream::control, and ACE_Task< ACE_SYNCH_USE >::water_marks.

Member Enumeration Documentation

anonymous enum
 

Enumeration values:
SET_LWM  Set the low water mark.
GET_LWM  Get the low water mark.
SET_HWM  Set the high water mark.
GET_HWM  Get the high water mark.
MOD_LINK  Link modules.
MOD_UNLINK  Unlink modules.

Definition at line 35 of file IO_Cntl_Msg.h. 

00036   {
00037     /// Set the low water mark.
00038     SET_LWM    = 1,
00039     /// Get the low water mark.
00040     GET_LWM    = 2,
00041     /// Set the high water mark.
00042     SET_HWM    = 3,
00043     /// Get the high water mark.
00044     GET_HWM    = 4,
00045     /// Link modules
00046     MOD_LINK   = 5,
00047     /// Unlink modules
00048     MOD_UNLINK = 6 
00049   };

Constructor & Destructor Documentation

ACE_IO_Cntl_Msg::ACE_IO_Cntl_Msg (  ACE_IO_Cntl_Cmds    c )  [inline]
 

Initialize the control message.

Definition at line 55 of file IO_Cntl_Msg.h. 

00055 { this->cmd_ = c; }

Member Function Documentation

void ACE_IO_Cntl_Msg::cmd (  ACE_IO_Cntl_Cmds    c )  [inline]
 

Set command.

Definition at line 63 of file IO_Cntl_Msg.h. 

00063 { this->cmd_ = c; }

ACE_IO_Cntl_Cmds ACE_IO_Cntl_Msg::cmd (  void    )  [inline]
 

Get command.

Definition at line 60 of file IO_Cntl_Msg.h.

Referenced by ACE_Stream_Tail::control, and ACE_Stream_Head::control. 

00060 { return this->cmd_; }

void ACE_IO_Cntl_Msg::count (  size_t    c )  [inline]
 

Set count.

Definition at line 69 of file IO_Cntl_Msg.h. 

00069 { this->count_ = c; }

size_t ACE_IO_Cntl_Msg::count (  void    )  [inline]
 

Get count.

Definition at line 66 of file IO_Cntl_Msg.h. 

00066 { return this->count_; }

void ACE_IO_Cntl_Msg::dump (  void    )  const
 

Dump the state of an object.

void ACE_IO_Cntl_Msg::error (  int    e )  [inline]
 

Set error.

Definition at line 75 of file IO_Cntl_Msg.h. 

00075 { this->error_ = e; }

int ACE_IO_Cntl_Msg::error (  void    )  [inline]
 

Get error.

Definition at line 72 of file IO_Cntl_Msg.h. 

00072 { return this->error_; }

void ACE_IO_Cntl_Msg::rval (  int    r )  [inline]
 

Set return value.

Definition at line 81 of file IO_Cntl_Msg.h. 

00081 { this->rval_ = r; }

int ACE_IO_Cntl_Msg::rval (  void    )  [inline]
 

Get return value.

Definition at line 78 of file IO_Cntl_Msg.h.

Referenced by ACE_Stream_Tail::control, and ACE_Stream_Head::control. 

00078 { return this->rval_; }

Member Data Documentation

ACE_IO_Cntl_Msg::ACE_ALLOC_HOOK_DECLARE
 

Declare the dynamic allocation hooks.

Definition at line 87 of file IO_Cntl_Msg.h.

ACE_IO_Cntl_Cmds ACE_IO_Cntl_Msg::cmd_ [private]
 

Command.

Definition at line 91 of file IO_Cntl_Msg.h.

size_t ACE_IO_Cntl_Msg::count_ [private]
 

Count.

Definition at line 94 of file IO_Cntl_Msg.h.

int ACE_IO_Cntl_Msg::error_ [private]
 

Error.

Definition at line 97 of file IO_Cntl_Msg.h.

int ACE_IO_Cntl_Msg::rval_ [private]
 

Return value.

Definition at line 100 of file IO_Cntl_Msg.h.

The documentation for this class was generated from the following file:
Generated on Mon Jun 16 12:49:07 2003 for ACE by doxygen1.2.14 written by Dimitri van Heesch, © 1997-2002