Go to the source code of this file.
|  | 
| #define | osl_Pipe_OPEN   0x0000     /*< open existing pipe */ | 
|  | 
| #define | osl_Pipe_CREATE   0x0001     /*< create pipe and open it, fails if already exists */ | 
|  | 
|  | 
| enum | oslPipeError { osl_Pipe_E_None
, osl_Pipe_E_NotFound
, osl_Pipe_E_AlreadyExists
, osl_Pipe_E_NoProtocol
,
 osl_Pipe_E_NetworkReset
, osl_Pipe_E_ConnectionAbort
, osl_Pipe_E_ConnectionReset
, osl_Pipe_E_NoBufferSpace
,
 osl_Pipe_E_TimedOut
, osl_Pipe_E_ConnectionRefused
, osl_Pipe_E_invalidError
, osl_Pipe_E_FORCE_EQUAL_SIZE = SAL_MAX_ENUM
 }
 | 
|  | 
|  | 
| SAL_DLLPUBLIC oslPipe | osl_createPipe (rtl_uString *strPipeName, oslPipeOptions Options, oslSecurity Security) | 
|  | Create or open a pipe. 
 | 
|  | 
| SAL_DLLPUBLIC void | osl_releasePipe (oslPipe Pipe) | 
|  | Decreases the refcount of the pipe. 
 | 
|  | 
| SAL_DLLPUBLIC void | osl_acquirePipe (oslPipe Pipe) | 
|  | Increases the refcount of the pipe. 
 | 
|  | 
| SAL_DLLPUBLIC void | osl_closePipe (oslPipe Pipe) | 
|  | Close the pipe. 
 | 
|  | 
| SAL_DLLPUBLIC oslPipe | osl_acceptPipe (oslPipe Pipe) | 
|  | 
| SAL_DLLPUBLIC sal_Int32 | osl_sendPipe (oslPipe Pipe, const void *pBuffer, sal_Int32 BufferSize) | 
|  | 
| SAL_DLLPUBLIC sal_Int32 | osl_receivePipe (oslPipe Pipe, void *pBuffer, sal_Int32 BufferSize) | 
|  | 
| SAL_DLLPUBLIC sal_Int32 | osl_readPipe (oslPipe Pipe, void *pBuffer, sal_Int32 BufferSize) | 
|  | Reads blocking from the pipe. 
 | 
|  | 
| SAL_DLLPUBLIC sal_Int32 | osl_writePipe (oslPipe Pipe, const void *pBuffer, sal_Int32 BufferSize) | 
|  | Writes blocking onto the pipe. 
 | 
|  | 
| SAL_DLLPUBLIC oslPipeError | osl_getLastPipeError (oslPipe Pipe) | 
|  | 
◆ osl_Pipe_CREATE
      
        
          | #define osl_Pipe_CREATE   0x0001     /*< create pipe and open it, fails if already exists */ | 
      
 
 
◆ osl_Pipe_OPEN
      
        
          | #define osl_Pipe_OPEN   0x0000     /*< open existing pipe */ | 
      
 
 
◆ oslPipe
      
        
          | typedef struct oslPipeImpl* oslPipe | 
      
 
 
◆ oslPipeOptions
Pipe creation options. 
A pipe can either be opened, or a new pipe can be created and opened. 
 
 
◆ oslPipeError
| Enumerator | 
|---|
| osl_Pipe_E_None |  | 
| osl_Pipe_E_NotFound |  | 
| osl_Pipe_E_AlreadyExists |  | 
| osl_Pipe_E_NoProtocol |  | 
| osl_Pipe_E_NetworkReset |  | 
| osl_Pipe_E_ConnectionAbort |  | 
| osl_Pipe_E_ConnectionReset |  | 
| osl_Pipe_E_NoBufferSpace |  | 
| osl_Pipe_E_TimedOut |  | 
| osl_Pipe_E_ConnectionRefused |  | 
| osl_Pipe_E_invalidError |  | 
| osl_Pipe_E_FORCE_EQUAL_SIZE |  | 
 
 
◆ osl_acceptPipe()
◆ osl_acquirePipe()
◆ osl_closePipe()
Close the pipe. 
Any read, write or accept actions stop immediately.
- Parameters
- 
  
  
- See also
- osl_createPipe 
 
 
◆ osl_createPipe()
Create or open a pipe. 
- Parameters
- 
  
    | [in] | strPipeName | pipe name |  | [in] | Options | create or open the pipe |  | [in] | Security | pipe creator |  
 
- Returns
- nullptr on failure, otherwise returns the pipe handle
- See also
- osl_closePipe 
 
 
◆ osl_getLastPipeError()
◆ osl_readPipe()
Reads blocking from the pipe. 
- Returns
- Number of read bytes. If less than BufferSize, the pipe was closed. 
 
 
◆ osl_receivePipe()
◆ osl_releasePipe()
Decreases the refcount of the pipe. 
If the refcount drops to zero, the handle is destroyed.
- Parameters
- 
  
  
- See also
- osl_acquirePipe 
 
 
◆ osl_sendPipe()
◆ osl_writePipe()
Writes blocking onto the pipe. 
- Returns
- Number of written bytes. If less than BufferSize, the pipe was closed.