Phosphor
Qt6 / Wayland library suite for window-management tools
Loading...
Searching...
No Matches
PhosphorChannel::Stream::Options Struct Reference

#include <PhosphorChannel/Stream.h>

Public Attributes

std::size_t window = std::size_t(4) << 20
 The window, in bytes, that this end grants each channel that it reads.
std::size_t fragment = 16 * 1024
 The largest fragment that this end sends: 1 KiB to 1 MiB.
std::size_t maxChannels = 64
 The most channels that the other end may have open at once.
std::uint32_t maxChannelId = 4096
 The ids of the channels that the other end opens are below this.

Member Data Documentation

◆ fragment

std::size_t PhosphorChannel::Stream::Options::fragment = 16 * 1024

The largest fragment that this end sends: 1 KiB to 1 MiB.

◆ maxChannelId

std::uint32_t PhosphorChannel::Stream::Options::maxChannelId = 4096

The ids of the channels that the other end opens are below this.

An ended channel keeps a small record until its id opens again, so this bounds what the other end can make this end keep. At least 1.

◆ maxChannels

std::size_t PhosphorChannel::Stream::Options::maxChannels = 64

The most channels that the other end may have open at once.

At least 1.

◆ window

std::size_t PhosphorChannel::Stream::Options::window = std::size_t(4) << 20

The window, in bytes, that this end grants each channel that it reads.

The largest frame of such a channel is the window less FrameCost. It also caps the window that this end uses on a channel that it writes, whatever the other end grants. At least MinWindow. The other end can make this end hold up to maxChannels times the window in frames, plus what the allocator rounds up.


The documentation for this struct was generated from the following file:
  • phosphor-channel/include/PhosphorChannel/Stream.h