HardwareSerial::availableForWrite()

Abstract

The Serial.availableForWrite()/HardwareSerial::availableForWrite() returns how many bytes can be written to transmit buffer of serial communication.

Source Code

The HardwareSerial::availableForWrite() is defined in hardware/arduino/cores/arduino/HardwareSerial.cpp as below.

 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;
}

No input, returns int.

1
2
int HardwareSerial::availableForWrite(void)
{

Calculate the number of available bytes in the buffer.

 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;
}

In case of tx_buffer_tail ≦ tx_buffer_head, tx_buffer_tail + SERIAL_TX_BUFFER_SIZE - tx_buffer_head - 1 is the available bytes in the buffer.

In case of tx_buffer_tail > tx_buffer_head, tx_buffer_tail - tx_buffer_head - 1 is the available bytes in the buffer.

Version

Arduino AVR Boards 1.8.6

License

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
/*
  Copyright (c) 2019 garretlab.
  Added source code explanation by garretlab.
*/

/*
  HardwareSerial.cpp - Hardware serial library for Wiring
  Copyright (c) 2006 Nicholas Zambetti.  All right reserved.

  This library is free software; you can redistribute it and/or
  modify it under the terms of the GNU Lesser General Public
  License as published by the Free Software Foundation; either
  version 2.1 of the License, or (at your option) any later version.

  This library is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  Lesser General Public License for more details.

  You should have received a copy of the GNU Lesser General Public
  License along with this library; if not, write to the Free Software
  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA

  Modified 23 November 2006 by David A. Mellis
  Modified 28 September 2010 by Mark Sproul
  Modified 14 August 2012 by Alarus
  Modified 3 December 2013 by Matthijs Kooijman
*/

Last Update

August 25, 2019

inserted by FC2 system