mirror of
https://github.com/baldurk/renderdoc.git
synced 2026-05-04 17:10:47 +00:00
baldurk
0b527fab49
* This is to support python bindings - the pyside implementation of QVector, QString, etc is not available to SWIG, so SWIG treates these all as opaque types. * Rather than trying to set up bindings that work for rdcarray and QList/QVector, or implementing separate bindings, we instead just say that the public interface must use the rdc types. In most cases they seamlessly convert to/from Qt types anyway. * In a couple of places we use an array of pairs instead of a map. In future we probably want an rdcdict or rdcmap with proper dict bindings in python.
75 lines
3.0 KiB
C++
75 lines
3.0 KiB
C++
/******************************************************************************
|
|
* The MIT License (MIT)
|
|
*
|
|
* Copyright (c) 2017 Baldur Karlsson
|
|
*
|
|
* Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
* of this software and associated documentation files (the "Software"), to deal
|
|
* in the Software without restriction, including without limitation the rights
|
|
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
* copies of the Software, and to permit persons to whom the Software is
|
|
* furnished to do so, subject to the following conditions:
|
|
*
|
|
* The above copyright notice and this permission notice shall be included in
|
|
* all copies or substantial portions of the Software.
|
|
*
|
|
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
|
* THE SOFTWARE.
|
|
******************************************************************************/
|
|
|
|
#pragma once
|
|
|
|
class RemoteHost;
|
|
|
|
// do not include any headers here, they must all be in QRDInterface.h
|
|
#include "QRDInterface.h"
|
|
|
|
DOCUMENT("A handle for interacting with a remote servers on a given host.");
|
|
class RemoteHost
|
|
{
|
|
public:
|
|
RemoteHost();
|
|
|
|
VARIANT_CAST(RemoteHost);
|
|
|
|
DOCUMENT(
|
|
"Ping the host to check current status - if the server is running, connection status, etc.");
|
|
void CheckStatus();
|
|
DOCUMENT("Runs the command specified in :data:`RunCommand`.");
|
|
void Launch();
|
|
|
|
DOCUMENT("``True`` if a remote server is currently running on this host.");
|
|
bool ServerRunning : 1;
|
|
DOCUMENT("``True`` if an active connection exists to this remote server.");
|
|
bool Connected : 1;
|
|
DOCUMENT("``True`` if someone else is currently connected to this server.");
|
|
bool Busy : 1;
|
|
DOCUMENT("``True`` if there is a code version mismatch with this server.");
|
|
bool VersionMismatch : 1;
|
|
|
|
DOCUMENT("The hostname of this host.");
|
|
rdcstr Hostname;
|
|
DOCUMENT("The friendly name for this host, if available (if empty, the Hostname is used).");
|
|
rdcstr FriendlyName;
|
|
DOCUMENT("The command to run locally to try to launch the server remotely.");
|
|
rdcstr RunCommand;
|
|
|
|
DOCUMENT(R"(
|
|
Returns the name to display for this host in the UI, either :data:`FriendlyName` or :data:`Hostname`
|
|
)");
|
|
const rdcstr &Name() const { return !FriendlyName.isEmpty() ? FriendlyName : Hostname; }
|
|
DOCUMENT("Returns ``True`` if this host represents a connected ADB (Android) device.");
|
|
bool IsHostADB() const
|
|
{
|
|
return Hostname[0] == 'a' && Hostname[1] == 'd' && Hostname[2] == 'b' && Hostname[3] == ':';
|
|
}
|
|
DOCUMENT("Returns ``True`` if this host represents the special localhost device.");
|
|
bool IsLocalhost() const { return Hostname == "localhost"; }
|
|
};
|
|
|
|
DECLARE_REFLECTION_STRUCT(RemoteHost); |