NSwarm::TChannelFlags

Flags that define the intended behavior of the channel.

Choose your operating system:

Windows

macOS

Linux

References

Module

SwarmInterface

Header

/Engine/Source/Editor/SwarmInterface/Public/SwarmDefines.h

Include

#include "SwarmDefines.h"

Syntax

namespace NSwarm
{
    enum TChannelFlags
    {
        SWARM_CHANNEL_TYPE_PERSISTENT            = 0x00000001,
        SWARM_CHANNEL_TYPE_JOB_ONLY              = 0x00000002,
        SWARM_CHANNEL_TYPE_MASK                  = 0x0000000F,
        SWARM_CHANNEL_ACCESS_READ                = 0x00000010,
        SWARM_CHANNEL_ACCESS_WRITE               = 0x00000020,
        SWARM_CHANNEL_ACCESS_MASK                = 0x000000F0,
        SWARM_CHANNEL_READ                       = SWARM_CHANNEL_TYPE_PERSISTENT | SWARM_CHANNEL_ACCESS_READ,
        SWARM_CHANNEL_WRITE                      = SWARM_CHANNEL_TYPE_PERSISTENT | SWARM_CHANNEL_ACCESS_WRITE,
        SWARM_JOB_CHANNEL_READ                   = SWARM_CHANNEL_TYPE_JOB_ONLY | SWARM_CHANNEL_ACCESS_READ,
        SWARM_JOB_CHANNEL_WRITE                  = SWARM_CHANNEL_TYPE_JOB_ONLY | SWARM_CHANNEL_ACCESS_WRITE,
        SWARM_CHANNEL_MISC_ENABLE_PAPER_TRAIL    = 0x00010000,
        SWARM_CHANNEL_MISC_ENABLE_COMPRESSION    = 0x00020000,
        SWARM_CHANNEL_MISC_MASK                  = 0x000F0000,
    }
}

Values

Name

Description

SWARM_CHANNEL_TYPE_PERSISTENT

SWARM_CHANNEL_TYPE_JOB_ONLY

SWARM_CHANNEL_TYPE_MASK

SWARM_CHANNEL_ACCESS_READ

SWARM_CHANNEL_ACCESS_WRITE

SWARM_CHANNEL_ACCESS_MASK

SWARM_CHANNEL_READ

The combinations we care about are easiest to just special case here.

SWARM_CHANNEL_WRITE

SWARM_JOB_CHANNEL_READ

SWARM_JOB_CHANNEL_WRITE

SWARM_CHANNEL_MISC_ENABLE_PAPER_TRAIL

Any additional flags for debugging or extended features.

SWARM_CHANNEL_MISC_ENABLE_COMPRESSION

SWARM_CHANNEL_MISC_MASK

Remarks

Flags that define the intended behavior of the channel. The most important of which are whether the channel is read or write, and whether it's a general, persistent cache channel, or whether it's a job-specific channel. Additional misc flags are available as well.