Google Git
Sign in
apache / openoffice-org / refs/heads/irc / . / content / udk / cpp / ref / names / osl / c-Pipe.html
blob: 98b2602ce95b1b24c3956ad5c99197299995e770 [file] [log] [blame]
<html>
<head>
<title>class Pipe</title>
<style> h1 { font-size:20pt; margin-top:3pt; margin-bottom:7pt; }
h2 { font-family:"Arial"; font-size:16pt; margin-top:3pt; margin-bottom:5pt; }
h3 { font-size:13pt; margin-top:2pt; margin-bottom:3pt; }
h4 { font-size:10pt; font-weight:bold; margin-top:2pt; margin-bottom:1pt; }
dl { margin-top:1pt; margin-bottom:1pt; }
dl.member { margin-top:1pt; margin-bottom:1pt; background-color:#eeeeff; }
dt { font-size:10pt; font-weight:bold; margin-top:2pt; margin-bottom:1pt; }
dt.member { font-size:13pt; font-weight:bold; margin-top:2pt; margin-bottom:1pt; }
dt.simple { font-size:10pt; font-weight:normal; margin-top:2pt; margin-bottom:1pt; }
dd { font-size:10pt; margin-top:1pt; margin-bottom:1pt; }
dd.member { font-size:10pt; margin-top:1pt; margin-bottom:1pt; background-color:#ffffff; }
p { font-size:10pt; margin-top:3pt; margin-bottom:1pt; }
pre { font-family: Times, serif; font-size:10pt; margin-top:1pt; margin-bottom:1pt; }
tr { font-size:10pt; }
td { font-size:10pt; }
</style>
<meta HTTP-EQUIV="content-type" CONTENT="text/html; charset=UTF-8">
</head>
<body bgcolor="#ffffff">
<a name="_top_"> </a>
<table border="0" cellpadding="1" cellspacing="0">
<tr align="center" valign="top">
<td bgcolor="#eeeeff">&nbsp;<a href="../../index.html" alt><font family="Arial" color="#000000" size="+1"><b>Overview</b></font></a>&nbsp;</td>
<td bgcolor="#eeeeff">&nbsp;<a href="index.html" alt><font family="Arial" color="#000000" size="+1"><b>Namespace</b></font></a>&nbsp;</td>
<td bgcolor="#2222ad">&nbsp;<font family="Arial" color="#ffffff" size="+1"><b>Class</b></font>&nbsp;</td>
<td bgcolor="#eeeeff">&nbsp;<a href="../../index-files/index-1.html" alt><font family="Arial" color="#000000" size="+1"><b>Index</b></font></a>&nbsp;</td>
<td bgcolor="#eeeeff">&nbsp;<a href="../../help.html" alt><font family="Arial" color="#000000" size="+1"><b>Help</b></font></a>&nbsp;</td>
</tr>
</table>
<table cellpadding="0" cellspacing="3">
<tr>
<td width="20%"><font size="-2">PUBLIC MEMBERS:</font></td>
<td>
&nbsp;<font size="-2">CLASSES</font>
|&nbsp;<font size="-2">STRUCTS</font>
|&nbsp;<font size="-2">UNIONS</font>
|&nbsp;<font size="-2">ENUMS</font>
|&nbsp;<font size="-2">TYPEDEFS</font>
|&nbsp;<a href="#publ_ops"><font size="-2"><b>METHODS</b></font></a>
|&nbsp;<font size="-2">STATIC METHODS</font>
|&nbsp;<font size="-2">DATA</font>
|&nbsp;<font size="-2">STATIC DATA</font></td>
</tr>
<tr>
<td width="20%"><font size="-2">PROTECTED MEMBERS:</font></td>
<td>
&nbsp;<font size="-2">CLASSES</font>
|&nbsp;<font size="-2">STRUCTS</font>
|&nbsp;<font size="-2">UNIONS</font>
|&nbsp;<font size="-2">ENUMS</font>
|&nbsp;<font size="-2">TYPEDEFS</font>
|&nbsp;<font size="-2">METHODS</font>
|&nbsp;<font size="-2">STATIC METHODS</font>
|&nbsp;<a href="#prot_vars"><font size="-2"><b>DATA</b></font></a>
|&nbsp;<font size="-2">STATIC DATA</font></td>
</tr>
</table>
<hr>
<a href="../../names/index.html" alt="Global Namespace in C++"><font size="+1"><b>::</b></font></a> <a href="index.html" alt="namespace"><font size="+1"><b>osl</b></font></a><font size="+1"> :: </font><div align="center" style="background-color:#ccccff; line-height:26pt;"><h2>class Pipe</h2>
</div><hr>
<dl>
<dt>Base Classes</dt>
<dd>None.</dd>
</dl>
<dl>
<dt>Known Derived Classes</dt>
<dd><a href="c-StreamPipe.html">StreamPipe</a><br>
</dd>
</dl>
<br>
<table border cellspacing="0">
<tr>
<td bgcolor="#eeeeff" width="25%" style="font-family:Arial; font-size:8pt; font-weight:bold;">virtual</td>
<td bgcolor="#eeeeff" width="25%" style="font-family:Arial; font-size:8pt; font-weight:bold;">abstract</td>
<td bgcolor="#eeeeff" width="25%" style="font-family:Arial; font-size:8pt; font-weight:bold;">interface</td>
<td bgcolor="#eeeeff" width="25%" style="font-family:Arial; font-size:8pt; font-weight:bold;">template</td>
</tr>
<tr>
<td style="font-family:Arial; font-size:8pt;">NO</td>
<td style="font-family:Arial; font-size:8pt;">NO</td>
<td style="font-family:Arial; font-size:8pt;">NO</td>
<td style="font-family:Arial; font-size:8pt;">NO</td>
</tr>
</table>
<dl>
<dt>Summary</dt>
<dd><pre>Represents a pipe.
</pre></dd>
</dl>
<dl>
<dt>File</dt>
<dd>pipe_decl.hxx</dd>
</dl>
<hr>
<dl>
<dt bgcolor="#CCCCFF"><a name="publ_"><h3>Public Members</h3>
</a>
</dt>
<dd><a name="publ_ops"> </a>
<table cellpadding="5" cellspacing="0" width="100%">
<tr bgcolor="#CCCCFF">
<td colspan="2"><h4>Methods</h4>
</td>
</tr>
<tr>
<td> <br>
<a href="Pipe/o.html#Pipe-1">Pipe</a>( );</td>
<td width="50%"> Does not create a pipe. Use assignment operator to
make this a useable pipe.
</td>
</tr>
<tr>
<td> <br>
<a href="Pipe/o.html#Pipe-103">Pipe</a>( const ::rtl::OUString &amp; strName, oslPipeOptions Options );</td>
<td width="50%"> Creates a pipe.
</td>
</tr>
<tr>
<td> <br>
<a href="Pipe/o.html#Pipe-104">Pipe</a>( const ::rtl::OUString &amp; strName, oslPipeOptions Options, const Security &amp; rSecurity );</td>
<td width="50%"> Creates a pipe.
</td>
</tr>
<tr>
<td> <br>
<a href="Pipe/o.html#Pipe-105">Pipe</a>( const Pipe &amp; pipe );</td>
<td width="50%"> Copy constructor.
</td>
</tr>
<tr>
<td> <br>
<a href="Pipe/o.html#Pipe-106">Pipe</a>( oslPipe pipe, __sal_NoAcquire noacquire );</td>
<td width="50%"> Constructs a Pipe reference without acquiring the handle
</td>
</tr>
<tr>
<td> <br>
<a href="Pipe/o.html#Pipe-107">Pipe</a>( oslPipe Pipe );</td>
<td width="50%"> Creates pipe as wrapper around the underlying oslPipe.
</td>
</tr>
<tr>
<td> <br>
<a href="Pipe/o.html#~Pipe-1">~Pipe</a>( );</td>
<td width="50%"> Destructor. Destroys the underlying oslPipe.
</td>
</tr>
<tr>
<td>sal_Bool <br>
<a href="Pipe/o.html#is-5">is</a>( ) const;</td>
<td width="50%"> </td>
</tr>
<tr>
<td>sal_Bool <br>
<a href="Pipe/o.html#create-104">create</a>( const ::rtl::OUString &amp; strName, oslPipeOptions Options, const Security &amp; rSec );</td>
<td width="50%"> Create a pipe with the given attributes.
If the pipe was already created, the old one will be discarded.
</td>
</tr>
<tr>
<td>sal_Bool <br>
<a href="Pipe/o.html#create-103">create</a>( const ::rtl::OUString &amp; strName, oslPipeOptions Options = osl_Pipe_OPEN );</td>
<td width="50%"> Create a pipe with the given attributes.
If socket was already created, the old one will be discarded.
</td>
</tr>
<tr>
<td>void <br>
<a href="Pipe/o.html#clear-1">clear</a>( );</td>
<td width="50%"> releases the underlying handle
</td>
</tr>
<tr>
<td>Pipe &amp; <br>
<a href="Pipe/o.html#operator=-105">operator=</a>( const Pipe &amp; pipe );</td>
<td width="50%"> Assignment operator. If pipe was already created, the old one will
be discarded.
</td>
</tr>
<tr>
<td>Pipe &amp; <br>
<a href="Pipe/o.html#operator=-108">operator=</a>( const oslPipe pipe );</td>
<td width="50%"> Assignment operator. If pipe was already created, the old one will
be discarded.
</td>
</tr>
<tr>
<td>sal_Bool <br>
<a href="Pipe/o.html#isValid-5">isValid</a>( ) const;</td>
<td width="50%"> Checks if the pipe is valid.
</td>
</tr>
<tr>
<td>sal_Bool <br>
<a href="Pipe/o.html#operator==-109">operator==</a>( const Pipe &amp; rPipe ) const;</td>
<td width="50%"> </td>
</tr>
<tr>
<td>void <br>
<a href="Pipe/o.html#close-1">close</a>( );</td>
<td width="50%"> Closes the pipe.
</td>
</tr>
<tr>
<td>oslPipeError <br>
<a href="Pipe/o.html#accept-110">accept</a>( StreamPipe &amp; Connection );</td>
<td width="50%"> Accept connection on an existing pipe
</td>
</tr>
<tr>
<td>oslPipeError <br>
<a href="Pipe/o.html#getError-5">getError</a>( ) const;</td>
<td width="50%"> Delivers a constant decribing the last error for the pipe system.
</td>
</tr>
<tr>
<td>oslPipe <br>
<a href="Pipe/o.html#getHandle-5">getHandle</a>( ) const;</td>
<td width="50%"> </td>
</tr>
</table>
<hr>
</dd>
</dl>
<dl>
<dt bgcolor="#CCCCFF"><a name="prot_"><h3>Protected Members</h3>
</a>
</dt>
<dd><a name="prot_vars"> </a>
<table cellpadding="5" cellspacing="0" width="100%">
<tr bgcolor="#CCCCFF">
<td colspan="2"><h4>Data</h4>
</td>
</tr>
<tr bgcolor="white">
<td><a href="../t-oslPipe.html">oslPipe</a> <a href="Pipe/d.html#m_handle"><strong>m_handle;</strong></a></td>
<td/></tr>
</table>
<hr>
</dd>
</dl>
<a href="#_top_" class="objchapter">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright 2002 Sun Microsystems, Inc., 901 San Antonio Road, Palo Alto, CA 94303 USA.</p>
</body>