JUCE v8.0.9
JUCE API
 
Loading...
Searching...
No Matches
juce::midi_ci::ResponderPropertyExchangeCache Class Reference

Accumulates message chunks that form a request initiated by a remote device. More...

#include <juce_CIPropertyExchangeCache.h>

Collaboration diagram for juce::midi_ci::ResponderPropertyExchangeCache:

Public Member Functions

 ResponderPropertyExchangeCache ()
 
 ResponderPropertyExchangeCache (ResponderPropertyExchangeCache &&) noexcept
 
 ~ResponderPropertyExchangeCache ()
 
void addChunk (RequestID, const Message::DynamicSizePropertyExchange &chunk)
 Adds a message chunk for the provided transaction id.
 
int countOngoingTransactions () const
 Returns the number of transactions that have been started but not finished.
 
void notify (RequestID, Span< const std::byte > header)
 Updates the transaction state based on the contents of the provided notification.
 
ResponderPropertyExchangeCacheoperator= (ResponderPropertyExchangeCache &&) noexcept
 
void primeCache (uint8_t maxSimultaneousTransactions, std::function< void(const PropertyExchangeResult &)> onDone, RequestID id)
 Prepares the cache for the given requestID to accumulate message chunks.
 

Private Attributes

std::unique_ptr< Impl > pimpl
 

Detailed Description

Accumulates message chunks that form a request initiated by a remote device.

@tags{Audio}

Constructor & Destructor Documentation

◆ ResponderPropertyExchangeCache() [1/2]

juce::midi_ci::ResponderPropertyExchangeCache::ResponderPropertyExchangeCache ( )

◆ ~ResponderPropertyExchangeCache()

juce::midi_ci::ResponderPropertyExchangeCache::~ResponderPropertyExchangeCache ( )

◆ ResponderPropertyExchangeCache() [2/2]

juce::midi_ci::ResponderPropertyExchangeCache::ResponderPropertyExchangeCache ( ResponderPropertyExchangeCache &&  )
noexcept

Member Function Documentation

◆ addChunk()

void juce::midi_ci::ResponderPropertyExchangeCache::addChunk ( RequestID  ,
const Message::DynamicSizePropertyExchange chunk 
)

Adds a message chunk for the provided transaction id.

◆ countOngoingTransactions()

int juce::midi_ci::ResponderPropertyExchangeCache::countOngoingTransactions ( ) const

Returns the number of transactions that have been started but not finished.

◆ notify()

void juce::midi_ci::ResponderPropertyExchangeCache::notify ( RequestID  ,
Span< const std::byte >  header 
)

Updates the transaction state based on the contents of the provided notification.

◆ operator=()

ResponderPropertyExchangeCache & juce::midi_ci::ResponderPropertyExchangeCache::operator= ( ResponderPropertyExchangeCache &&  )
noexcept

◆ primeCache()

void juce::midi_ci::ResponderPropertyExchangeCache::primeCache ( uint8_t  maxSimultaneousTransactions,
std::function< void(const PropertyExchangeResult &)>  onDone,
RequestID  id 
)

Prepares the cache for the given requestID to accumulate message chunks.

Incoming chunks added with addChunk are generated by another device acting as an initiator.

Member Data Documentation

◆ pimpl

std::unique_ptr<Impl> juce::midi_ci::ResponderPropertyExchangeCache::pimpl
private

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