LibreOffice: osl/pipe_decl.hxx Source File

LibreOffice LibreOffice 6.4 SDK C/C++ API Reference

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:
35 oslPipe m_handle;
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) noexcept;
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) noexcept;
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
161 inline StreamPipe(oslPipe Pipe);
162
168 inline StreamPipe(const ::rtl::OUString& strName, oslPipeOptions Options = osl_Pipe_OPEN);
169
176 inline StreamPipe(const ::rtl::OUString& strName, oslPipeOptions Options, const Security &rSec );
177
180 inline StreamPipe( oslPipe pipe, __sal_NoAcquire noacquire );
181
188 inline StreamPipe & SAL_CALL operator=(oslPipe Pipe);
189
192 inline StreamPipe& SAL_CALL operator=(const Pipe& pipe);
193
203 inline sal_Int32 SAL_CALL recv(void* pBuffer, sal_Int32 BytesToRead) const;
204
213 inline sal_Int32 SAL_CALL send(const void* pBuffer, sal_Int32 BytesToSend) const;
214
225 inline sal_Int32 SAL_CALL read(void* pBuffer, sal_Int32 n) const;
226
236 sal_Int32 SAL_CALL write(const void* pBuffer, sal_Int32 n) const;
237 };
238
239 }
240 #endif
241
242 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
oslPipe
struct oslPipeImpl * oslPipe
Definition: pipe.h:57
osl::Pipe::clear
void clear()
releases the underlying handle
Definition: pipe.hxx:139
ustring.hxx
osl::Pipe::accept
oslPipeError accept(StreamPipe &Connection)
Accept connection on an existing pipe.
Definition: pipe.hxx:149
osl::StreamPipe::write
sal_Int32 write(const void *pBuffer, sal_Int32 n) const
Writes n bytes from pBuffer to the stream.
Definition: pipe.hxx:200
osl
Definition: condition.hxx:28
osl::StreamPipe::recv
sal_Int32 recv(void *pBuffer, sal_Int32 BytesToRead) const
Tries to receives BytesToRead data from the connected pipe,.
Definition: pipe.hxx:206
security.hxx
osl::Security
Encapsulate security information for one user.
Definition: security_decl.hxx:35
oslPipeOptions
sal_uInt32 oslPipeOptions
Pipe creation options.
Definition: pipe.h:53
osl::StreamPipe
A pipe to send or receive a stream of data.
Definition: pipe_decl.hxx:148
osl::Pipe::~Pipe
~Pipe()
Destructor.
Definition: pipe.hxx:72
osl::StreamPipe::read
sal_Int32 read(void *pBuffer, sal_Int32 n) const
Retrieves n bytes from the stream and copies them into pBuffer.
Definition: pipe.hxx:194
osl::Pipe::is
bool is() const
Definition: pipe.hxx:121
osl::Pipe::operator==
bool operator==(const Pipe &rPipe) const
Definition: pipe.hxx:127
osl::StreamPipe::send
sal_Int32 send(const void *pBuffer, sal_Int32 BytesToSend) const
Tries to sends BytesToSend data from the connected pipe.
Definition: pipe.hxx:212
osl::Pipe::Pipe
Pipe()
Does not create a pipe.
Definition: pipe.hxx:31
osl::StreamPipe::operator=
StreamPipe & operator=(const Pipe &pipe)
Assignment operator.
osl::StreamPipe::StreamPipe
StreamPipe()
Creates an unattached pipe.
Definition: pipe.hxx:171
osl::Pipe::m_handle
oslPipe m_handle
Definition: pipe_decl.hxx:35
__sal_NoAcquire
__sal_NoAcquire
Definition: types.h:371
pipe.h
osl::Pipe::create
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
osl::Pipe
Represents a pipe.
Definition: pipe_decl.hxx:33
osl::Pipe::getError
oslPipeError getError() const
Delivers a constant describing the last error for the pipe system.
Definition: pipe.hxx:159
osl::Pipe::operator=
Pipe & operator=(const Pipe &pipe)
Assignment operator.
Definition: pipe.hxx:93
oslPipeError
oslPipeError
Definition: pipe.h:34
osl::Pipe::close
void close()
Closes the pipe.
Definition: pipe.hxx:133
osl_Pipe_OPEN
#define osl_Pipe_OPEN
Definition: pipe.h:54
osl::Pipe::isValid
bool isValid() const
Checks if the pipe is valid.
osl::StreamPipe::operator=
StreamPipe & operator=(oslPipe Pipe)
Attaches the oslPipe to this object.
osl::Pipe::getHandle
oslPipe getHandle() const
Definition: pipe.hxx:165