Skip to content

Class: FetchObject ​

Payload-bearing fetch object (§11.5, non-End-of-Range form).

FETCH objects carry no Object Status field; a zero-length payload signals a zero-length Normal object.

Properties ​

endOfRange ​

readonly endOfRange: EndOfRangeKind | null


forwardingPreference ​

readonly forwardingPreference: ObjectForwardingPreference


kind ​

readonly kind: "object" | "end_of_range"


location ​

readonly location: Location


payload ​

readonly payload: Uint8Array<ArrayBufferLike> | null


properties ​

readonly properties: KeyValuePair[] | null


publisherPriority ​

readonly publisherPriority: number


subgroupId ​

readonly subgroupId: bigint

Accessors ​

groupId ​

Get Signature ​

get groupId(): bigint

Returns ​

bigint


objectId ​

Get Signature ​

get objectId(): bigint

Returns ​

bigint

Methods ​

nextContext() ​

nextContext(prev?): FetchObjectContext

What the entry after this one is encoded against, given what this one was encoded against (prev).

After an Object, that is the Object itself. After an End of Range marker, it is the marker's Group and Object IDs, with the Subgroup ID and priority still those of the last Object before the marker, or none if no Object came before it.

Parameters ​

prev? ​

FetchObjectContext

Returns ​

FetchObjectContext


serialize() ​

serialize(prev?, groupOrder?): FrozenByteBuffer

Parameters ​

prev? ​

FetchObjectContext

groupOrder? ​

GroupOrder = GroupOrder.Original

Returns ​

FrozenByteBuffer


deserialize() ​

static deserialize(buf, prev?, groupOrder?): FetchObject

Parameters ​

buf ​

BaseByteBuffer

prev? ​

FetchObjectContext

groupOrder? ​

GroupOrder = GroupOrder.Original

Returns ​

FetchObject


newEndOfRange() ​

static newEndOfRange(kind, groupId, objectId): FetchObject

Parameters ​

kind ​

EndOfRangeKind

groupId ​

number | bigint

objectId ​

number | bigint

Returns ​

FetchObject


newObject() ​

static newObject(groupId, subgroupId, objectId, publisherPriority, forwardingPreference, properties, payload): FetchObject

Parameters ​

groupId ​

number | bigint

subgroupId ​

number | bigint

objectId ​

number | bigint

publisherPriority ​

number

forwardingPreference ​

ObjectForwardingPreference

properties ​

KeyValuePair[] | null

payload ​

Uint8Array

Returns ​

FetchObject