-
Notifications
You must be signed in to change notification settings - Fork 23
QuantumGate::Local::AddExtender
Karel Donk edited this page Oct 7, 2018
·
5 revisions
Adds an extender to the instance. If the instance is running, the extender is started after having been successfully added.
Result<bool> AddExtender(const std::shared_ptr<Extender>& extender) noexcept;
Name | Description |
---|---|
extender |
A std::shared_ptr to an object derived from the QuantumGate::Extender class. See QuantumGate::Extender for details. |
Returns a QuantumGate::Result
object equal to one of the following QuantumGate::ResultCode
s:
Value | Description |
---|---|
QuantumGate::ResultCode::Succeeded |
The operation succeeded. |
QuantumGate::ResultCode::Failed |
The operation failed. |
QuantumGate::ResultCode::InvalidArgument |
The argument was invalid. |
QuantumGate::ResultCode::ExtenderAlreadyPresent |
The operation failed because the extender is already present (it may have been added previously). |
QuantumGate::ResultCode::ExtenderTooMany |
The operation failed because the maximum number of extenders has been reached. |
Upon successful completion the result will also contain a bool
value indicating whether or not the extender was successfully started (true
if so). The extender is only started when the QuantumGate instance is running. If the instance wasn't running, the extender will be started when the instance gets started.