pipe_decl.hxx

Go to the documentation of this file.

/* -*- 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_DECL_HXX
#define INCLUDED_OSL_PIPE_DECL_HXX

#include "osl/pipe.h"
#include "osl/security.hxx"
#include "rtl/ustring.hxx"

namespace osl
{
class StreamPipe;

class Pipe
{
protected:
    oslPipe m_handle;

public:
    inline Pipe();

    inline Pipe(const ::rtl::OUString& strName, oslPipeOptions Options);

    inline Pipe(const ::rtl::OUString& strName, oslPipeOptions Options, const Security& rSecurity);

    inline Pipe(const Pipe& pipe);

#if defined LIBO_INTERNAL_ONLY
    inline Pipe(Pipe&& other) noexcept;
#endif

    inline Pipe(oslPipe pipe, __sal_NoAcquire noacquire);

    inline Pipe(oslPipe Pipe);

    inline ~Pipe();

    inline bool SAL_CALL is() const;

    inline bool create(const ::rtl::OUString& strName, oslPipeOptions Options,
                       const Security& rSec);

    inline bool create(const ::rtl::OUString& strName, oslPipeOptions Options = osl_Pipe_OPEN);

    inline void SAL_CALL clear();

    inline Pipe& SAL_CALL operator=(const Pipe& pipe);

#if defined LIBO_INTERNAL_ONLY
    inline Pipe& operator=(Pipe&& other) noexcept;
#endif

    inline Pipe& SAL_CALL operator=(const oslPipe pipe);

    inline bool SAL_CALL isValid() const;

    inline bool SAL_CALL operator==(const Pipe& rPipe) const;

    inline void SAL_CALL close();

    inline oslPipeError SAL_CALL accept(StreamPipe& Connection);

    inline oslPipeError SAL_CALL getError() const;

    inline oslPipe SAL_CALL getHandle() const;
};

class StreamPipe : public Pipe
{
public:
    inline StreamPipe();

    inline StreamPipe(oslPipe Pipe);

    inline StreamPipe(const ::rtl::OUString& strName, oslPipeOptions Options = osl_Pipe_OPEN);

    inline StreamPipe(const ::rtl::OUString& strName, oslPipeOptions Options, const Security& rSec);

    inline StreamPipe(oslPipe pipe, __sal_NoAcquire noacquire);

    inline StreamPipe& SAL_CALL operator=(oslPipe Pipe);

    inline StreamPipe& SAL_CALL operator=(const Pipe& pipe);

    inline sal_Int32 SAL_CALL recv(void* pBuffer, sal_Int32 BytesToRead) const;

    inline sal_Int32 SAL_CALL send(const void* pBuffer, sal_Int32 BytesToSend) const;

    inline sal_Int32 SAL_CALL read(void* pBuffer, sal_Int32 n) const;

    sal_Int32 SAL_CALL write(const void* pBuffer, sal_Int32 n) const;
};
}
#endif

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */