Skip to content

Class: SubgroupHeader ​

Constructors ​

Constructor ​

new SubgroupHeader(type, trackAlias, groupId, subgroupId, publisherPriority): SubgroupHeader

Parameters ​

type ​

SubgroupHeaderType

trackAlias ​

number | bigint

groupId ​

number | bigint

subgroupId ​

number | bigint | undefined

publisherPriority ​

number | undefined

Returns ​

SubgroupHeader

Properties ​

groupId ​

readonly groupId: bigint


publisherPriority ​

readonly publisherPriority: number | undefined


subgroupId ​

subgroupId: bigint | undefined

Absent on the wire, and still unknown here, when the type says the Subgroup ID is the first Object ID: that object has not been read yet at header time. resolveSubgroupId fills it in, so consumers can read this rather than each deriving it again.


trackAlias ​

readonly trackAlias: bigint


type ​

readonly type: SubgroupHeaderType

Methods ​

resolveSubgroupId() ​

resolveSubgroupId(firstObjectId): void

Name this subgroup from the first object read off its stream, for the header type that defers the Subgroup ID to it. Ignored for every other type, and for a header already named, so later objects on the stream cannot rename it.

Parameters ​

firstObjectId ​

bigint

Returns ​

void


serialize() ​

serialize(): FrozenByteBuffer

Returns ​

FrozenByteBuffer


deserialize() ​

static deserialize(buf): SubgroupHeader

Parameters ​

buf ​

BaseByteBuffer

Returns ​

SubgroupHeader