Data format for IOCTL messages. More...

#include <IO_Cntl_Msg.h>

Public Types
enum	{ SET_LWM = 1, GET_LWM = 2, SET_HWM = 3, GET_HWM = 4, MOD_LINK = 5, MOD_UNLINK = 6 }
typedef unsigned short	ACE_IO_Cntl_Cmds
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.

Member Enumeration Documentation

anonymous enum

Enumerator:

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.

  {
    /// Set the low water mark.
    SET_LWM    = 1,
    /// Get the low water mark.
    GET_LWM    = 2,
    /// Set the high water mark.
    SET_HWM    = 3,
    /// Get the high water mark.
    GET_HWM    = 4,
    /// Link modules
    MOD_LINK   = 5,
    /// Unlink modules
    MOD_UNLINK = 6
  };

Constructor & Destructor Documentation

ACE_IO_Cntl_Msg::ACE_IO_Cntl_Msg ( ACE_IO_Cntl_Cmds c ) [inline]

Initialize the control message.

Definition at line 8 of file IO_Cntl_Msg.inl.

{
  this->cmd_ = c;
}

Member Function Documentation

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

Get command.

Definition at line 14 of file IO_Cntl_Msg.inl.

{
  return this->cmd_;
}

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

Set command.

Definition at line 20 of file IO_Cntl_Msg.inl.

{
  this->cmd_ = c;
}

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

Set count.

Definition at line 32 of file IO_Cntl_Msg.inl.

{
  this->count_ = c;
}

size_t ACE_IO_Cntl_Msg::count ( void ) [inline]

Get count.

Definition at line 26 of file IO_Cntl_Msg.inl.

{
  return this->count_;
}

void ACE_IO_Cntl_Msg::dump ( void ) const

Dump the state of an object.

int ACE_IO_Cntl_Msg::error ( void ) [inline]

Get error.

Definition at line 38 of file IO_Cntl_Msg.inl.

{
  return this->error_;
}

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

Set error.

Definition at line 44 of file IO_Cntl_Msg.inl.

{
  this->error_ = e;
}

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

Set return value.

Definition at line 56 of file IO_Cntl_Msg.inl.

{
  this->rval_ = r;
}

int ACE_IO_Cntl_Msg::rval ( void ) [inline]

Get return value.

Definition at line 50 of file IO_Cntl_Msg.inl.

{
  return this->rval_;
}

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.

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.

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

ACE_IO_Cntl_Msg Class Reference

Public Types

Public Member Functions