PLCore::Pipe Class Reference

Class to create and access system pipes (named or unnamed) More...

#include <Pipe.h>

List of all members.

Public Member Functions
	Pipe ()
	Constructor.
	Pipe (const Pipe &cSource)
	Copy constructor.
	~Pipe ()
	Destructor.
Pipe &	operator= (const Pipe &cSource)
	Assignment operator.
bool	operator== (const Pipe &cSource) const
	Comparison operator.
bool	operator!= (const Pipe &cSource) const
	Comparison operator.
PLCORE_API bool	Create ()
	Creates a new unnamend pipe.
PLCORE_API bool	Create (const String &sName)
	Creates a new namend pipe.
bool	Open (handle hRead, handle hWrite)
	Open a pipe by file handles.
PLCORE_API bool	CloseRead ()
	Close read side of the pipe.
PLCORE_API bool	CloseWrite ()
	Close write side of the pipe.
bool	Close ()
	Close both sides of the pipe.
String	GetName () const
	Get name of pipe.
handle	GetReadHandle () const
	Get read handle for the pipe.
handle	GetWriteHandle () const
	Get write handle for the pipe.

---

Detailed Description

Class to create and access system pipes (named or unnamed)

---

Constructor & Destructor Documentation

PLCore::Pipe::Pipe

(

)

[inline]

Constructor.

PLCore::Pipe::Pipe

(

const Pipe &

cSource

)

[inline]

Copy constructor.

Parameters:

[in]

cSource

Source to copy

PLCore::Pipe::~Pipe

(

)

[inline]

Destructor.

---

Member Function Documentation

Pipe & PLCore::Pipe::operator=

(

const Pipe &

cSource

)

[inline]

Assignment operator.

Parameters:

[in]

cSource

Source to copy

Returns:

Reference to this Pipe

bool PLCore::Pipe::operator==

(

const Pipe &

cSource

)

const [inline]

Comparison operator.

Parameters:

[in]

cSource

Pipe to compare with

Returns:

'true', if both Pipe's are equal, else 'false'

bool PLCore::Pipe::operator!=

(

const Pipe &

cSource

)

const [inline]

Comparison operator.

Parameters:

[in]

cSource

Pipe to compare with

Returns:

'true', if the Pipe's are different, else 'false'

PLCORE_API bool PLCore::Pipe::Create

(

)

Creates a new unnamend pipe.

Returns:

'true', if the pipe could be created, else 'false'

PLCORE_API bool PLCore::Pipe::Create

(

const String &

sName

)

Creates a new namend pipe.

Parameters:

[in]

sName

Name of the pipe

Returns:

'true', if the pipe could be created, else 'false'

bool PLCore::Pipe::Open	(	handle	hRead,
		handle	hWrite
	)		[inline]

Open a pipe by file handles.

Parameters:

[in]	hRead	Handle to the read end of the pipe
[in]	hWrite	Handle to the write end of the pipe

Returns:

'true', if the pipe could be opened, else 'false'

PLCORE_API bool PLCore::Pipe::CloseRead

(

)

Close read side of the pipe.

Returns:

'true', if the read side could be closed, else 'false'

PLCORE_API bool PLCore::Pipe::CloseWrite

(

)

Close write side of the pipe.

Returns:

'true', if the write side could be closed, else 'false'

bool PLCore::Pipe::Close

(

)

[inline]

Close both sides of the pipe.

Returns:

'true', if the pipe could be closed, else 'false'

String PLCore::Pipe::GetName

(

)

const [inline]

Get name of pipe.

Returns:

Name of the pipe

handle PLCore::Pipe::GetReadHandle

(

)

const [inline]

Get read handle for the pipe.

Returns:

Handle for the read-end of the pipe

Note:

• On Linux, the handle is a file handle of type int
• On Windows, the handle is a file handle of type HANDLE

handle PLCore::Pipe::GetWriteHandle

(

)

const [inline]

Get write handle for the pipe.

Returns:

Handle for the write-end of the pipe

See also:

• GetReadHandle()

---

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

• Pipe.h
• Pipe.inl