IO: Rename the (publicly listed) waitForInterrupt function to waitFor · lAndbz/processing@e4d30fe · GitHub

1. lAndbz
2. processing

Repository navigation

• Code
• Pull requests
• Actions
• Projects
• Wiki
• Security and quality
• Insights

Commit e4d30fe

Browse filesBrowse the repository at this point in the historyBrowse files

gohai

committed

IO: Rename the (publicly listed) waitForInterrupt function to waitFor

This function is used like this: GPIO.waitFor(pin number, rising/falling/change, timeout or -1) While it's using an interrupt internally, in the way it is used it doesn't relate to the interrupt functions (attachInterrupt, etc) at all. To prevent confusion, rename it to waitFor. (Another possible name would be waitForPin.)

1 parent 2b3dac0 commit e4d30fe
Copy full SHA for e4d30fe

1 file changed

+6-1Lines changed: 6 additions & 1 deletion

File tree

Expand file treeCollapse file tree

Open diff view settings

Filter options

• java/libraries/io/src/processing/io
  • GPIO.java

Expand file treeCollapse file tree

Open diff view settings

Collapse file

‎java/libraries/io/src/processing/io/GPIO.java‎

Copy file name to clipboardExpand all lines: java/libraries/io/src/processing/io/GPIO.java

+6-1Lines changed: 6 additions & 1 deletion

Original file line number	Diff line number	Diff line change
@@ -451,12 +451,17 @@ public static void releasePin(int pin) {
451	451	* @return true if the interrupt occured, false if the timeout occured
452	452	* @webref
453	453	*/
454		- public static boolean waitForInterrupt(int pin, int mode, int timeout) {
	454	+ public static boolean waitFor(int pin, int mode, int timeout) {
455	455	enableInterrupt(pin, mode);
456	456	return waitForInterrupt(pin, timeout);
457	457	}
458	458
459	459
	460	+ public static boolean waitForInterrupt(int pin, int mode, int timeout) {
	461	+ throw new RuntimeException("The waitForInterrupt function has been renamed to waitFor. Please update your sketch accordingly.");
	462	+ }
	463	+
	464	+
460	465	/**
461	466	* Waits for the value of an input pin to change
462	467	*

0 commit comments

Comments

0 (0)