ACE_TTY_IO::Serial_Params Struct Reference

#include <TTY_IO.h>

List of all members.

Public Member Functions
	Serial_Params (void)
Public Attributes
int	baudrate
int	xonlim
int	xofflim
unsigned int	readmincharacters
int	readtimeoutmsec
bool	parityenb
const char *	paritymode
bool	ctsenb
unsigned char	rtsenb
bool	xinenb
bool	xoutenb
bool	modem
bool	rcvenb
bool	dsrenb
bool	dtrdisable
unsigned char	databits
unsigned char	stopbits

---

Detailed Description

Definition at line 45 of file TTY_IO.h.

---

Constructor & Destructor Documentation

ACE_BEGIN_VERSIONED_NAMESPACE_DECL ACE_TTY_IO::Serial_Params::Serial_Params

(

void

)

Definition at line 33 of file TTY_IO.cpp.

References ACE_TTY_IO_NONE, baudrate, ctsenb, databits, dsrenb, dtrdisable, modem, parityenb, paritymode, rcvenb, readmincharacters, readtimeoutmsec, rtsenb, stopbits, xinenb, xofflim, xonlim, and xoutenb.

{
  baudrate = 9600;
  xonlim = 0;
  xofflim = 0;
  readmincharacters = 0;
  readtimeoutmsec = 10000;
  parityenb = true;
  paritymode = ACE_TTY_IO_NONE;
  ctsenb = false;
  rtsenb = 0;
  xinenb = false;
  xoutenb = false;
  modem = false;
  rcvenb = true;
  dsrenb = false;
  dtrdisable = false;
  databits = 8;
  stopbits = 1;
}

---

Member Data Documentation

int ACE_TTY_IO::Serial_Params::baudrate

Specifies the baudrate at which the communnication port operates.

Definition at line 50 of file TTY_IO.h.

Referenced by ACE_TTY_IO::control(), and Serial_Params().

bool ACE_TTY_IO::Serial_Params::ctsenb

Enable & set CTS mode. Note that RTS & CTS are enabled/disabled together on some systems (RTS/CTS is enabled if either ctsenb or rtsenb is set).

Definition at line 81 of file TTY_IO.h.

Referenced by ACE_TTY_IO::control(), and Serial_Params().

unsigned char ACE_TTY_IO::Serial_Params::databits

Data bits. Valid values 5, 6, 7 and 8 data bits. Additionally Win32 supports 4 data bits.

Definition at line 106 of file TTY_IO.h.

Referenced by ACE_TTY_IO::control(), and Serial_Params().

bool ACE_TTY_IO::Serial_Params::dsrenb

Controls whether DSR is disabled or enabled (Win32).

Definition at line 101 of file TTY_IO.h.

Referenced by ACE_TTY_IO::control(), and Serial_Params().

bool ACE_TTY_IO::Serial_Params::dtrdisable

Controls whether DTR is disabled or enabled.

Definition at line 103 of file TTY_IO.h.

Referenced by ACE_TTY_IO::control(), and Serial_Params().

bool ACE_TTY_IO::Serial_Params::modem

Specifies if device is a modem (POSIX). If not set modem status lines are ignored.

Definition at line 97 of file TTY_IO.h.

Referenced by ACE_TTY_IO::control(), and Serial_Params().

bool ACE_TTY_IO::Serial_Params::parityenb

Deprecated:

Note that this member is going away in a subsequent release. Use paritymode = "none" to disable parity checking.

Enable/disable parity checking.

Definition at line 73 of file TTY_IO.h.

Referenced by ACE_TTY_IO::control(), and Serial_Params().

const char* ACE_TTY_IO::Serial_Params::paritymode

Specifies the parity mode. POSIX supports "none", "even" and "odd" parity. Additionally Win32 supports "mark" and "space" parity modes.

Definition at line 77 of file TTY_IO.h.

Referenced by ACE_TTY_IO::control(), and Serial_Params().

bool ACE_TTY_IO::Serial_Params::rcvenb

Enable/disable receiver (POSIX).

Definition at line 99 of file TTY_IO.h.

Referenced by ACE_TTY_IO::control(), and Serial_Params().

unsigned int ACE_TTY_IO::Serial_Params::readmincharacters

Specifies the minimum number of characters for non-canonical read (POSIX).

Definition at line 61 of file TTY_IO.h.

Referenced by ACE_TTY_IO::control(), and Serial_Params().

int ACE_TTY_IO::Serial_Params::readtimeoutmsec

Specifies the time to wait before returning from read. Negative value means infinite timeout.

Definition at line 64 of file TTY_IO.h.

Referenced by ACE_TTY_IO::control(), and Serial_Params().

unsigned char ACE_TTY_IO::Serial_Params::rtsenb

Enable & set RTS mode. Note that RTS & CTS are enabled/disabled together on some systems (RTS/CTS is enabled if either ctsenb or rtsenb is set).

• 0 = Disable RTS.
• 1 = Enable RTS.
• 2 = Enable RTS flow-control handshaking (Win32).
• 3 = Specifies that RTS line will be high if bytes are available for transmission. After transmission RTS will be low (Win32).

Definition at line 90 of file TTY_IO.h.

Referenced by ACE_TTY_IO::control(), and Serial_Params().

unsigned char ACE_TTY_IO::Serial_Params::stopbits

Stop bits. Valid values are 1 and 2.

Definition at line 108 of file TTY_IO.h.

Referenced by ACE_TTY_IO::control(), and Serial_Params().

bool ACE_TTY_IO::Serial_Params::xinenb

Enable/disable software flow control on input.

Definition at line 92 of file TTY_IO.h.

Referenced by ACE_TTY_IO::control(), and Serial_Params().

int ACE_TTY_IO::Serial_Params::xofflim

Specifies the maximum number of bytes in input buffer before XOFF char is sent. Negative value indicates that default value should be used (Win32).

Definition at line 58 of file TTY_IO.h.

Referenced by ACE_TTY_IO::control(), and Serial_Params().

int ACE_TTY_IO::Serial_Params::xonlim

Specifies the minimum number of bytes in input buffer before XON char is sent. Negative value indicates that default value should be used (Win32).

Definition at line 54 of file TTY_IO.h.

Referenced by ACE_TTY_IO::control(), and Serial_Params().

bool ACE_TTY_IO::Serial_Params::xoutenb

Enable/disable software flow control on output.

Definition at line 94 of file TTY_IO.h.

Referenced by ACE_TTY_IO::control(), and Serial_Params().

---

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

• TTY_IO.h
• TTY_IO.cpp

---