LibreOffice LibreOffice 4.3 SDK C/C++ API Reference

- Main Page
- Related Pages
- Namespaces
- Classes
- Files

- File List
- File Members

All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
pipe.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_HXX
20 #define INCLUDED_OSL_PIPE_HXX
21
22 #include <osl/pipe_decl.hxx>
23
24 namespace osl
25 {
26
27 inline Pipe::Pipe()
28 : m_handle( 0 )
29 {}
30
31
32 inline Pipe::Pipe(const ::rtl::OUString& strName, oslPipeOptions Options )
33 : m_handle( osl_createPipe( strName.pData, Options , 0 ) )
34 {}
35
36
37 inline Pipe::Pipe(const ::rtl::OUString& strName, oslPipeOptions Options,const Security & rSecurity)
38 : m_handle( osl_createPipe( strName.pData, Options , rSecurity.getHandle() ) )
39 {}
40
41
42 inline Pipe::Pipe(const Pipe& pipe )
43 : m_handle( pipe.m_handle )
44 {
45 if( m_handle )
46 osl_acquirePipe( m_handle );
47 }
48
49
50 inline Pipe::Pipe( oslPipe pipe, __sal_NoAcquire )
51 : m_handle ( pipe )
52 {}
53
54
55 inline Pipe::Pipe(oslPipe pipe)
56 : m_handle( pipe )
57 {
58 if( m_handle )
59 osl_acquirePipe( m_handle );
60 }
61
62
63 inline Pipe::~Pipe()
64 {
65 if( m_handle )
66 osl_releasePipe( m_handle );
67 }
68
69
70 inline bool Pipe::create( const ::rtl::OUString & strName,
71 oslPipeOptions Options, const Security &rSec )
72 {
73 *this = Pipe( strName, Options, rSec );
74 return is();
75 }
76
77
78 inline bool Pipe::create( const ::rtl::OUString & strName, oslPipeOptions Options )
79 {
80 *this = Pipe( strName, Options );
81 return is();
82 }
83
84 inline Pipe& SAL_CALL Pipe::operator= (const Pipe& pipe)
85 {
86 *this = pipe.getHandle();
87 return *this;
88 }
89
90
91 inline Pipe & SAL_CALL Pipe::operator=( oslPipe pipe)
92 {
93 if( pipe )
94 osl_acquirePipe( pipe );
95 if( m_handle )
96 osl_releasePipe( m_handle );
97 m_handle = pipe;
98 return *this;
99 }
100
101
102 inline bool SAL_CALL Pipe::is() const
103 {
104 return m_handle != 0;
105 }
106
107
108 inline bool SAL_CALL Pipe::operator==( const Pipe& rPipe ) const
109 {
110 return m_handle == rPipe.m_handle;
111 }
112
113
114 inline void SAL_CALL Pipe::close()
115 {
116 osl_closePipe( m_handle );
117 }
118
119
120 inline void SAL_CALL Pipe::clear()
121 {
122 if( m_handle )
123 {
124 osl_releasePipe( m_handle );
125 m_handle = 0;
126 }
127 }
128
129
130 inline oslPipeError SAL_CALL Pipe::accept(StreamPipe& Connection)
131 {
132 Connection = StreamPipe( osl_acceptPipe( m_handle ), SAL_NO_ACQUIRE);
133 if( Connection.is() )
134 return osl_Pipe_E_None;
135 else
136 return getError();
137 }
138
139
140 inline oslPipeError SAL_CALL Pipe::getError() const
141 {
142 return osl_getLastPipeError( 0 );
143 }
144
145
146 inline oslPipe SAL_CALL Pipe::getHandle() const
147 {
148 return m_handle;
149 }
150
151
152 inline StreamPipe::StreamPipe(){}
153
154
155 inline StreamPipe::StreamPipe(oslPipe hPipe)
156 : Pipe( hPipe )
157 {
158 }
159
160
161 inline StreamPipe::StreamPipe(const ::rtl::OUString& strName, oslPipeOptions Options, const Security &rSec )
162 : Pipe( strName, Options , rSec )
163 {}
164
165
166 inline StreamPipe::StreamPipe(const ::rtl::OUString& strName, oslPipeOptions Options )
167 : Pipe( strName, Options )
168 {}
169
170
171 inline StreamPipe::StreamPipe(const StreamPipe& aPipe)
172 : Pipe( aPipe )
173 {}
174
175 inline StreamPipe::StreamPipe( oslPipe pipe, __sal_NoAcquire noacquire )
176 : Pipe( pipe , noacquire )
177 {}
178
179
180 inline sal_Int32 SAL_CALL StreamPipe::read(void* pBuffer, sal_Int32 n) const
181 {
182 return osl_readPipe( m_handle, pBuffer, n );
183 }
184
185
186 inline sal_Int32 SAL_CALL StreamPipe::write(const void* pBuffer, sal_Int32 n) const
187 {
188 return osl_writePipe( m_handle, pBuffer , n );
189 }
190
191
192 inline sal_Int32 SAL_CALL StreamPipe::recv(void* pBuffer, sal_Int32 BytesToRead) const
193 {
194 return osl_receivePipe( m_handle, pBuffer , BytesToRead );
195 }
196
197
198 inline sal_Int32 SAL_CALL StreamPipe::send(const void* pBuffer, sal_Int32 BytesToSend) const
199 {
200 return osl_sendPipe( m_handle, pBuffer , BytesToSend );
201 }
202
203 }
204 #endif
205
206 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
osl::Pipe::getHandle
oslPipe getHandle() const
Definition: pipe.hxx:146
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:70
osl::Pipe::is
bool is() const
Definition: pipe.hxx:102
pipe_decl.hxx
osl_getLastPipeError
SAL_DLLPUBLIC oslPipeError osl_getLastPipeError(oslPipe Pipe)
osl_Pipe_E_None
Definition: pipe.h:35
oslPipeError
oslPipeError
Definition: pipe.h:34
osl_readPipe
SAL_DLLPUBLIC sal_Int32 osl_readPipe(oslPipe Pipe, void *pBuffer, sal_Int32 BufferSize)
Reads blocking from the pipe.
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:198
osl::Pipe::operator=
Pipe & operator=(const Pipe &pipe)
Assignment operator.
Definition: pipe.hxx:84
oslPipeOptions
sal_uInt32 oslPipeOptions
Definition: pipe.h:49
SAL_NO_ACQUIRE
definition of a no acquire enum for ctors
Definition: types.h:388
osl_acceptPipe
SAL_DLLPUBLIC oslPipe osl_acceptPipe(oslPipe Pipe)
osl_createPipe
SAL_DLLPUBLIC oslPipe osl_createPipe(rtl_uString *strPipeName, oslPipeOptions Options, oslSecurity Security)
osl_sendPipe
SAL_DLLPUBLIC sal_Int32 osl_sendPipe(oslPipe Pipe, const void *pBuffer, sal_Int32 BufferSize)
__sal_NoAcquire
__sal_NoAcquire
Definition: types.h:384
osl::Pipe
Represents a pipe.
Definition: pipe_decl.hxx:32
osl::StreamPipe::StreamPipe
StreamPipe()
Creates an unattached pipe.
Definition: pipe.hxx:152
osl::StreamPipe::write
sal_Int32 write(const void *pBuffer, sal_Int32 n) const
Writes n bytes from pBuffer to the stream.
Definition: pipe.hxx:186
osl::Pipe::clear
void clear()
releases the underlying handle
Definition: pipe.hxx:120
osl::StreamPipe::recv
sal_Int32 recv(void *pBuffer, sal_Int32 BytesToRead) const
Tries to receives BytesToRead data from the connected pipe,.
Definition: pipe.hxx:192
osl::Pipe::operator==
bool operator==(const Pipe &rPipe) const
Definition: pipe.hxx:108
osl
Definition: conditn.hxx:30
osl::Security
capsulate security information for one user.
Definition: security_decl.hxx:34
osl_writePipe
SAL_DLLPUBLIC sal_Int32 osl_writePipe(oslPipe Pipe, const void *pBuffer, sal_Int32 BufferSize)
Writes blocking onto the pipe.
osl::Pipe::accept
oslPipeError accept(StreamPipe &Connection)
Accept connection on an existing pipe.
Definition: pipe.hxx:130
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:180
osl::Pipe::close
void close()
Closes the pipe.
Definition: pipe.hxx:114
osl_releasePipe
SAL_DLLPUBLIC void osl_releasePipe(oslPipe)
decreases the refcount of the pipe.
osl_closePipe
SAL_DLLPUBLIC void osl_closePipe(oslPipe)
closes the pipe, any read,write or accept actions stop immeadiatly.
osl::Pipe::m_handle
oslPipe m_handle
Definition: pipe_decl.hxx:35
osl::Pipe::Pipe
Pipe()
Does not create a pipe.
Definition: pipe.hxx:27
osl::Pipe::~Pipe
~Pipe()
Destructor.
Definition: pipe.hxx:63
osl::Pipe::getError
oslPipeError getError() const
Delivers a constant decribing the last error for the pipe system.
Definition: pipe.hxx:140
osl_receivePipe
SAL_DLLPUBLIC sal_Int32 osl_receivePipe(oslPipe Pipe, void *pBuffer, sal_Int32 BufferSize)
osl::StreamPipe
A pipe to send or receive a stream of data.
Definition: pipe_decl.hxx:139
osl_acquirePipe
SAL_DLLPUBLIC void osl_acquirePipe(oslPipe Pipe)
increases the refcount of the pipe.
oslPipe
struct oslPipeImpl * oslPipe
Definition: pipe.h:53