Dashel::WaitableStream Class Reference

Stream with a handle that can be waited on. More...

Inheritance diagram for Dashel::WaitableStream:

[legend]

List of all members.

Public Member Functions
virtual void	notifyEvent (Hub *srv, EvType &t)
	Callback when an event is notified, allowing the stream to rearm it.
	WaitableStream (const std::string &protocolName)
	Constructor.
virtual	~WaitableStream ()
	Destructor.
Public Attributes
std::map< EvType, HANDLE >	hEvents
	The events on which we may want to wait.
bool	readDone
	Flag indicating whether a read was performed.
Protected Member Functions
void	addEvent (EvType t, HANDLE he)
	Add an existing event for this stream.
HANDLE	createEvent (EvType t)
	Create a new event for this stream.
Protected Attributes
HANDLE	hEOF
	Event for notifying end of stream (i.e. disconnect).

---

Detailed Description

Stream with a handle that can be waited on.

Definition at line 204 of file dashel-win32.cpp.

---

Constructor & Destructor Documentation

Dashel::WaitableStream::WaitableStream

(

const std::string &

protocolName

)

[inline]

Constructor.

Definition at line 240 of file dashel-win32.cpp.

virtual Dashel::WaitableStream::~WaitableStream

(

)

[inline, virtual]

Destructor.

Releases all allocated handles.

Definition at line 248 of file dashel-win32.cpp.

---

Member Function Documentation

void Dashel::WaitableStream::addEvent	(	EvType	t,
		HANDLE	he
	)			[inline, protected]

Add an existing event for this stream.

Parameters:

	t	Type of event to attach to.
	he	Event handle.

Definition at line 233 of file dashel-win32.cpp.

HANDLE Dashel::WaitableStream::createEvent

(

EvType

t

)

[inline, protected]

Create a new event for this stream.

Parameters:

t

Type of event to create.

Definition at line 222 of file dashel-win32.cpp.

virtual void Dashel::WaitableStream::notifyEvent	(	Hub *	srv,
		EvType &	t
	)			[inline, virtual]

Callback when an event is notified, allowing the stream to rearm it.

Parameters:

	srv	Hub instance that has generated the notification.
	t	Type of event.

Reimplemented in Dashel::SocketServerStream, Dashel::StdinStream, Dashel::FileStream, and Dashel::SocketStream.

Definition at line 258 of file dashel-win32.cpp.

---

Member Data Documentation

HANDLE Dashel::WaitableStream::hEOF [protected]

Event for notifying end of stream (i.e. disconnect).

Definition at line 217 of file dashel-win32.cpp.

std::map<EvType,HANDLE> Dashel::WaitableStream::hEvents

The events on which we may want to wait.

Each element in the map is a type, handle pair.

Definition at line 210 of file dashel-win32.cpp.

bool Dashel::WaitableStream::readDone

Flag indicating whether a read was performed.

Definition at line 213 of file dashel-win32.cpp.

---

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

• dashel-win32.cpp