LibreOffice
LibreOffice 5.3 SDK C/C++ API Reference
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
pipe_decl.hxx
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 #ifndef INCLUDED_OSL_PIPE_DECL_HXX
20 #define INCLUDED_OSL_PIPE_DECL_HXX
21 
22 #include <osl/pipe.h>
23 # include <osl/security.hxx>
24 #include <rtl/ustring.hxx>
25 
26 namespace osl {
27 
28 class StreamPipe;
29 
32 class Pipe
33 {
34 protected:
36 
37 public:
38 
42  inline Pipe();
43 
48  inline Pipe(const ::rtl::OUString& strName, oslPipeOptions Options);
49 
55  inline Pipe(const ::rtl::OUString& strName, oslPipeOptions Options,const Security & rSecurity);
56 
59  inline Pipe(const Pipe& pipe);
60 
61 #if defined LIBO_INTERNAL_ONLY
62  inline Pipe(Pipe && other);
63 #endif
64 
67  inline Pipe( oslPipe pipe, __sal_NoAcquire noacquire );
68 
72  inline Pipe(oslPipe Pipe);
73 
76  inline ~Pipe();
77 
78  inline bool SAL_CALL is() const;
79 
88  inline bool create( const ::rtl::OUString & strName,
89  oslPipeOptions Options, const Security &rSec );
90 
99  inline bool create( const ::rtl::OUString & strName, oslPipeOptions Options = osl_Pipe_OPEN );
100 
103  inline void SAL_CALL clear();
104 
108  inline Pipe& SAL_CALL operator= (const Pipe& pipe);
109 
110 #if defined LIBO_INTERNAL_ONLY
111  inline Pipe & operator =(Pipe && other);
112 #endif
113 
117  inline Pipe& SAL_CALL operator= (const oslPipe pipe );
118 
122  inline bool SAL_CALL isValid() const;
123 
124  inline bool SAL_CALL operator==( const Pipe& rPipe ) const;
125 
128  inline void SAL_CALL close();
129 
132  inline oslPipeError SAL_CALL accept(StreamPipe& Connection);
133 
134 
140  inline oslPipeError SAL_CALL getError() const;
141 
142  inline oslPipe SAL_CALL getHandle() const;
143 };
144 
147 class StreamPipe : public Pipe
148 {
149 public:
150 
155  inline StreamPipe();
156 
160  inline StreamPipe(oslPipe Pipe);
161 
165  inline StreamPipe(const StreamPipe& Pipe);
166 
171  inline StreamPipe(const ::rtl::OUString& strName, oslPipeOptions Options = osl_Pipe_OPEN);
172 
178  inline StreamPipe(const ::rtl::OUString& strName, oslPipeOptions Options, const Security &rSec );
179 
182  inline StreamPipe( oslPipe pipe, __sal_NoAcquire noacquire );
183 
189  inline StreamPipe & SAL_CALL operator=(oslPipe Pipe);
190 
193  inline StreamPipe& SAL_CALL operator=(const Pipe& pipe);
194 
203  inline sal_Int32 SAL_CALL recv(void* pBuffer, sal_Int32 BytesToRead) const;
204 
212  inline sal_Int32 SAL_CALL send(const void* pBuffer, sal_Int32 BytesToSend) const;
213 
222  inline sal_Int32 SAL_CALL read(void* pBuffer, sal_Int32 n) const;
223 
231  sal_Int32 SAL_CALL write(const void* pBuffer, sal_Int32 n) const;
232 };
233 
234 }
235 #endif
236 
237 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
Pipe()
Does not create a pipe.
Definition: pipe.hxx:31
A pipe to send or receive a stream of data.
Definition: pipe_decl.hxx:147
oslPipeError
Definition: pipe.h:34
void clear()
releases the underlying handle
Definition: pipe.hxx:139
StreamPipe()
Creates an unattached pipe.
Definition: pipe.hxx:171
bool operator==(const Pipe &rPipe) const
Definition: pipe.hxx:127
sal_uInt32 oslPipeOptions
Definition: pipe.h:49
void close()
Closes the pipe.
Definition: pipe.hxx:133
#define osl_Pipe_OPEN
Definition: pipe.h:50
bool isValid() const
Checks if the pipe is valid.
sal_Int32 read(void *pBuffer, sal_Int32 n) const
Retrieves n bytes from the stream and copies them into pBuffer.
Definition: pipe.hxx:199
__sal_NoAcquire
Definition: types.h:384
bool is() const
Definition: pipe.hxx:121
~Pipe()
Destructor.
Definition: pipe.hxx:72
oslPipe getHandle() const
Definition: pipe.hxx:165
oslPipeError accept(StreamPipe &Connection)
Accept connection on an existing pipe.
Definition: pipe.hxx:149
StreamPipe & operator=(oslPipe Pipe)
Attaches the oslPipe to this object.
sal_Int32 send(const void *pBuffer, sal_Int32 BytesToSend) const
Tries to sends BytesToSend data from the connected pipe.
Definition: pipe.hxx:217
bool create(const ::rtl::OUString &strName, oslPipeOptions Options, const Security &rSec)
Creates an insecure pipe that is accessible for all users with the given attributes.
Definition: pipe.hxx:79
oslPipe m_handle
Definition: pipe_decl.hxx:35
oslPipeError getError() const
Delivers a constant describing the last error for the pipe system.
Definition: pipe.hxx:159
Represents a pipe.
Definition: pipe_decl.hxx:32
Pipe & operator=(const Pipe &pipe)
Assignment operator.
Definition: pipe.hxx:93
sal_Int32 write(const void *pBuffer, sal_Int32 n) const
Writes n bytes from pBuffer to the stream.
Definition: pipe.hxx:205
sal_Int32 recv(void *pBuffer, sal_Int32 BytesToRead) const
Tries to receives BytesToRead data from the connected pipe,.
Definition: pipe.hxx:211
capsulate security information for one user.
Definition: security_decl.hxx:34
struct oslPipeImpl * oslPipe
Definition: pipe.h:53