juce::BlocksProtocol::HostPacketBuilder< maxPacketBytes > Struct Template Reference

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

#include <juce_HostPacketBuilder.h>

Collaboration diagram for juce::BlocksProtocol::HostPacketBuilder< maxPacketBytes >:

Public Member Functions
	HostPacketBuilder () noexcept
	HostPacketBuilder (const HostPacketBuilder &)=delete
	HostPacketBuilder (HostPacketBuilder &&)=default
bool	addBlockReset ()
bool	addConfigSetMessage (int32 item, int32 value)
bool	addFactoryReset ()
bool	addFirmwareUpdatePacket (const uint8 *packetData, uint8 size)
bool	addProgramEventMessage (const int32 *messageData)
bool	addRequestFactorySyncMessage ()
bool	addRequestMessage (int32 item)
bool	addRequestUserSyncMessage ()
bool	addSetBlockName (const juce::String &name)
bool	beginDataChanges (PacketIndex packetIndex) noexcept
bool	deviceControlMessage (DeviceCommand command) noexcept
bool	endDataChanges (bool isLastChange) noexcept
const void *	getData () const noexcept
bool	setMultipleBytes (const uint8 *values, int num) noexcept
bool	setMultipleBytes (uint8 value, uint8 lastValue, int num) noexcept
int	size () const noexcept
bool	skipBytes (int numToSkip) noexcept
void	writePacketSysexFooter () noexcept
void	writePacketSysexHeaderBytes (TopologyIndex deviceIndex) noexcept

Private Member Functions
void	writeMessageType (MessageFromHost type) noexcept

Private Attributes
Packed7BitArrayBuilder< maxPacketBytes >	data

Detailed Description

template<int maxPacketBytes>
struct juce::BlocksProtocol::HostPacketBuilder< maxPacketBytes >

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

{Blocks}

Constructor & Destructor Documentation

HostPacketBuilder() [1/3]

template<int maxPacketBytes>

juce::BlocksProtocol::HostPacketBuilder< maxPacketBytes >::HostPacketBuilder ( )

inlinenoexcept

HostPacketBuilder() [2/3]

template<int maxPacketBytes>

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

delete

HostPacketBuilder() [3/3]

template<int maxPacketBytes>

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

default

Member Function Documentation

addBlockReset()

template<int maxPacketBytes>

bool juce::BlocksProtocol::HostPacketBuilder< maxPacketBytes >::addBlockReset ( )

inline

References juce::BlocksProtocol::IntegerWithBitSize< numBits >::bits, juce::BlocksProtocol::blockReset, juce::BlocksProtocol::HostPacketBuilder< maxPacketBytes >::data, juce::BlocksProtocol::Packed7BitArrayBuilder< allocatedBytes >::hasCapacity(), and juce::BlocksProtocol::HostPacketBuilder< maxPacketBytes >::writeMessageType().

addConfigSetMessage()

template<int maxPacketBytes>

bool juce::BlocksProtocol::HostPacketBuilder< maxPacketBytes >::addConfigSetMessage ( int32  item, int32  value  )

inline

References juce::BlocksProtocol::configMessage, juce::BlocksProtocol::configSetMessage, juce::BlocksProtocol::HostPacketBuilder< maxPacketBytes >::data, juce::BlocksProtocol::Packed7BitArrayBuilder< allocatedBytes >::hasCapacity(), juce::BlocksProtocol::setConfig, and juce::BlocksProtocol::HostPacketBuilder< maxPacketBytes >::writeMessageType().

Referenced by juce::BlockConfigManager::setBlockConfig().

addFactoryReset()

template<int maxPacketBytes>

bool juce::BlocksProtocol::HostPacketBuilder< maxPacketBytes >::addFactoryReset ( )

inline

References juce::BlocksProtocol::IntegerWithBitSize< numBits >::bits, juce::BlocksProtocol::HostPacketBuilder< maxPacketBytes >::data, juce::BlocksProtocol::factoryReset, juce::BlocksProtocol::Packed7BitArrayBuilder< allocatedBytes >::hasCapacity(), and juce::BlocksProtocol::HostPacketBuilder< maxPacketBytes >::writeMessageType().

addFirmwareUpdatePacket()

template<int maxPacketBytes>

bool juce::BlocksProtocol::HostPacketBuilder< maxPacketBytes >::addFirmwareUpdatePacket ( const uint8 *  packetData, uint8  size  )

inline

References juce::BlocksProtocol::IntegerWithBitSize< numBits >::bits, juce::BlocksProtocol::HostPacketBuilder< maxPacketBytes >::data, juce::BlocksProtocol::firmwareUpdatePacket, juce::BlocksProtocol::Packed7BitArrayBuilder< allocatedBytes >::hasCapacity(), juce::BlocksProtocol::HostPacketBuilder< maxPacketBytes >::size(), and juce::BlocksProtocol::HostPacketBuilder< maxPacketBytes >::writeMessageType().

addProgramEventMessage()

template<int maxPacketBytes>

bool juce::BlocksProtocol::HostPacketBuilder< maxPacketBytes >::addProgramEventMessage ( const int32 *  messageData )

inline

References juce::BlocksProtocol::HostPacketBuilder< maxPacketBytes >::data, juce::BlocksProtocol::Packed7BitArrayBuilder< allocatedBytes >::hasCapacity(), juce::BlocksProtocol::numProgramMessageInts, juce::BlocksProtocol::programEventMessage, and juce::BlocksProtocol::HostPacketBuilder< maxPacketBytes >::writeMessageType().

addRequestFactorySyncMessage()

template<int maxPacketBytes>

bool juce::BlocksProtocol::HostPacketBuilder< maxPacketBytes >::addRequestFactorySyncMessage ( )

inline

References juce::BlocksProtocol::IntegerWithBitSize< numBits >::bits, juce::BlocksProtocol::configMessage, juce::BlocksProtocol::HostPacketBuilder< maxPacketBytes >::data, juce::BlocksProtocol::Packed7BitArrayBuilder< allocatedBytes >::hasCapacity(), juce::BlocksProtocol::requestFactorySync, and juce::BlocksProtocol::HostPacketBuilder< maxPacketBytes >::writeMessageType().

Referenced by juce::BlockConfigManager::requestFactoryConfigSync().

addRequestMessage()

template<int maxPacketBytes>

bool juce::BlocksProtocol::HostPacketBuilder< maxPacketBytes >::addRequestMessage ( int32  item )

inline

References juce::BlocksProtocol::configMessage, juce::BlocksProtocol::configSetMessage, juce::BlocksProtocol::HostPacketBuilder< maxPacketBytes >::data, juce::BlocksProtocol::Packed7BitArrayBuilder< allocatedBytes >::hasCapacity(), juce::BlocksProtocol::requestConfig, and juce::BlocksProtocol::HostPacketBuilder< maxPacketBytes >::writeMessageType().

Referenced by juce::BlockConfigManager::requestBlockConfig().

addRequestUserSyncMessage()

template<int maxPacketBytes>

bool juce::BlocksProtocol::HostPacketBuilder< maxPacketBytes >::addRequestUserSyncMessage ( )

inline

References juce::BlocksProtocol::IntegerWithBitSize< numBits >::bits, juce::BlocksProtocol::configMessage, juce::BlocksProtocol::HostPacketBuilder< maxPacketBytes >::data, juce::BlocksProtocol::Packed7BitArrayBuilder< allocatedBytes >::hasCapacity(), juce::BlocksProtocol::requestUserSync, and juce::BlocksProtocol::HostPacketBuilder< maxPacketBytes >::writeMessageType().

Referenced by juce::BlockConfigManager::requestUserConfigSync().

addSetBlockName()

template<int maxPacketBytes>

bool juce::BlocksProtocol::HostPacketBuilder< maxPacketBytes >::addSetBlockName ( const juce::String &  name )

inline

References juce::BlocksProtocol::IntegerWithBitSize< numBits >::bits, juce::BlocksProtocol::HostPacketBuilder< maxPacketBytes >::data, juce::BlocksProtocol::Packed7BitArrayBuilder< allocatedBytes >::hasCapacity(), juce::String::length(), juce::BlocksProtocol::setName, juce::String::toRawUTF8(), and juce::BlocksProtocol::HostPacketBuilder< maxPacketBytes >::writeMessageType().

beginDataChanges()

template<int maxPacketBytes>

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

inlinenoexcept

References juce::BlocksProtocol::IntegerWithBitSize< numBits >::bits, juce::BlocksProtocol::HostPacketBuilder< maxPacketBytes >::data, juce::BlocksProtocol::Packed7BitArrayBuilder< allocatedBytes >::hasCapacity(), juce::BlocksProtocol::sharedDataChange, and juce::BlocksProtocol::HostPacketBuilder< maxPacketBytes >::writeMessageType().

deviceControlMessage()

template<int maxPacketBytes>

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

inlinenoexcept

References juce::BlocksProtocol::IntegerWithBitSize< numBits >::bits, command, juce::BlocksProtocol::HostPacketBuilder< maxPacketBytes >::data, juce::BlocksProtocol::deviceCommandMessage, juce::BlocksProtocol::Packed7BitArrayBuilder< allocatedBytes >::hasCapacity(), and juce::BlocksProtocol::HostPacketBuilder< maxPacketBytes >::writeMessageType().

endDataChanges()

template<int maxPacketBytes>

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

inlinenoexcept

References juce::BlocksProtocol::IntegerWithBitSize< numBits >::bits, juce::BlocksProtocol::HostPacketBuilder< maxPacketBytes >::data, juce::BlocksProtocol::endOfChanges, juce::BlocksProtocol::endOfPacket, and juce::BlocksProtocol::Packed7BitArrayBuilder< allocatedBytes >::hasCapacity().

getData()

template<int maxPacketBytes>

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

inlinenoexcept

References juce::BlocksProtocol::HostPacketBuilder< maxPacketBytes >::data, and juce::BlocksProtocol::Packed7BitArrayBuilder< allocatedBytes >::getData().

Referenced by juce::BlockConfigManager::buildAndSendPacket().

setMultipleBytes() [1/2]

template<int maxPacketBytes>

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

inlinenoexcept

References juce::BlocksProtocol::IntegerWithBitSize< numBits >::bits, juce::BlocksProtocol::IntegerWithBitSize< 8 >::bits, juce::BlocksProtocol::HostPacketBuilder< maxPacketBytes >::data, juce::BlocksProtocol::Packed7BitArrayBuilder< allocatedBytes >::hasCapacity(), and juce::BlocksProtocol::setSequenceOfBytes.

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

setMultipleBytes() [2/2]

template<int maxPacketBytes>

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

inlinenoexcept

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

size()

template<int maxPacketBytes>

int juce::BlocksProtocol::HostPacketBuilder< maxPacketBytes >::size ( ) const

inlinenoexcept

References juce::BlocksProtocol::HostPacketBuilder< maxPacketBytes >::data, and juce::BlocksProtocol::Packed7BitArrayBuilder< allocatedBytes >::size().

Referenced by juce::BlocksProtocol::HostPacketBuilder< maxPacketBytes >::addFirmwareUpdatePacket(), and juce::BlockConfigManager::buildAndSendPacket().

skipBytes()

template<int maxPacketBytes>

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

inlinenoexcept

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

writeMessageType()

template<int maxPacketBytes>

void juce::BlocksProtocol::HostPacketBuilder< maxPacketBytes >::writeMessageType ( MessageFromHost  type )

inlineprivatenoexcept

Referenced by juce::BlocksProtocol::HostPacketBuilder< maxPacketBytes >::addBlockReset(), juce::BlocksProtocol::HostPacketBuilder< maxPacketBytes >::addConfigSetMessage(), juce::BlocksProtocol::HostPacketBuilder< maxPacketBytes >::addFactoryReset(), juce::BlocksProtocol::HostPacketBuilder< maxPacketBytes >::addFirmwareUpdatePacket(), juce::BlocksProtocol::HostPacketBuilder< maxPacketBytes >::addProgramEventMessage(), juce::BlocksProtocol::HostPacketBuilder< maxPacketBytes >::addRequestFactorySyncMessage(), juce::BlocksProtocol::HostPacketBuilder< maxPacketBytes >::addRequestMessage(), juce::BlocksProtocol::HostPacketBuilder< maxPacketBytes >::addRequestUserSyncMessage(), juce::BlocksProtocol::HostPacketBuilder< maxPacketBytes >::addSetBlockName(), juce::BlocksProtocol::HostPacketBuilder< maxPacketBytes >::beginDataChanges(), and juce::BlocksProtocol::HostPacketBuilder< maxPacketBytes >::deviceControlMessage().

writePacketSysexFooter()

template<int maxPacketBytes>

void juce::BlocksProtocol::HostPacketBuilder< maxPacketBytes >::writePacketSysexFooter ( )

inlinenoexcept

References juce::BlocksProtocol::HostPacketBuilder< maxPacketBytes >::data, and juce::BlocksProtocol::Packed7BitArrayBuilder< allocatedBytes >::writePacketSysexFooter().

Referenced by juce::BlockConfigManager::buildAndSendPacket().

writePacketSysexHeaderBytes()

template<int maxPacketBytes>

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

inlinenoexcept

References juce::BlocksProtocol::HostPacketBuilder< maxPacketBytes >::data, jassert, and juce::BlocksProtocol::Packed7BitArrayBuilder< allocatedBytes >::writeHeaderSysexBytes().

Referenced by juce::BlockConfigManager::buildAndSendPacket().

Member Data Documentation

data

template<int maxPacketBytes>

Packed7BitArrayBuilder<maxPacketBytes> juce::BlocksProtocol::HostPacketBuilder< maxPacketBytes >::data

private

Referenced by juce::BlocksProtocol::HostPacketBuilder< maxPacketBytes >::addBlockReset(), juce::BlocksProtocol::HostPacketBuilder< maxPacketBytes >::addConfigSetMessage(), juce::BlocksProtocol::HostPacketBuilder< maxPacketBytes >::addFactoryReset(), juce::BlocksProtocol::HostPacketBuilder< maxPacketBytes >::addFirmwareUpdatePacket(), juce::BlocksProtocol::HostPacketBuilder< maxPacketBytes >::addProgramEventMessage(), juce::BlocksProtocol::HostPacketBuilder< maxPacketBytes >::addRequestFactorySyncMessage(), juce::BlocksProtocol::HostPacketBuilder< maxPacketBytes >::addRequestMessage(), juce::BlocksProtocol::HostPacketBuilder< maxPacketBytes >::addRequestUserSyncMessage(), juce::BlocksProtocol::HostPacketBuilder< maxPacketBytes >::addSetBlockName(), juce::BlocksProtocol::HostPacketBuilder< maxPacketBytes >::beginDataChanges(), juce::BlocksProtocol::HostPacketBuilder< maxPacketBytes >::deviceControlMessage(), juce::BlocksProtocol::HostPacketBuilder< maxPacketBytes >::endDataChanges(), juce::BlocksProtocol::HostPacketBuilder< maxPacketBytes >::getData(), juce::BlocksProtocol::HostPacketBuilder< maxPacketBytes >::setMultipleBytes(), juce::BlocksProtocol::HostPacketBuilder< maxPacketBytes >::size(), juce::BlocksProtocol::HostPacketBuilder< maxPacketBytes >::skipBytes(), juce::BlocksProtocol::HostPacketBuilder< maxPacketBytes >::writePacketSysexFooter(), and juce::BlocksProtocol::HostPacketBuilder< maxPacketBytes >::writePacketSysexHeaderBytes().

---

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

• juce_HostPacketBuilder.h