LibreOffice
LibreOffice 7.1 SDK C/C++ API Reference
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 * This file is part of the LibreOffice project.
4 *
5 * This Source Code Form is subject to the terms of the Mozilla Public
6 * License, v. 2.0. If a copy of the MPL was not distributed with this
7 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
8 *
9 * This file incorporates work covered by the following license notice:
10 *
11 * Licensed to the Apache Software Foundation (ASF) under one or more
12 * contributor license agreements. See the NOTICE file distributed
13 * with this work for additional information regarding copyright
14 * ownership. The ASF licenses this file to you under the Apache
15 * License, Version 2.0 (the "License"); you may not use this file
16 * except in compliance with the License. You may obtain a copy of
17 * the License at http://www.apache.org/licenses/LICENSE-2.0 .
18 */
19
20
21#ifndef INCLUDED_OSL_PIPE_H
22#define INCLUDED_OSL_PIPE_H
23
24#include "sal/config.h"
25
26#include "osl/security.h"
27#include "rtl/ustring.h"
28#include "sal/saldllapi.h"
29
30#ifdef __cplusplus
31extern "C" {
32#endif
33
34typedef enum {
35 osl_Pipe_E_None, /*< no error */
36 osl_Pipe_E_NotFound, /*< Pipe could not be found */
37 osl_Pipe_E_AlreadyExists, /*< Pipe already exists */
38 osl_Pipe_E_NoProtocol, /*< Protocol not available */
39 osl_Pipe_E_NetworkReset, /*< Network dropped connection because of reset */
40 osl_Pipe_E_ConnectionAbort, /*< Software caused connection abort */
41 osl_Pipe_E_ConnectionReset, /*< Connection reset by peer */
42 osl_Pipe_E_NoBufferSpace, /*< No buffer space available */
43 osl_Pipe_E_TimedOut, /*< Connection timed out */
44 osl_Pipe_E_ConnectionRefused, /*< Connection refused */
45 osl_Pipe_E_invalidError, /*< unmapped error: always last entry in enum! */
48
53typedef sal_uInt32 oslPipeOptions;
54#define osl_Pipe_OPEN 0x0000 /*< open existing pipe */
55#define osl_Pipe_CREATE 0x0001 /*< create pipe and open it, fails if already exists */
56
57typedef struct oslPipeImpl * oslPipe;
58
70 rtl_uString *strPipeName, oslPipeOptions Options, oslSecurity Security);
71
81
89
99
100
102
103SAL_DLLPUBLIC sal_Int32 SAL_CALL osl_sendPipe(oslPipe Pipe, const void* pBuffer, sal_Int32 BufferSize);
104SAL_DLLPUBLIC sal_Int32 SAL_CALL osl_receivePipe(oslPipe Pipe, void* pBuffer, sal_Int32 BufferSize);
105
109SAL_DLLPUBLIC sal_Int32 SAL_CALL osl_readPipe( oslPipe Pipe, void *pBuffer, sal_Int32 BufferSize );
110
114SAL_DLLPUBLIC sal_Int32 SAL_CALL osl_writePipe( oslPipe Pipe, const void *pBuffer, sal_Int32 BufferSize );
115
117
118#ifdef __cplusplus
119}
120#endif
121
122#endif // INCLUDED_OSL_PIPE_H
123
124/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
#define SAL_MAX_ENUM
Definition: types.h:201
#define SAL_DLLPUBLIC
Definition: saldllapi.h:30
void * oslSecurity
Process handle.
Definition: security.h:45
oslPipeError
Definition: pipe.h:34
@ osl_Pipe_E_ConnectionReset
Definition: pipe.h:41
@ osl_Pipe_E_TimedOut
Definition: pipe.h:43
@ osl_Pipe_E_ConnectionRefused
Definition: pipe.h:44
@ osl_Pipe_E_None
Definition: pipe.h:35
@ osl_Pipe_E_NetworkReset
Definition: pipe.h:39
@ osl_Pipe_E_NoBufferSpace
Definition: pipe.h:42
@ osl_Pipe_E_ConnectionAbort
Definition: pipe.h:40
@ osl_Pipe_E_NotFound
Definition: pipe.h:36
@ osl_Pipe_E_FORCE_EQUAL_SIZE
Definition: pipe.h:46
@ osl_Pipe_E_AlreadyExists
Definition: pipe.h:37
@ osl_Pipe_E_NoProtocol
Definition: pipe.h:38
@ osl_Pipe_E_invalidError
Definition: pipe.h:45
SAL_DLLPUBLIC sal_Int32 osl_writePipe(oslPipe Pipe, const void *pBuffer, sal_Int32 BufferSize)
Writes blocking onto the pipe.
SAL_DLLPUBLIC sal_Int32 osl_readPipe(oslPipe Pipe, void *pBuffer, sal_Int32 BufferSize)
Reads blocking from the pipe.
sal_uInt32 oslPipeOptions
Pipe creation options.
Definition: pipe.h:53
SAL_DLLPUBLIC sal_Int32 osl_sendPipe(oslPipe Pipe, const void *pBuffer, sal_Int32 BufferSize)
struct oslPipeImpl * oslPipe
Definition: pipe.h:57
SAL_DLLPUBLIC oslPipe osl_acceptPipe(oslPipe Pipe)
SAL_DLLPUBLIC void osl_closePipe(oslPipe Pipe)
Close the pipe.
SAL_DLLPUBLIC void osl_acquirePipe(oslPipe Pipe)
Increases the refcount of the pipe.
SAL_DLLPUBLIC sal_Int32 osl_receivePipe(oslPipe Pipe, void *pBuffer, sal_Int32 BufferSize)
SAL_DLLPUBLIC oslPipe osl_createPipe(rtl_uString *strPipeName, oslPipeOptions Options, oslSecurity Security)
Create or open a pipe.
SAL_DLLPUBLIC oslPipeError osl_getLastPipeError(oslPipe Pipe)
SAL_DLLPUBLIC void osl_releasePipe(oslPipe Pipe)
Decreases the refcount of the pipe.