BufferList Class Reference

A BufferList is, as its name implies, a list of Buffer objects. It manages the current total length of the list and is used by the Stream class internally. When using Aurora, you won't deal with BufferLists directly very often.

Constructor

• new BufferList

Properties

• availableBytes
• availableBuffers
• first

Methods

• copy
• push
• unshift
• shift

Constructor

new BufferList()

Creates a new BufferList with no data.

Properties

BufferList#availableBytes

The current total length of the buffer list.

BufferList#availableBuffers

The number of buffers in the list.

BufferList#first

The first buffer in the list.

Methods

BufferList#copy()

Returns a copy of the buffer list with a shallow copy of the buffers. Modifying the buffers in the cloned BufferList will modify the buffers in the original BufferList.

BufferList#push(buffer)

Adds a buffer to the end of the buffer list. Updates availableBytes and availableBuffers.

BufferList#unshift(buffer)

Adds a buffer to the beginning of the buffer list. Updates availableBytes and availableBuffers.

BufferList#shift()

Removes and returns the first buffer in the list, updating availableBytes and availableBuffers accordingly.