office-gobmx/include/osl/pipe.hxx
msrijita18 b1fb6338cf tdf#130978 Added comment to all published API
Change-Id: I744788bde9778f85ccd9d7667e19d16842900a29
Reviewed-on: https://gerrit.libreoffice.org/c/core/+/110248
Tested-by: Jenkins
Reviewed-by: Stephan Bergmann <sbergman@redhat.com>
2021-02-02 20:56:27 +01:00

224 lines
5.3 KiB
C++

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed
* with this work for additional information regarding copyright
* ownership. The ASF licenses this file to you under the Apache
* License, Version 2.0 (the "License"); you may not use this file
* except in compliance with the License. You may obtain a copy of
* the License at http://www.apache.org/licenses/LICENSE-2.0 .
*/
/*
* This file is part of LibreOffice published API.
*/
#ifndef INCLUDED_OSL_PIPE_HXX
#define INCLUDED_OSL_PIPE_HXX
#include "sal/config.h"
#include <cstddef>
#include "osl/pipe_decl.hxx"
namespace osl
{
inline Pipe::Pipe()
: m_handle( NULL )
{}
inline Pipe::Pipe(const ::rtl::OUString& strName, oslPipeOptions Options )
: m_handle( osl_createPipe( strName.pData, Options , NULL ) )
{}
inline Pipe::Pipe(const ::rtl::OUString& strName, oslPipeOptions Options,const Security & rSecurity)
: m_handle( osl_createPipe( strName.pData, Options , rSecurity.getHandle() ) )
{}
inline Pipe::Pipe(const Pipe& pipe )
: m_handle( pipe.m_handle )
{
if( m_handle )
osl_acquirePipe( m_handle );
}
#if defined LIBO_INTERNAL_ONLY
Pipe::Pipe(Pipe && other) noexcept : m_handle(other.m_handle) {
other.m_handle = nullptr;
}
#endif
inline Pipe::Pipe( oslPipe pipe, __sal_NoAcquire )
: m_handle ( pipe )
{}
inline Pipe::Pipe(oslPipe pipe)
: m_handle( pipe )
{
if( m_handle )
osl_acquirePipe( m_handle );
}
inline Pipe::~Pipe()
{
if( m_handle )
osl_releasePipe( m_handle );
}
inline bool Pipe::create( const ::rtl::OUString & strName,
oslPipeOptions Options, const Security &rSec )
{
*this = Pipe( strName, Options, rSec );
return is();
}
inline bool Pipe::create( const ::rtl::OUString & strName, oslPipeOptions Options )
{
*this = Pipe( strName, Options );
return is();
}
inline Pipe& SAL_CALL Pipe::operator= (const Pipe& pipe)
{
*this = pipe.getHandle();
return *this;
}
#if defined LIBO_INTERNAL_ONLY
Pipe & Pipe::operator =(Pipe && other) noexcept {
if (m_handle != nullptr) {
osl_releasePipe(m_handle);
}
m_handle = other.m_handle;
other.m_handle = nullptr;
return *this;
}
#endif
inline Pipe & SAL_CALL Pipe::operator=( oslPipe pipe)
{
if( pipe )
osl_acquirePipe( pipe );
if( m_handle )
osl_releasePipe( m_handle );
m_handle = pipe;
return *this;
}
inline bool SAL_CALL Pipe::is() const
{
return m_handle != NULL;
}
inline bool SAL_CALL Pipe::operator==( const Pipe& rPipe ) const
{
return m_handle == rPipe.m_handle;
}
inline void SAL_CALL Pipe::close()
{
osl_closePipe( m_handle );
}
inline void SAL_CALL Pipe::clear()
{
if( m_handle )
{
osl_releasePipe( m_handle );
m_handle = NULL;
}
}
inline oslPipeError SAL_CALL Pipe::accept(StreamPipe& Connection)
{
Connection = StreamPipe( osl_acceptPipe( m_handle ), SAL_NO_ACQUIRE);
if( Connection.is() )
return osl_Pipe_E_None;
else
return getError();
}
inline oslPipeError SAL_CALL Pipe::getError() const
{
return osl_getLastPipeError( NULL );
}
inline oslPipe SAL_CALL Pipe::getHandle() const
{
return m_handle;
}
inline StreamPipe::StreamPipe(){}
inline StreamPipe::StreamPipe(oslPipe hPipe)
: Pipe( hPipe )
{
}
inline StreamPipe::StreamPipe(const ::rtl::OUString& strName, oslPipeOptions Options, const Security &rSec )
: Pipe( strName, Options , rSec )
{}
inline StreamPipe::StreamPipe(const ::rtl::OUString& strName, oslPipeOptions Options )
: Pipe( strName, Options )
{}
inline StreamPipe::StreamPipe( oslPipe pipe, __sal_NoAcquire noacquire )
: Pipe( pipe , noacquire )
{}
inline sal_Int32 SAL_CALL StreamPipe::read(void* pBuffer, sal_Int32 n) const
{
return osl_readPipe( m_handle, pBuffer, n );
}
inline sal_Int32 SAL_CALL StreamPipe::write(const void* pBuffer, sal_Int32 n) const
{
return osl_writePipe( m_handle, pBuffer , n );
}
inline sal_Int32 SAL_CALL StreamPipe::recv(void* pBuffer, sal_Int32 BytesToRead) const
{
return osl_receivePipe( m_handle, pBuffer , BytesToRead );
}
inline sal_Int32 SAL_CALL StreamPipe::send(const void* pBuffer, sal_Int32 BytesToSend) const
{
return osl_sendPipe( m_handle, pBuffer , BytesToSend );
}
}
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */