HardwareSerial::availableForWrite()

概要

Serial.availableForWrite()/HardwareSerial::availableForWrite()は、シリアル通信の送信バッファ内に書き込み可能な文字数を返します。リファレンスはこちら}。

ソースコード

HardwareSerial::availableForWrite()は、hardware/arduino/cores/arduino/HardwareSerial.cppに定義されています。以下に全ソースコードを示します。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12


int HardwareSerial::availableForWrite(void)
{
  tx_buffer_index_t head;
  tx_buffer_index_t tail;

  TX_BUFFER_ATOMIC {
    head = _tx_buffer_head;
    tail = _tx_buffer_tail;
  }
  if (head >= tail) return SERIAL_TX_BUFFER_SIZE - 1 - head + tail;
  return tail - head - 1;
}

入力はありません。戻り値はintです。

1
2


int HardwareSerial::availableForWrite(void)
{

バッファ内の有効な文字数を計算して返却します。

 3
 4
 5
 6
 7
 8
 9
10
11
12


  tx_buffer_index_t head;
  tx_buffer_index_t tail;
 
  TX_BUFFER_ATOMIC {
    head = _tx_buffer_head;
    tail = _tx_buffer_tail;
  }
  if (head >= tail) return SERIAL_TX_BUFFER_SIZE - 1 - head + tail;
  return tail - head - 1;
}

tx_buffer_tail ≦ tx_buffer_head の場合、tx_buffer_tail + SERIAL_TX_BUFFER_SIZE - tx_buffer_head - 1がバッファ内に書き込み可能な文字数です。

tx_buffer_tail > tx_buffer_head の場合、tx_buffer_tail - tx_buffer_head - 1がバッファ内の有効な文字数です。

バージョン

Arduino AVR Boards 1.8.6

最終更新日

March 21, 2023