/****************************************************************************
**
** Copyright (C) 2008-2012 NVIDIA Corporation.
** Copyright (C) 2017 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of Qt 3D Studio.
**
** $QT_BEGIN_LICENSE:GPL$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3 or (at your option) any later version
** approved by the KDE Free Qt Foundation. The licenses are as published by
** the Free Software Foundation and appearing in the file LICENSE.GPL3
** included in the packaging of this file. Please review the following
** information to ensure the GNU General Public License requirements will
** be met: https://www.gnu.org/licenses/gpl-3.0.html.
**
** $QT_END_LICENSE$
**
****************************************************************************/

#ifndef QT3DS_FAST_IPC_H
#define QT3DS_FAST_IPC_H

#include "foundation/Qt3DSSimpleTypes.h"
#include "foundation/Qt3DSIPC.h"

namespace qt3ds {
namespace foundation {

    NVIPC *createFastIPC(
        NVIPC::ErrorCode &errorCode, // error code return if creation fails
        NVIPC::ConnectionType connectionType =
            NVIPC::CT_CLIENT_OR_SERVER, // how to establish the connection
        const char *mappingObject = "Global\\FastIPC", // Name of communications channel
        QT3DSU32 serverRingBufferSize = 1024 * 4, // buffer size for outgoing server messages.
        QT3DSU32 clientRingBufferSize = 1024 * 4, // buffer size for incoming client messages.
        bool allowLongMessages = true,
        bool bufferSends = false,
        QT3DSU32 maxBufferSendSize = 1024 * 8); // True if we want to buffer sends, if true, then
                                             // pumpSendBuffers should be called by the send thread.

    void releaseFastIPC(NVIPC *f);

}; // end of namespace
}; // end of namespace

#endif