pipe.h

Go to the documentation of this file.

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
 
 
#ifndef INCLUDED_OSL_PIPE_H
#define INCLUDED_OSL_PIPE_H
 
#include "sal/config.h"
 
#include "osl/security.h"
#include "rtl/ustring.h"
#include "sal/saldllapi.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef enum {
    osl_Pipe_E_None,                    /*< no error */
    osl_Pipe_E_NotFound,                /*< Pipe could not be found */
    osl_Pipe_E_AlreadyExists,           /*< Pipe already exists */
    osl_Pipe_E_NoProtocol,              /*< Protocol not available */
    osl_Pipe_E_NetworkReset,            /*< Network dropped connection because of reset */
    osl_Pipe_E_ConnectionAbort,         /*< Software caused connection abort */
    osl_Pipe_E_ConnectionReset,         /*< Connection reset by peer */
    osl_Pipe_E_NoBufferSpace,           /*< No buffer space available */
    osl_Pipe_E_TimedOut,                /*< Connection timed out */
    osl_Pipe_E_ConnectionRefused,       /*< Connection refused */
    osl_Pipe_E_invalidError,            /*< unmapped error: always last entry in enum! */
    osl_Pipe_E_FORCE_EQUAL_SIZE = SAL_MAX_ENUM
} oslPipeError;
 
typedef sal_uInt32 oslPipeOptions;
#define osl_Pipe_OPEN        0x0000     /*< open existing pipe */
#define osl_Pipe_CREATE      0x0001     /*< create pipe and open it, fails if already exists */
 
typedef struct oslPipeImpl * oslPipe;
 
SAL_DLLPUBLIC oslPipe SAL_CALL osl_createPipe(
        rtl_uString *strPipeName, oslPipeOptions Options, oslSecurity Security);
 
SAL_DLLPUBLIC void    SAL_CALL osl_releasePipe(oslPipe Pipe);
 
SAL_DLLPUBLIC void    SAL_CALL osl_acquirePipe(oslPipe Pipe);
 
SAL_DLLPUBLIC void    SAL_CALL osl_closePipe(oslPipe Pipe);
 
 
SAL_DLLPUBLIC oslPipe SAL_CALL osl_acceptPipe(oslPipe Pipe);
 
SAL_DLLPUBLIC sal_Int32 SAL_CALL osl_sendPipe(oslPipe Pipe, const void* pBuffer, sal_Int32 BufferSize);
SAL_DLLPUBLIC sal_Int32 SAL_CALL osl_receivePipe(oslPipe Pipe, void* pBuffer, sal_Int32 BufferSize);
 
SAL_DLLPUBLIC sal_Int32 SAL_CALL osl_readPipe( oslPipe Pipe, void *pBuffer, sal_Int32 BufferSize );
 
SAL_DLLPUBLIC sal_Int32 SAL_CALL osl_writePipe( oslPipe Pipe, const void *pBuffer, sal_Int32 BufferSize );
 
SAL_DLLPUBLIC oslPipeError SAL_CALL osl_getLastPipeError(oslPipe Pipe);
 
#ifdef __cplusplus
}
#endif
 
#endif // INCLUDED_OSL_PIPE_H
 
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */