Methods of Class Pipe

Pipe

Pipe();

virtual	abstract	const	volatile	template	static	inline	C-linkage
NO	NO	NO	NO	NO	NO	YES	NO

Summary

Does not create a pipe. Use assignment operator to
make this a useable pipe.

Pipe

Pipe(

const ::rtl::OUString &	strName,
oslPipeOptions	Options );

virtual	abstract	const	volatile	template	static	inline	C-linkage
NO	NO	NO	NO	NO	NO	YES	NO

Summary

Creates a pipe.

Parameters

strName
Options
Security

Pipe

Pipe(

const ::rtl::OUString &	strName,
oslPipeOptions	Options,
const Security &	rSecurity );

virtual	abstract	const	volatile	template	static	inline	C-linkage
NO	NO	NO	NO	NO	NO	YES	NO

Summary

Creates a pipe.

Parameters

strName
Options
Security

Pipe

Pipe(

const Pipe &

pipe );

virtual	abstract	const	volatile	template	static	inline	C-linkage
NO	NO	NO	NO	NO	NO	YES	NO

Summary

Copy constructor.

Pipe

Pipe(

oslPipe	pipe,
__sal_NoAcquire	noacquire );

virtual	abstract	const	volatile	template	static	inline	C-linkage
NO	NO	NO	NO	NO	NO	YES	NO

Summary

Constructs a Pipe reference without acquiring the handle

Pipe

Pipe(

oslPipe

Pipe );

virtual	abstract	const	volatile	template	static	inline	C-linkage
NO	NO	NO	NO	NO	NO	YES	NO

Summary

Creates pipe as wrapper around the underlying oslPipe.

Parameters

Pipe

~Pipe

~Pipe();

virtual	abstract	const	volatile	template	static	inline	C-linkage
NO	NO	NO	NO	NO	NO	YES	NO

Summary

Destructor. Destroys the underlying oslPipe.

is

sal_Bool is();

virtual	abstract	const	volatile	template	static	inline	C-linkage
NO	NO	NO	NO	NO	NO	YES	NO

create

sal_Bool create(

const ::rtl::OUString &	strName,
oslPipeOptions	Options,
const Security &	rSec );

virtual	abstract	const	volatile	template	static	inline	C-linkage
NO	NO	NO	NO	NO	NO	YES	NO

Summary

Create a pipe with the given attributes.
If the pipe was already created, the old one will be discarded.

Parameters

strName
Options
Security

Return

True if socket was successfully created.

create

sal_Bool create(

const ::rtl::OUString &	strName,
oslPipeOptions	Options = osl_Pipe_OPEN );

virtual	abstract	const	volatile	template	static	inline	C-linkage
NO	NO	NO	NO	NO	NO	YES	NO

Summary

Create a pipe with the given attributes.
If socket was already created, the old one will be discarded.

Parameters

strName
Options

Return

True if socket was successfully created.

clear

void clear();

virtual	abstract	const	volatile	template	static	inline	C-linkage
NO	NO	NO	NO	NO	NO	YES	NO

Summary

releases the underlying handle

operator=

Pipe & operator=(

const Pipe &

pipe );

virtual	abstract	const	volatile	template	static	inline	C-linkage
NO	NO	NO	NO	NO	NO	YES	NO

Summary

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

operator=

Pipe & operator=(

const oslPipe

pipe );

virtual	abstract	const	volatile	template	static	inline	C-linkage
NO	NO	NO	NO	NO	NO	YES	NO

Summary

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

isValid

sal_Bool isValid();

virtual	abstract	const	volatile	template	static	inline	C-linkage
NO	NO	NO	NO	NO	NO	YES	NO

Summary

Checks if the pipe is valid.

Return

True if the object represents a valid pipe.

operator==

sal_Bool operator==(

const Pipe &

rPipe ) const;

virtual	abstract	const	volatile	template	static	inline	C-linkage
NO	NO	YES	NO	NO	NO	YES	NO

close

void close();

virtual	abstract	const	volatile	template	static	inline	C-linkage
NO	NO	NO	NO	NO	NO	YES	NO

Summary

Closes the pipe.

accept

oslPipeError accept(

StreamPipe &

Connection );

virtual	abstract	const	volatile	template	static	inline	C-linkage
NO	NO	NO	NO	NO	NO	YES	NO

Summary

Accept connection on an existing pipe

getError

oslPipeError getError();

virtual	abstract	const	volatile	template	static	inline	C-linkage
NO	NO	NO	NO	NO	NO	YES	NO

Summary

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

Return

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

getHandle

oslPipe getHandle();

virtual	abstract	const	volatile	template	static	inline	C-linkage
NO	NO	NO	NO	NO	NO	YES	NO