osl::StreamPipe Class Reference
A pipe to send or receive a stream of data.
More...
#include <pipe_decl.hxx>
List of all members.
Detailed Description
A pipe to send or receive a stream of data.
Constructor & Destructor Documentation
osl::StreamPipe::StreamPipe |
( |
|
) |
[inline] |
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.
osl::StreamPipe::StreamPipe |
( |
oslPipe |
Pipe |
) |
[inline] |
Creates pipe as wrapper around the underlying oslPipe.
- Parameters:
-
osl::StreamPipe::StreamPipe |
( |
const StreamPipe & |
Pipe |
) |
[inline] |
Copy constructor.
- Parameters:
-
Creates a pipe.
- Parameters:
-
Creates a pipe.
- Parameters:
-
Constructs a Pipe reference without acquiring the handle.
Member Function Documentation
Attaches the oslPipe to this object.
If the object already was attached to an oslPipe, the old one will be closed and destroyed.
- Parameters:
-
Reimplemented from osl::Pipe.
sal_Int32 osl::StreamPipe::read |
( |
void * |
pBuffer, |
|
|
sal_Int32 |
n | |
|
) |
| | const [inline] |
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! |
- Returns:
- the number of read bytes. The number will only be smaller than n if an exceptional condition (e.g. connection closed) occurs.
sal_Int32 osl::StreamPipe::recv |
( |
void * |
pBuffer, |
|
|
sal_Int32 |
BytesToRead | |
|
) |
| | const [inline] |
Tries to receives BytesToRead data from the connected pipe,.
- Parameters:
-
| pBuffer | [out] Points to a buffer that will be filled with the received data. |
| BytesToRead | [in] The number of bytes to read. pBuffer must have at least this size. |
- Returns:
- the number of received bytes.
sal_Int32 osl::StreamPipe::send |
( |
const void * |
pBuffer, |
|
|
sal_Int32 |
BytesToSend | |
|
) |
| | const [inline] |
Tries to sends BytesToSend data from the connected pipe.
- Parameters:
-
| pBuffer | [in] Points to a buffer that contains the send-data. |
| BytesToSend | [in] The number of bytes to send. pBuffer must have at least this size. |
- Returns:
- the number of transfered bytes.
sal_Int32 osl::StreamPipe::write |
( |
const void * |
pBuffer, |
|
|
sal_Int32 |
n | |
|
) |
| | const [inline] |
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. |
- Returns:
- the number of written bytes. The number will only be smaller than n if an exceptional condition (e.g. connection closed) occurs.
The documentation for this class was generated from the following files: