QuantumGate Types

Below is a listing of the types used in the QuantumGate API. To work with these types in your project simply #include the QuantumGate.h file located in the QuantumGateLib\API subfolder.

Classes

Name	Description
QuantumGate::Address	Represents a network address.
QuantumGate::Access::Manager	Represents the Access Manager through which various access settings of a QuantumGate instance can be configured.
QuantumGate::Buffer	Represents a buffer of data.
QuantumGate::BTHAddress	Represents a Bluetooth address.
QuantumGate::BTHEndpoint	Represents a Bluetooth endpoint.
QuantumGate::Callback	Represents a callback function.
QuantumGate::Console	Represents the console of a QuantumGate instance.
QuantumGate::Endpoint	Represents a network endpoint.
QuantumGate::Extender	Represents a QuantumGate extender.
QuantumGate::Extender::PeerEvent	Represents a peer event for an extender.
QuantumGate::ExtenderUUID	A typedef for QuantumGate::UUID.
QuantumGate::IPAddress	Represents an IP address.
QuantumGate::IPEndpoint	Represents an IP endpoint.
QuantumGate::Local	Represents a local QuantumGate instance.
QuantumGate::Local::Environment	Represents the local running environment of a QuantumGate instance.
QuantumGate::Path	A typedef for std::filesystem::path.
QuantumGate::Peer	Represents a peer on the local QuantumGate instance.
QuantumGate::PeerUUID	A typedef for QuantumGate::UUID.
QuantumGate::ProtectedBuffer	Represents a buffer of sensitive data and uses a special memory allocator which locks memory and prevents it from being swapped to disk, while also erasing memory after being used.
QuantumGate::Result	Represents a return value from a function or operation.
QuantumGate::Set	A typedef for std::set.
QuantumGate::String	A typedef for std::wstring.
QuantumGate::StringView	A typedef for std::wstring_view.
QuantumGate::UUID	Represents a Universally Unique Identifier on the QuantumGate network.
QuantumGate::Vector	A typedef for std::vector.

Structs

Name	Description
QuantumGate::Access::AddressReputation	Contains details about the reputation of an address.
QuantumGate::Access::IPFilter	Contains details about an IP filter used to configure access.
QuantumGate::Access::IPSubnetLimit	Contains details about an IP subnet limit used to configure access.
QuantumGate::Access::PeerAccessSettings	Contains access settings for a peer.
QuantumGate::Algorithms	Contains sets of algorithms.
QuantumGate::BinaryBTHAddress	Contains details about a Bluetooth address.
QuantumGate::BinaryIPAddress	Contains details about an IP address.
QuantumGate::BluetoothServiceDetails	Contains Bluetooth service details advertised by a local instance of QuantumGate.
QuantumGate::ConnectParameters	Contains parameters used to connect to another peer.
QuantumGate::Extender::PeerEvent::Result	Contains the result of processing a peer event.
QuantumGate::Local::Environment::AddressDetails	Contains details about an address.
QuantumGate::Local::Environment::BluetoothDevice	Contains details about a Bluetooth device.
QuantumGate::Local::Environment::BluetoothRadio	Contains details about a Bluetooth radio.
QuantumGate::Local::Environment::EthernetInterface	Contains details about an Ethernet interface.
QuantumGate::Local::Environment::PublicAddressDetails	Contains public details for an address.
QuantumGate::Peer::ConnectionAlgorithms	Contains details about the algorithms used during a connection to a peer.
QuantumGate::Peer::Details	Contains details about a peer.
QuantumGate::PeerKeys	Contains a public and private key-pair for a peer.
QuantumGate::PeerQueryParameters	Used to query a QuantumGate instance for peers.
QuantumGate::SecurityParameters	Used to change or retrieve the security settings of a QuantumGate instance.
QuantumGate::SendParameters	Contains settings for sending data to another peer on the network.
QuantumGate::StartupParameters	Contains parameters used to start a local instance of QuantumGate.

Enums

QuantumGate::Address::Family

Value	Description
QuantumGate::Address::Family::Unspecified	Indicates an unspecified address family.
QuantumGate::Address::Family::IPv4	Indicates the IPv4 address family.
QuantumGate::Address::Family::IPv6	Indicates the IPv6 address family.
QuantumGate::Address::Family::BTH	Indicates the Bluetooth address family.

---

QuantumGate::Address::Type

Value	Description
QuantumGate::Address::Type::Unspecified	Indicates an unspecified address type.
QuantumGate::Address::Type::IP	Indicates an IP address.
QuantumGate::Address::Type::BTH	Indicates a Bluetooth address.

---

QuantumGate::Access::CheckType

Value	Description
QuantumGate::Access::CheckType::AddressReputations	Checks access based on the address reputation.
QuantumGate::Access::CheckType::IPFilters	Checks access based on the configured IP filters.
QuantumGate::Access::CheckType::IPSubnetLimits	Checks access based on the configured subnet limits.
QuantumGate::Access::CheckType::All	Checks access based on all the above.

---

QuantumGate::Access::IPFilterType

Value	Description
QuantumGate::Access::IPFilterType::Allowed	Indicates that the filter allows access.
QuantumGate::Access::IPFilterType::Blocked	Indicates that the filter blocks access.

---

QuantumGate::Access::PeerAccessDefault

Value	Description
QuantumGate::Access::PeerAccessDefault::Allowed	Indicates that peers should be allowed access by default.
QuantumGate::Access::PeerAccessDefault::NotAllowed	Indicates that peers should be denied access by default.

---

QuantumGate::Algorithm::Asymmetric

---

QuantumGate::Algorithm::Compression

---

QuantumGate::Algorithm::Hash

---

QuantumGate::Algorithm::Symmetric

---

QuantumGate::BTHAddress::Family

Value	Description
QuantumGate::BTHAddress::Family::Unspecified	Indicates an unspecified address type.
QuantumGate::BTHAddress::Family::BTH	Indicates Bluetooth address.

---

QuantumGate::BTHEndpoint::Protocol

Value	Description
QuantumGate::BTHEndpoint::Protocol::Unspecified	Indicates an unspecified protocol.
QuantumGate::BTHEndpoint::Protocol::RFCOMM	Indicates an endpoint using the RFCOMM protocol.

---

QuantumGate::Console::MessageType

Value	Description
QuantumGate::Console::MessageType::Error	Indicates an error message.
QuantumGate::Console::MessageType::Warning	Indicates a warning.
QuantumGate::Console::MessageType::System	Indicates a system message.
QuantumGate::Console::MessageType::Info	Indicates normal information.
QuantumGate::Console::MessageType::Debug	Indicates debug information.

---

QuantumGate::Console::Verbosity

Value	Description
QuantumGate::Console::Verbosity::Silent	No console messages are displayed.
QuantumGate::Console::Verbosity::Minimal	Only errors and warnings are displayed.
QuantumGate::Console::Verbosity::Normal	Errors, warnings and system messages are displayed.
QuantumGate::Console::Verbosity::Verbose	Errors, warnings, system and info messages are displayed.
QuantumGate::Console::Verbosity::Debug	Errors, warnings, system, info and debug messages are displayed.

---

QuantumGate::Endpoint::AddressFamily

Value	Description
QuantumGate::Endpoint::AddressFamily::Unspecified	Indicates an unspecified address family.
QuantumGate::Endpoint::AddressFamily::IPv4	Indicates the IPv4 address family.
QuantumGate::Endpoint::AddressFamily::IPv6	Indicates the IPv6 address family.
QuantumGate::Endpoint::AddressFamily::BTH	Indicates the Bluetooth address family.

---

QuantumGate::Endpoint::Protocol

Value	Description
QuantumGate::Endpoint::Protocol::Unspecified	Indicates an unspecified protocol.
QuantumGate::Endpoint::Protocol::ICMP	Indicates the ICMP protocol.
QuantumGate::Endpoint::Protocol::TCP	Indicates the TCP protocol.
QuantumGate::Endpoint::Protocol::UDP	Indicates the UDP protocol.
QuantumGate::Endpoint::Protocol::RFCOMM	Indicates the RFCOMM Bluetooth protocol.

---

QuantumGate::Endpoint::Type

Value	Description
QuantumGate::Endpoint::Type::Unspecified	Indicates an unspecified endpoint type.
QuantumGate::Endpoint::Type::IP	Indicates an IP endpoint.
QuantumGate::Endpoint::Type::BTH	Indicates a Bluetooth endpoint.

---

QuantumGate::Extender::PeerEvent::Type

Value	Description
QuantumGate::Extender::PeerEvent::Type::Unknown	Indicates an unknown event.
QuantumGate::Extender::PeerEvent::Type::Connected	Indicates a connect event.
QuantumGate::Extender::PeerEvent::Type::Suspended	Indicates a suspend event.
QuantumGate::Extender::PeerEvent::Type::Resumed	Indicates a resume (from suspended) event.
QuantumGate::Extender::PeerEvent::Type::Disconnected	Indicates a disconnect event.
QuantumGate::Extender::PeerEvent::Type::Message	Indicates a message event.

---

QuantumGate::IPAddress::Family

Value	Description
QuantumGate::IPAddress::Family::Unspecified	Indicates an unspecified address type.
QuantumGate::IPAddress::Family::IPv4	Indicates an IP version 4 address.
QuantumGate::IPAddress::Family::IPv6	Indicates an IP version 6 address.

---

QuantumGate::IPEndpoint::Protocol

Value	Description
QuantumGate::IPEndpoint::Protocol::Unspecified	Indicates an unspecified protocol.
QuantumGate::IPEndpoint::Protocol::ICMP	Indicates an endpoint using the ICMP protocol.
QuantumGate::IPEndpoint::Protocol::TCP	Indicates an endpoint using the TCP protocol.
QuantumGate::IPEndpoint::Protocol::UDP	Indicates an endpoint using the UDP protocol.

---

QuantumGate::Local::ListenerType

Value	Description
QuantumGate::Local::ListenerType::TCP	Specifies TCP listeners.
QuantumGate::Local::ListenerType::UDP	Specifies UDP listeners.
QuantumGate::Local::ListenerType::BTH	Specifies BTH (Bluetooth) listeners.

---

QuantumGate::PeerConnectionType

Value	Description
QuantumGate::PeerConnectionType::Unknown	Indicates an unknown connection type.
QuantumGate::PeerConnectionType::Inbound	Indicates an inbound connection.
QuantumGate::PeerConnectionType::Outbound	Indicates an outbound connection.

---

QuantumGate::ResultCode

Value
QuantumGate::ResultCode::Succeeded
QuantumGate::ResultCode::Failed
QuantumGate::ResultCode::FailedRetry
QuantumGate::ResultCode::NotRunning
QuantumGate::ResultCode::InvalidArgument
QuantumGate::ResultCode::NotAllowed
QuantumGate::ResultCode::TimedOut
QuantumGate::ResultCode::Aborted
QuantumGate::ResultCode::OutOfMemory
QuantumGate::ResultCode::FailedTCPListenerManagerStartup
QuantumGate::ResultCode::FailedPeerManagerStartup
QuantumGate::ResultCode::FailedRelayManagerStartup
QuantumGate::ResultCode::FailedExtenderManagerStartup
QuantumGate::ResultCode::FailedKeyGenerationManagerStartup
QuantumGate::ResultCode::FailedUDPConnectionManagerStartup
QuantumGate::ResultCode::FailedUDPListenerManagerStartup
QuantumGate::ResultCode::FailedBluetoothListenerManagerStartup
QuantumGate::ResultCode::NoPeersForRelay
QuantumGate::ResultCode::PeerNotFound
QuantumGate::ResultCode::PeerNotReady
QuantumGate::ResultCode::PeerNoExtender
QuantumGate::ResultCode::PeerAlreadyExists
QuantumGate::ResultCode::PeerSendBufferFull
QuantumGate::ResultCode::PeerSuspended
QuantumGate::ResultCode::AddressInvalid
QuantumGate::ResultCode::AddressMaskInvalid
QuantumGate::ResultCode::AddressNotFound
QuantumGate::ResultCode::ExtenderNotFound
QuantumGate::ResultCode::ExtenderAlreadyPresent
QuantumGate::ResultCode::ExtenderObjectDifferent
QuantumGate::ResultCode::ExtenderAlreadyRemoved
QuantumGate::ResultCode::ExtenderTooMany
QuantumGate::ResultCode::ExtenderHasNoLocalInstance
QuantumGate::ResultCode::ExtenderModuleAlreadyPresent
QuantumGate::ResultCode::ExtenderModuleLoadFailure
QuantumGate::ResultCode::ExtenderModuleNotFound

---

QuantumGate::UUID::SignAlgorithm

Value	Description
QuantumGate::UUID::SignAlgorithm::None	No algorithm.
QuantumGate::UUID::SignAlgorithm::EDDSA_ED25519	The ED25519 algorithm.
QuantumGate::UUID::SignAlgorithm::EDDSA_ED448	The ED448 algorithm.

---

QuantumGate::UUID::Type

Value	Description
QuantumGate::UUID::Type::Unknown	Indicates an unknown type.
QuantumGate::UUID::Type::Peer	Indicates a peer UUID.
QuantumGate::UUID::Type::Extender	Indicates an extender UUID.

---

QuantumGate::SecurityLevel

Value	Description
QuantumGate::SecurityLevel::One	The first security level.
QuantumGate::SecurityLevel::Two	The second security level.
QuantumGate::SecurityLevel::Three	The third security level.
QuantumGate::SecurityLevel::Four	The fourth security level.
QuantumGate::SecurityLevel::Five	The fifth security level.
QuantumGate::SecurityLevel::Custom	A custom security level.

Other

Name	Description
QuantumGate::Access::IPFilterID	A typedef for QuantumGate::UInt64.
QuantumGate::Byte	A typedef for std::byte.
QuantumGate::Char	A typedef for char.
QuantumGate::UChar	A typedef for unsigned char.
QuantumGate::WChar	A typedef for wchar_t.
QuantumGate::Int	A typedef for int.
QuantumGate::UInt	A typedef for unsigned int.
QuantumGate::Int8	A typedef for std::int8_t.
QuantumGate::UInt8	A typedef for std::uint8_t.
QuantumGate::Int16	A typedef for std::int16_t.
QuantumGate::UInt16	A typedef for std::uint16_t.
QuantumGate::Int32	A typedef for std::int32_t.
QuantumGate::UInt32	A typedef for std::uint32_t.
QuantumGate::Int64	A typedef for std::int64_t.
QuantumGate::UInt64	A typedef for std::uint64_t.
QuantumGate::RelayPort	A typedef for QuantumGate::UInt64.
QuantumGate::RelayHop	A typedef for QuantumGate::UInt8.
QuantumGate::PeerLUID	A typedef for QuantumGate::UInt64.
QuantumGate::Size	A typedef for std::size_t.