My Project
UDK 3.2.7 C/C++ API Reference
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
pipe.h
Go to the documentation of this file.
1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2 /*************************************************************************
3  *
4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
5  *
6  * Copyright 2000, 2010 Oracle and/or its affiliates.
7  *
8  * OpenOffice.org - a multi-platform office productivity suite
9  *
10  * This file is part of OpenOffice.org.
11  *
12  * OpenOffice.org is free software: you can redistribute it and/or modify
13  * it under the terms of the GNU Lesser General Public License version 3
14  * only, as published by the Free Software Foundation.
15  *
16  * OpenOffice.org is distributed in the hope that it will be useful,
17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19  * GNU Lesser General Public License version 3 for more details
20  * (a copy is included in the LICENSE file that accompanied this code).
21  *
22  * You should have received a copy of the GNU Lesser General Public License
23  * version 3 along with OpenOffice.org. If not, see
24  * <http://www.openoffice.org/license.html>
25  * for a copy of the LGPLv3 License.
26  *
27  ************************************************************************/
28 
29 
30 #ifndef _OSL_PIPE_H_
31 #define _OSL_PIPE_H_
32 
33 # include <rtl/ustring.h>
34 
35 
36 # include <osl/security.h>
37 
38 #ifdef __cplusplus
39 extern "C" {
40 #endif
41 
42 typedef enum {
43  osl_Pipe_E_None, /* no error */
44  osl_Pipe_E_NotFound, /* Pipe could not be found */
45  osl_Pipe_E_AlreadyExists, /* Pipe already exists */
46  osl_Pipe_E_NoProtocol, /* Protocol not available */
47  osl_Pipe_E_NetworkReset, /* Network dropped connection because of reset */
48  osl_Pipe_E_ConnectionAbort, /* Software caused connection abort */
49  osl_Pipe_E_ConnectionReset, /* Connection reset by peer */
50  osl_Pipe_E_NoBufferSpace, /* No buffer space available */
51  osl_Pipe_E_TimedOut, /* Connection timed out */
52  osl_Pipe_E_ConnectionRefused, /* Connection refused */
53  osl_Pipe_E_invalidError, /* unmapped error: always last entry in enum! */
55 } oslPipeError;
56 
57 typedef sal_uInt32 oslPipeOptions;
58 #define osl_Pipe_OPEN 0x0000 /* open existing pipe */
59 #define osl_Pipe_CREATE 0x0001 /* create pipe and open it, fails if already existst */
60 
61 typedef struct oslPipeImpl * oslPipe;
62 
65 SAL_DLLPUBLIC oslPipe SAL_CALL osl_createPipe(
66  rtl_uString *strPipeName, oslPipeOptions Options, oslSecurity Security);
67 
71 SAL_DLLPUBLIC void SAL_CALL osl_releasePipe( oslPipe );
72 
75 SAL_DLLPUBLIC void SAL_CALL osl_acquirePipe( oslPipe Pipe );
76 
79 SAL_DLLPUBLIC void SAL_CALL osl_closePipe( oslPipe );
80 
81 
82 SAL_DLLPUBLIC oslPipe SAL_CALL osl_acceptPipe(oslPipe Pipe);
83 
84 SAL_DLLPUBLIC sal_Int32 SAL_CALL osl_sendPipe(oslPipe Pipe, const void* pBuffer, sal_Int32 BufferSize);
85 SAL_DLLPUBLIC sal_Int32 SAL_CALL osl_receivePipe(oslPipe Pipe, void* pBuffer, sal_Int32 BufferSize);
86 
90 SAL_DLLPUBLIC sal_Int32 SAL_CALL osl_readPipe( oslPipe Pipe, void *pBuffer, sal_Int32 BufferSize );
91 
95 SAL_DLLPUBLIC sal_Int32 SAL_CALL osl_writePipe( oslPipe Pipe, const void *pBuffer, sal_Int32 BufferSize );
96 
97 SAL_DLLPUBLIC oslPipeError SAL_CALL osl_getLastPipeError(oslPipe Pipe);
98 
99 #ifdef __cplusplus
100 }
101 #endif
102 
103 #endif /* _OSL_PIPE_H_ */
104 
105 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */