QuantumGate::Local

QuantumGate::Local is a class that represents a local instance of QuantumGate. You can see it as the local node in a network of many connected peers. This class allows you to configure and manage the local node in the QuantumGate network.

Member functions

General

Name	Description
Constructor	Constructs a QuantumGate::Local object.
GetVersion	Gets the QuantumGate module version.
GetVersionString	Gets the QuantumGate module version in string format.
GetProtocolVersion	Gets the QuantumGate protocol version.
GetProtocolVersionString	Gets the QuantumGate protocol version in string format.
GetUUID	Gets the peer UUID of the local node.
GetEnvironment	Gets details about the local environment.
FreeUnusedMemory	Releases unused memory from the memory pools used by the instance.

Control

Name	Description
Startup	Starts the instance of QuantumGate.
Shutdown	Shuts down the instance of QuantumGate.
IsRunning	Returns whether the instance is running.
EnableListeners	Enables and starts the listeners for the instance.
DisableListeners	Shuts down and disables the listeners for the instance.
AreListenersEnabled	Returns whether the listeners are enabled for the instance.
EnableExtenders	Enables and starts the extenders for the instance.
DisableExtenders	Shuts down and disables the extenders for the instance.
AreExtendersEnabled	Returns whether extenders are enabled for the instance.
EnableRelays	Enables relayed connections for the instance.
DisableRelays	Disables relayed connections for the instance.
AreRelaysEnabled	Returns whether relayed connections are enabled for the instance.

Extenders

Name	Description
AddExtender	Adds an extender to the instance.
RemoveExtender	Removes an extender from the instance.
AddExtenderModule	Adds an extender module to the instance with all its extenders.
RemoveExtenderModule	Removes an extender module from the instance with all its extenders.
HasExtender	Returns whether the instance has a specific extender.
GetExtender	Returns a pointer to an extender in the instance.

Peers

Name	Description
ConnectTo	Initiates a connection to a peer on the network.
DisconnectFrom	Initiates disconnection from a peer on the network.
QueryPeers	Returns a collection of peers on the instance based on custom criteria.
GetPeer	Returns a peer on the local instance.

Access and Security

Name	Description
GetAccessManager	Returns a reference to the Access Manager for the instance.
SetSecurityLevel	Sets the security level for the instance.
GetSecurityLevel	Returns the current security level for the instance.
GetSecurityParameters	Returns the current security parameters for the instance.