path: root/src/core/hle/kernel/client_port.h

// Copyright 2016 Citra Emulator Project
// Licensed under GPLv2 or any later version
// Refer to the license.txt file included.

#pragma once

#include <string>
#include "common/common_types.h"
#include "core/hle/kernel/kernel.h"

namespace Kernel {

class ServerPort;
class ClientSession;

class ClientPort final : public Object {
public:
    friend class ServerPort;
    std::string GetTypeName() const override {
        return "ClientPort";
    }
    std::string GetName() const override {
        return name;
    }

    static const HandleType HANDLE_TYPE = HandleType::ClientPort;
    HandleType GetHandleType() const override {
        return HANDLE_TYPE;
    }

    /**
     * Creates a new Session pair, adds the created ServerSession to the associated ServerPort's list of pending sessions,
     * and signals the ServerPort, causing any threads waiting on it to awake.
     * @returns ClientSession The client endpoint of the created Session pair.
     */
    SharedPtr<ClientSession> Connect();

    SharedPtr<ServerPort> server_port; ///< ServerPort associated with this client port.
    u32 max_sessions;    ///< Maximum number of simultaneous sessions the port can have
    u32 active_sessions; ///< Number of currently open sessions to this port
    std::string name;    ///< Name of client port (optional)

private:
    ClientPort();
    ~ClientPort() override;
};

} // namespace