Skip to content

QuantumGate::SendParameters

Karel Donk edited this page Dec 10, 2019 · 2 revisions

QuantumGate::SendParameters is a struct that contains settings for sending data to another peer on the network.

Definition

struct SendParameters
{
    enum class PriorityOption : UInt8
    {
        Normal, Expedited, Delayed
    };

    bool Compress{ true };
    PriorityOption Priority{ PriorityOption::Normal };
    std::chrono::milliseconds Delay{ 0 };
};

Member variables

Name Description
Compress A bool value indicating whether QuantumGate should compress the data before sending it (true) or not (false). The default value is true.
Priority A SendParameters::PriorityOption value indicating the priority QuantumGate should use to send the data.

If this value is Expedited QuantumGate will try to send the data before any other data with lesser priority (Normal and Delayed).

If this value is Delayed QuantumGate will send the data after the amount of time specified in the Delay value. In addition Delayed data gets sent after data with Normal and Expedited priority.

When sending data with real-time delivery requirements, such as Audio and Video streaming, using the Expedited priority setting is recommended. The default value is Normal.
Delay The number of milliseconds QuantumGate should wait before sending the data. This value is only used when the Priority is set to PriorityOption::Delayed. The default value is 0 milliseconds.
Clone this wiki locally