Methods of Class StreamPipe

StreamPipe

StreamPipe();

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

Description

Creates an unattached pipe. You must attach the pipe to an oslPipe
e.g. by using the operator=(oslPipe), before you can use the stream-
functionality of the object.

StreamPipe

StreamPipe(

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

StreamPipe

StreamPipe(

const StreamPipe &

Pipe );

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

Summary

Copy constructor.

Parameters

Pipe

StreamPipe

StreamPipe(

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

Creates a pipe.

Parameters

strName
Options

StreamPipe

StreamPipe(

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

Creates a pipe.

Parameters

strName
Options
rSec

StreamPipe

StreamPipe(

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

operator=

StreamPipe & operator=(

oslPipe

Pipe );

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

Description

Attaches the oslPipe to this object. If the object
already was attached to an oslPipe, the old one will
be closed and destroyed.

Parameters

Pipe.

operator=

StreamPipe & operator=(

const Pipe &

pipe );

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

Summary

Assignment operator

recv

sal_Int32 recv(

void *	pBuffer,
sal_Int32	BytesToRead ) const;

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

Summary

Tries to receives BytesToRead data from the connected pipe,

Parameters

pBuffer

Points to a buffer that will be filled with the received 
data.

BytesToRead

The number of bytes to read. pBuffer must have at least
this size.

Return

the number of received bytes.

send

sal_Int32 send(

const void *	pBuffer,
sal_Int32	BytesToSend ) const;

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

Summary

Tries to sends BytesToSend data from the connected pipe.

Parameters

pBuffer

Points to a buffer that contains the send-data.

BytesToSend

The number of bytes to send. pBuffer must have at least
this size.

Return

the number of transfered bytes.

read

sal_Int32 read(

void *	pBuffer,
sal_Int32	n ) const;

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

Summary

Retrieves n bytes from the stream and copies them into pBuffer.
The method avoids incomplete reads due to packet boundaries.

Parameters

pBuffer

receives the read data.

n

the number of bytes to read. pBuffer must be large enough
to hold the n bytes!

Return

the number of read bytes. The number will only be smaller than
n if an exceptional condition (e.g. connection closed) occurs.

write

sal_Int32 write(

const void *	pBuffer,
sal_Int32	n ) const;

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

Summary

Writes n bytes from pBuffer to the stream. The method avoids 
incomplete writes due to packet boundaries.

Parameters

pBuffer	contains the data to be written.
n	the number of bytes to write.

Return

the number of written bytes. The number will only be smaller than
n if an exceptional condition (e.g. connection closed) occurs.