Overview | Namespace | Class | Index | Help

PUBLIC MEMBERS: | CLASSES | STRUCTS | UNIONS | ENUMS | TYPEDEFS | METHODS | STATIC METHODS | DATA | STATIC DATA
PROTECTED MEMBERS: | CLASSES | STRUCTS | UNIONS | ENUMS | TYPEDEFS | METHODS | STATIC METHODS | DATA | STATIC 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 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. Destroys the underlying oslPipe.
  sal_Bool is( ) const; |
  sal_Bool create( const ::rtl::OUString & strName, oslPipeOptions Options, const Security & rSec ); |
  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. 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

Copyright © 2003 Sun Microsystems, Inc.