rusefi
/
jSerialComm
mirror of https://github.com/rusefi/jSerialComm.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Add documentation specifying buffer size method limitations

This commit is contained in:
Will Hedgecock 2022-01-04 16:05:11 -06:00
parent 9bda1b4a7b
commit 4d635bf3ca
1 changed files with 7 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
src/main/java/com/fazecast/jSerialComm/SerialPort.java
View File

@ -2,10 +2,10 @@
* SerialPort.java * SerialPort.java
* *
* Created on: Feb 25, 2012 * Created on: Feb 25, 2012
* Last Updated on: Dec 17, 2021 * Last Updated on: Jan 01, 2022
* Author: Will Hedgecock * Author: Will Hedgecock
* *
* Copyright (C) 2012-2021 Fazecast, Inc. * Copyright (C) 2012-2022 Fazecast, Inc.
* *
* This file is part of jSerialComm. * This file is part of jSerialComm.
* *
@ -802,12 +802,16 @@ public final class SerialPort
/** /**
* Returns the underlying transmit buffer size used by the serial port device driver. The device or operating system may choose to misrepresent this value. * Returns the underlying transmit buffer size used by the serial port device driver. The device or operating system may choose to misrepresent this value.
* <p>
* Only Windows and Linux-based operating systems are potentially able to return a correct value for this method. On other operating systems, this value is undefined.
* @return The underlying device transmit buffer size. * @return The underlying device transmit buffer size.
*/ */
public final int getDeviceWriteBufferSize() { return sendDeviceQueueSize; } public final int getDeviceWriteBufferSize() { return sendDeviceQueueSize; }
/** /**
* Returns the underlying receive buffer size used by the serial port device driver. The device or operating system may choose to misrepresent this value. * Returns the underlying receive buffer size used by the serial port device driver. The device or operating system may choose to misrepresent this value.
* <p>
* Only Windows and Linux-based operating systems are potentially able to return a correct value for this method. On other operating systems, this value is undefined.
* @return The underlying device receive buffer size. * @return The underlying device receive buffer size.
*/ */
public final int getDeviceReadBufferSize() { return receiveDeviceQueueSize; } public final int getDeviceReadBufferSize() { return receiveDeviceQueueSize; }
@ -1645,8 +1649,8 @@ public final class SerialPort
if (!eventListenerRunning) if (!eventListenerRunning)
return; return;
eventListenerRunning = false; eventListenerRunning = false;
setEventListeningStatus(portHandle, false);
configTimeouts(portHandle, TIMEOUT_NONBLOCKING, 0, 0, 0); configTimeouts(portHandle, TIMEOUT_NONBLOCKING, 0, 0, 0);
setEventListeningStatus(portHandle, false);
try try
{ {