Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | File List | Namespace Members | Class Members | File Members | Related Pages | Search for 

ACE_IO_Cntl_Msg Class Reference

Data format for IOCTL messages. More...

#include <IO_Cntl_Msg.h>

List of all members.

Public Types

typedef unsigned 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 Member Functions

 ACE_IO_Cntl_Msg (ACE_IO_Cntl_Cmds c)
 Initialize the control message.

ACE_IO_Cntl_Cmds cmd (void)
 Get command.

void cmd (ACE_IO_Cntl_Cmds c)
 Set command.

size_t count (void)
 Get count.

void count (size_t c)
 Set count.

int error (void)
 Get error.

void error (int e)
 Set error.

int rval (void)
 Get return value.

void rval (int r)
 Set return value.

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


Public Attributes

 ACE_ALLOC_HOOK_DECLARE
 Declare the dynamic allocation hooks.


Private Attributes

ACE_IO_Cntl_Cmds cmd_
 Command.

size_t count_
 Count.

int error_
 Error.

int rval_
 Return value.

Detailed Description

Data format for IOCTL messages.

Definition at line 33 of file IO_Cntl_Msg.h.

Member Typedef Documentation

typedef unsigned short ACE_IO_Cntl_Msg::ACE_IO_Cntl_Cmds
 

Definition at line 52 of file IO_Cntl_Msg.h.

Referenced by ACE_IO_Cntl_Msg(), cmd(), ACE_UPIPE_Stream::control(), ACE_Stream_Tail<>::control(), ACE_Stream_Head<>::control(), ACE_Stream<>::control(), ACE_Task< ACE_SYNCH_USE >::water_marks(), and ACE_Task_Ex<, ACE_MESSAGE_TYPE >::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 36 of file IO_Cntl_Msg.h. 

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

Constructor & Destructor Documentation

ACE_BEGIN_VERSIONED_NAMESPACE_DECL ACE_INLINE ACE_IO_Cntl_Msg::ACE_IO_Cntl_Msg (  ACE_IO_Cntl_Cmds  c  ) 
 

Initialize the control message.

Definition at line 8 of file IO_Cntl_Msg.inl.

References ACE_IO_Cntl_Cmds, and cmd_. 

00009 {
00010   this->cmd_ = c;
00011 }

Member Function Documentation

ACE_INLINE void ACE_IO_Cntl_Msg::cmd (  ACE_IO_Cntl_Cmds  c  ) 
 

Set command.

Definition at line 20 of file IO_Cntl_Msg.inl.

References ACE_IO_Cntl_Cmds, and cmd_. 

00021 {
00022   this->cmd_ = c;
00023 }

ACE_INLINE ACE_IO_Cntl_Msg::ACE_IO_Cntl_Cmds ACE_IO_Cntl_Msg::cmd (  void   ) 
 

Get command.

Definition at line 14 of file IO_Cntl_Msg.inl.

References cmd_.

Referenced by ACE_Stream_Tail<>::control(), and ACE_Stream_Head<>::control(). 

00015 {
00016   return this->cmd_;
00017 }

ACE_INLINE void ACE_IO_Cntl_Msg::count (  size_t  c  ) 
 

Set count.

Definition at line 32 of file IO_Cntl_Msg.inl. 

00033 {
00034   this->count_ = c;
00035 }

ACE_INLINE size_t ACE_IO_Cntl_Msg::count (  void   ) 
 

Get count.

Definition at line 26 of file IO_Cntl_Msg.inl. 

00027 {
00028   return this->count_;
00029 }

void ACE_IO_Cntl_Msg::dump (  void   )  const
 

Dump the state of an object.

ACE_INLINE void ACE_IO_Cntl_Msg::error (  int  e  ) 
 

Set error.

Definition at line 44 of file IO_Cntl_Msg.inl. 

00045 {
00046   this->error_ = e;
00047 }

ACE_INLINE int ACE_IO_Cntl_Msg::error (  void   ) 
 

Get error.

Definition at line 38 of file IO_Cntl_Msg.inl. 

00039 {
00040   return this->error_;
00041 }

ACE_INLINE void ACE_IO_Cntl_Msg::rval (  int  r  ) 
 

Set return value.

Definition at line 56 of file IO_Cntl_Msg.inl.

References rval_. 

00057 {
00058   this->rval_ = r;
00059 }

ACE_INLINE int ACE_IO_Cntl_Msg::rval (  void   ) 
 

Get return value.

Definition at line 50 of file IO_Cntl_Msg.inl.

References rval_.

Referenced by ACE_Stream_Tail<>::control(), and ACE_Stream_Head<>::control(). 

00051 {
00052   return this->rval_;
00053 }

Member Data Documentation

ACE_IO_Cntl_Msg::ACE_ALLOC_HOOK_DECLARE
 

Declare the dynamic allocation hooks.

Definition at line 88 of file IO_Cntl_Msg.h.

ACE_IO_Cntl_Cmds ACE_IO_Cntl_Msg::cmd_ [private]
 

Command.

Definition at line 92 of file IO_Cntl_Msg.h.

Referenced by ACE_IO_Cntl_Msg(), and cmd().

size_t ACE_IO_Cntl_Msg::count_ [private]
 

Count.

Definition at line 95 of file IO_Cntl_Msg.h.

int ACE_IO_Cntl_Msg::error_ [private]
 

Error.

Definition at line 98 of file IO_Cntl_Msg.h.

int ACE_IO_Cntl_Msg::rval_ [private]
 

Return value.

Definition at line 101 of file IO_Cntl_Msg.h.

Referenced by rval().

The documentation for this class was generated from the following files:
Generated on Thu Nov 9 11:23:36 2006 for ACE by doxygen 1.3.6