CComPortControlClientSubNegotiator Class Reference

Inheritance diagram for CComPortControlClientSubNegotiator:

[legend]

Collaboration diagram for CComPortControlClientSubNegotiator:

[legend]

List of all members.

Public Types
enum	DataSize {   UnknownDataSize = 0, Five = 5, Six = 6, Seven = 7,   Eight = 8 }
enum	Parity {   UnknownParity = 0, None = 1, Odd, Even,   Mark, Space }
enum	StopSize { UnknownStopSize = 0, One = 1, Two, OnePointFive }
enum	FlowControl {   Unknown_FlowControl = 0, No_FlowControl = 1, XON_XOFF_FlowControl, HARDWARE_FlowControl,   DCD_FlowControl = 17, DTR_FlowControl, DSR_FlowControl }
typedef unsigned int	BaudRate
Public Member Functions
	CComPortControlClientSubNegotiator (ISubNegotiationController &controller)
	~CComPortControlClientSubNegotiator ()
const BYTE *	GetSignature (DataLength &numBytes) const
void	SetBaud (const BaudRate baud)
BaudRate	GetBaud () const
void	SetDataSize (const DataSize size)
DataSize	GetDataSize () const
void	SetParity (const Parity parity)
Parity	GetParity () const
void	SetStopSize (const StopSize stopSize)
StopSize	GetStopSize () const
void	SetOutBoundFlowControl (const FlowControl flow)
FlowControl	GetOutBoundFlowControl () const
void	SetInBoundFlowControl (const FlowControl flow)
FlowControl	GetInBoundFlowControl () const
void	SetBreakState (const bool state)
bool	GetBreakState () const
void	SetDtrState (const bool state)
bool	GetDtrState () const
void	SetRtsState (const bool state)
bool	GetRtsState () const
void	SetLineStateMask (const BYTE mask)
BYTE	GetLineStateMask () const
BYTE	GetLineState () const
void	SetModemStateMask (const BYTE mask)
BYTE	GetModemStateMask () const
BYTE	GetModemState () const
void	QueryRemoteStatus ()
virtual BYTE	GetOption () const
Protected Member Functions
void	SendSubNegotiation (const Location location, const BYTE *pData, const DataLength dataLength) const
void	SendSubNegotiation (const Location location, const BYTE data) const
void	DisableOption ()
virtual void	InitiateSubNegotiation (const Location location)
virtual void	OnSubNegotiate (const BYTE *pData, const DataLength dataLength)
virtual void	OnNegotiationComplete (const BYTE, const BYTE)

---

Member Typedef Documentation

typedef unsigned int BaudRate

---

Member Enumeration Documentation

enum DataSize

Enumerator:

UnknownDataSize
Five
Six
Seven
Eight

enum Parity

Enumerator:

UnknownParity
None
Odd
Even
Mark
Space

enum StopSize

Enumerator:

UnknownStopSize
One
Two
OnePointFive

enum FlowControl

Enumerator:

Unknown_FlowControl
No_FlowControl
XON_XOFF_FlowControl
HARDWARE_FlowControl
DCD_FlowControl
DTR_FlowControl
DSR_FlowControl

---

Constructor & Destructor Documentation

CComPortControlClientSubNegotiator

(

ISubNegotiationController &

controller

)

[explicit]

~CComPortControlClientSubNegotiator

(

)

---

Member Function Documentation

const BYTE * GetSignature

(

DataLength &

numBytes

)

const

void SetBaud

(

const BaudRate

baud

)

CComPortControlClientSubNegotiator::BaudRate GetBaud

(

)

const

void SetDataSize

(

const DataSize

size

)

CComPortControlClientSubNegotiator::DataSize GetDataSize

(

)

const

void SetParity

(

const Parity

parity

)

CComPortControlClientSubNegotiator::Parity GetParity

(

)

const

void SetStopSize

(

const StopSize

stopSize

)

CComPortControlClientSubNegotiator::StopSize GetStopSize

(

)

const

void SetOutBoundFlowControl

(

const FlowControl

flow

)

CComPortControlClientSubNegotiator::FlowControl GetOutBoundFlowControl

(

)

const

void SetInBoundFlowControl

(

const FlowControl

flow

)

CComPortControlClientSubNegotiator::FlowControl GetInBoundFlowControl

(

)

const

void SetBreakState

(

const bool

state

)

bool GetBreakState

(

)

const

void SetDtrState

(

const bool

state

)

bool GetDtrState

(

)

const

void SetRtsState

(

const bool

state

)

bool GetRtsState

(

)

const

void SetLineStateMask

(

const BYTE

mask

)

BYTE GetLineStateMask

(

)

const

BYTE GetLineState

(

)

const

void SetModemStateMask

(

const BYTE

mask

)

BYTE GetModemStateMask

(

)

const

BYTE GetModemState

(

)

const

void QueryRemoteStatus

(

)

BYTE GetOption

(

)

const [virtual, inherited]

Implements IOptionSubNegotiator.

void SendSubNegotiation	(	const Location	location,
		const BYTE *	pData,
		const DataLength	dataLength
	)			const [protected, inherited]

void SendSubNegotiation	(	const Location	location,
		const BYTE	data
	)			const [protected, inherited]

void DisableOption

(

)

[protected, inherited]

void InitiateSubNegotiation

(

const Location

location

)

[protected, virtual, inherited]

Implements IOptionSubNegotiator.

Reimplemented in CComPortControlSubNegotiator, and CTerminalTypeSubNegotiator.

void OnSubNegotiate	(	const BYTE *	pData,
		const DataLength	dataLength
	)			[protected, virtual, inherited]

Implements IOptionSubNegotiator.

virtual void OnNegotiationComplete	(	const	BYTE,
		const	BYTE
	)			[inline, protected, virtual, inherited]

---