(incubating) | The Free and Open Productivity Suite
Announcing Apache OpenOffice 3.4
 Overview   Namespace   Class   Index   Help 
PUBLIC MEMBERS:  CLASSESSTRUCTSUNIONSENUMSTYPEDEFSMETHODSSTATIC METHODSDATASTATIC DATA
PROTECTED MEMBERS:  CLASSESSTRUCTSUNIONSENUMSTYPEDEFSMETHODSSTATIC METHODSDATASTATIC DATA

:: osl ::

class Pipe


Base Classes
None.
Known Derived Classes
StreamPipe

virtual abstract interface template
NO NO NO NO
Summary
Represents a pipe.
File
pipe_decl.hxx

Public Members

Methods


Pipe( );
Does not create a pipe. Use assignment operator to make this a useable pipe.

Pipe( const ::rtl::OUString & strName, oslPipeOptions Options );
Creates a pipe.

Pipe( const ::rtl::OUString & strName, oslPipeOptions Options, const Security & rSecurity );
Creates a pipe.

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. Destroys the underlying oslPipe.
sal_Bool
is( ) const;
sal_Bool
create( const ::rtl::OUString & strName, oslPipeOptions Options, const Security & rSec );
Create a pipe with the given attributes. If the pipe was already created, the old one will be discarded.
sal_Bool
create( const ::rtl::OUString & strName, oslPipeOptions Options = osl_Pipe_OPEN );
Create a pipe with the given attributes. If socket was already created, the old one will be discarded.
void
clear( );
releases the underlying handle
Pipe &
operator=( const Pipe & pipe );
Assignment operator. If pipe was already created, the old one will be discarded.
Pipe &
operator=( const oslPipe pipe );
Assignment operator. If pipe was already created, the old one will be discarded.
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 Members

Data

oslPipe m_handle;

Top of Page

Apache Feather

Copyright & License | Privacy | Contact Us

Apache and the Apache feather logos are trademarks of The Apache Software Foundation. OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.

Apache OpenOffice is an effort undergoing incubation at The Apache Software Foundation (ASF), sponsored by the Apache Incubator. Incubation is required of all newly accepted projects until a further review indicates that the infrastructure, communications, and decision making process have stabilized in a manner consistent with other successful ASF projects. While incubation status is not necessarily a reflection of the completeness or stability of the code, it does indicate that the project has yet to be fully endorsed by the ASF.