osl::Pipe Class Reference

Represents a pipe. More...

#include <pipe_decl.hxx>

Inheritance diagram for osl::Pipe:

List of all members.

Public Member Functions
	Pipe ()
	Does not create a pipe.
	Pipe (const ::rtl::OUString &strName, oslPipeOptions Options)
	Creates an insecure pipe that is accessible for all users.
	Pipe (const ::rtl::OUString &strName, oslPipeOptions Options, const Security &rSecurity)
	Creates a secure pipe that access depends on the umask settings.
	Pipe (const Pipe &pipe)
	Copy constructor.
	Pipe (oslPipe pipe, __sal_NoAcquire noacquire)
	Constructs a Pipe reference without acquiring the handle.
	Pipe (oslPipe Pipe)
	Creates pipe as wrapper around the underlying oslPipe.
	~Pipe ()
	Destructor.
sal_Bool	is () const
sal_Bool	create (const ::rtl::OUString &strName, oslPipeOptions Options, const Security &rSec)
	Creates an insecure pipe that is accessible for all users with the given attributes.
sal_Bool	create (const ::rtl::OUString &strName, oslPipeOptions Options=osl_Pipe_OPEN)
	Creates a secure that access rights depend on the umask settings with the given attributes.
void	clear ()
	releases the underlying handle
Pipe &	operator= (const Pipe &pipe)
	Assignment operator.
Pipe &	operator= (const oslPipe pipe)
	Assignment operator.
sal_Bool	isValid () const
	Checks if the pipe is valid.
sal_Bool	operator== (const Pipe &rPipe) const
void	close ()
	Closes the pipe.
oslPipeError	accept (StreamPipe &Connection)
	Accept connection on an existing pipe.
oslPipeError	getError () const
	Delivers a constant decribing the last error for the pipe system.
oslPipe	getHandle () const
Protected Attributes
oslPipe	m_handle

---

Detailed Description

Represents a pipe.

---

Constructor & Destructor Documentation

osl::Pipe::Pipe

(

)

[inline]

Does not create a pipe.

Use assignment operator to make this a useable pipe.

osl::Pipe::Pipe	(	const ::rtl::OUString &	strName,
		oslPipeOptions	Options
	)			[inline]

Creates an insecure pipe that is accessible for all users.

Parameters:

	strName
	Options

osl::Pipe::Pipe	(	const ::rtl::OUString &	strName,
		oslPipeOptions	Options,
		const Security &	rSecurity
	)			[inline]

Creates a secure pipe that access depends on the umask settings.

Parameters:

	strName
	Options
	rSecurity

osl::Pipe::Pipe

(

const Pipe &

pipe

)

[inline]

Copy constructor.

osl::Pipe::Pipe	(	oslPipe	pipe,
		__sal_NoAcquire	noacquire
	)			[inline]

Constructs a Pipe reference without acquiring the handle.

osl::Pipe::Pipe

(

oslPipe

Pipe

)

[inline]

Creates pipe as wrapper around the underlying oslPipe.

Parameters:

Pipe

osl::Pipe::~Pipe

(

)

[inline]

Destructor.

Destroys the underlying oslPipe.

---

Member Function Documentation

oslPipeError osl::Pipe::accept

(

StreamPipe &

Connection

)

[inline]

Accept connection on an existing pipe.

void osl::Pipe::clear

(

)

[inline]

releases the underlying handle

void osl::Pipe::close

(

)

[inline]

Closes the pipe.

sal_Bool osl::Pipe::create	(	const ::rtl::OUString &	strName,
		oslPipeOptions	Options = osl_Pipe_OPEN
	)			[inline]

Creates a secure that access rights depend on the umask settings with the given attributes.

If socket was already created, the old one will be discarded.

Parameters:

	strName
	Options

Returns:

True if socket was successfully created.

sal_Bool osl::Pipe::create	(	const ::rtl::OUString &	strName,
		oslPipeOptions	Options,
		const Security &	rSec
	)			[inline]

Creates an insecure pipe that is accessible for all users with the given attributes.

If the pipe was already created, the old one will be discarded.

Parameters:

	strName
	Options
	rSec

Returns:

True if socket was successfully created.

oslPipeError osl::Pipe::getError

(

)

const [inline]

Delivers a constant decribing the last error for the pipe system.

Returns:

ENONE if no error occurred, invalid_PipeError if an unknown (unmapped) error occurred, otherwise an enum describing the error.

oslPipe osl::Pipe::getHandle

(

)

const [inline]

sal_Bool osl::Pipe::is

(

)

const [inline]

sal_Bool osl::Pipe::isValid

(

)

const [inline]

Checks if the pipe is valid.

Returns:

True if the object represents a valid pipe.

Pipe & osl::Pipe::operator=

(

const oslPipe

pipe

)

[inline]

Assignment operator.

If pipe was already created, the old one will be discarded.

Reimplemented in osl::StreamPipe.

Pipe & osl::Pipe::operator=

(

const Pipe &

pipe

)

[inline]

Assignment operator.

If pipe was already created, the old one will be discarded.

sal_Bool osl::Pipe::operator==

(

const Pipe &

rPipe

)

const [inline]

---

Member Data Documentation

oslPipe osl::Pipe::m_handle [protected]

---

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

• osl/pipe_decl.hxx
• osl/pipe.hxx