HostPacketBuilder< maxPacketBytes > Struct Template Reference

Helper class for constructing a packet for sending to a BLOCKS device. More...

Public Member Functions
	HostPacketBuilder () noexcept
	HostPacketBuilder (const HostPacketBuilder &)=delete
	HostPacketBuilder (HostPacketBuilder &&)=default
const void *	getData () const noexcept
int	size () const noexcept
void	writePacketSysexHeaderBytes (TopologyIndex deviceIndex) noexcept
void	writePacketSysexFooter () noexcept
bool	deviceControlMessage (DeviceCommand command) noexcept
bool	beginDataChanges (PacketIndex packetIndex) noexcept
bool	endDataChanges (bool isLastChange) noexcept
bool	skipBytes (int numToSkip) noexcept
bool	setMultipleBytes (const uint8 *values, int num) noexcept
bool	setMultipleBytes (uint8 value, uint8 lastValue, int num) noexcept
bool	addProgramEventMessage (const int32 *messageData)

Detailed Description

template<int maxPacketBytes>
struct HostPacketBuilder< maxPacketBytes >

Helper class for constructing a packet for sending to a BLOCKS device.

Constructor & Destructor Documentation

HostPacketBuilder() [1/3]

template<int maxPacketBytes>

HostPacketBuilder< maxPacketBytes >::HostPacketBuilder ( )

noexcept

HostPacketBuilder() [2/3]

template<int maxPacketBytes>

HostPacketBuilder< maxPacketBytes >::HostPacketBuilder ( const HostPacketBuilder< maxPacketBytes > &  )

delete

HostPacketBuilder() [3/3]

template<int maxPacketBytes>

HostPacketBuilder< maxPacketBytes >::HostPacketBuilder ( HostPacketBuilder< maxPacketBytes > &&  )

default

Member Function Documentation

getData()

template<int maxPacketBytes>

const void* HostPacketBuilder< maxPacketBytes >::getData ( ) const

noexcept

References Packed7BitArrayBuilder< allocatedBytes >::getData().

size()

template<int maxPacketBytes>

int HostPacketBuilder< maxPacketBytes >::size ( ) const

noexcept

References Packed7BitArrayBuilder< allocatedBytes >::size().

writePacketSysexHeaderBytes()

template<int maxPacketBytes>

void HostPacketBuilder< maxPacketBytes >::writePacketSysexHeaderBytes ( TopologyIndex  deviceIndex )

noexcept

References jassert, and Packed7BitArrayBuilder< allocatedBytes >::writeHeaderSysexBytes().

writePacketSysexFooter()

template<int maxPacketBytes>

void HostPacketBuilder< maxPacketBytes >::writePacketSysexFooter ( )

noexcept

References Packed7BitArrayBuilder< allocatedBytes >::writePacketSysexFooter().

deviceControlMessage()

template<int maxPacketBytes>

bool HostPacketBuilder< maxPacketBytes >::deviceControlMessage ( DeviceCommand  command )

noexcept

References IntegerWithBitSize< numBits >::bits, deviceCommandMessage, and Packed7BitArrayBuilder< allocatedBytes >::hasCapacity().

beginDataChanges()

template<int maxPacketBytes>

bool HostPacketBuilder< maxPacketBytes >::beginDataChanges ( PacketIndex  packetIndex )

noexcept

References IntegerWithBitSize< numBits >::bits, Packed7BitArrayBuilder< allocatedBytes >::hasCapacity(), and sharedDataChange.

endDataChanges()

template<int maxPacketBytes>

bool HostPacketBuilder< maxPacketBytes >::endDataChanges ( bool  isLastChange )

noexcept

References IntegerWithBitSize< numBits >::bits, endOfChanges, endOfPacket, and Packed7BitArrayBuilder< allocatedBytes >::hasCapacity().

skipBytes()

template<int maxPacketBytes>

bool HostPacketBuilder< maxPacketBytes >::skipBytes ( int  numToSkip )

noexcept

References IntegerWithBitSize< numBits >::bits, IntegerWithBitSize< 8 >::bits, Packed7BitArrayBuilder< allocatedBytes >::getState(), Packed7BitArrayBuilder< allocatedBytes >::hasCapacity(), IntegerWithBitSize< numBits >::maxValue, IntegerWithBitSize< 8 >::maxValue, Packed7BitArrayBuilder< allocatedBytes >::restore(), skipBytesFew, and skipBytesMany.

setMultipleBytes() [1/2]

template<int maxPacketBytes>

bool HostPacketBuilder< maxPacketBytes >::setMultipleBytes ( const uint8 *  values, int  num  )

noexcept

References IntegerWithBitSize< numBits >::bits, IntegerWithBitSize< 8 >::bits, Packed7BitArrayBuilder< allocatedBytes >::hasCapacity(), and setSequenceOfBytes.

Referenced by HostPacketBuilder< maxPacketBytes >::setMultipleBytes().

setMultipleBytes() [2/2]

template<int maxPacketBytes>

bool HostPacketBuilder< maxPacketBytes >::setMultipleBytes ( uint8  value, uint8  lastValue, int  num  )

noexcept

References IntegerWithBitSize< numBits >::bits, IntegerWithBitSize< 8 >::bits, Packed7BitArrayBuilder< allocatedBytes >::getState(), Packed7BitArrayBuilder< allocatedBytes >::hasCapacity(), IntegerWithBitSize< numBits >::maxValue, IntegerWithBitSize< 8 >::maxValue, Packed7BitArrayBuilder< allocatedBytes >::restore(), setFewBytesWithLastValue, setFewBytesWithValue, setManyBytesWithValue, and HostPacketBuilder< maxPacketBytes >::setMultipleBytes().

addProgramEventMessage()

template<int maxPacketBytes>

bool HostPacketBuilder< maxPacketBytes >::addProgramEventMessage

(

const int32 *

messageData

)

References Packed7BitArrayBuilder< allocatedBytes >::hasCapacity(), and programEventMessage.

---

The documentation for this struct was generated from the following file:

• juce_HostPacketBuilder.h