throttle()

bool FASTRUN SvcSerialCommandInterface::throttle

(

)

returns true if the available serial buffer falls below SERIAL_THROTTLE_BUFFER_REMAINING_THRESHOLD if the buffer falls below SERIAL_THROTTLE_CHECK_CONNECTION_BUFFER_THRESHOLD delay for a small period of time if another check finds the buffer isn't moving then flush the buffer. returns false otherwise

Returns

true

false

Definition at line 169 of file svcSerialCommandInterface.cpp.

                                                {
    uint16_t avail;
    avail = Serial.availableForWrite();
 
    if(avail < SERIAL_THROTTLE_CHECK_CONNECTION_BUFFER_THRESHOLD){
        uint16_t delta_avail;
        uint16_t msec_delay_counter = 0;
        //serial tx buffer not available
        do{
            delay(5);
            msec_delay_counter += 5;
            delta_avail = Serial.availableForWrite();
            if (delta_avail > SERIAL_THROTTLE_CHECK_CONNECTION_BUFFER_THRESHOLD) break;
        } while (msec_delay_counter < SERIAL_THROTTLE_CHECK_CONNECTION_MAX_DELAY);
        
        if(avail == delta_avail){
            return true;
        } else{
            //Serial.println(F("M WRN throttling"));//use this for debug only!
            am->data->increment("SERIAL_THROTTLE_EVENTS");
        }
    }
    if(avail < SERIAL_THROTTLE_BUFFER_THRESHOLD) return true;
    return false;
}

References AppBaseClass::am, AppManager::data, and SvcDataDictionary::increment().

Referenced by flush(), messageHandler_GET(), messageHandler_GET_RAM1(), messageHandler_GET_RAM2(), messageHandler_LS(), AudioDirector::printStats(), send(), sendLZ4Message(), streamTransmitHandler(), txOverflowHandler(), and update().

Here is the call graph for this function:

Here is the caller graph for this function: