Skip to content

Commit b63a31b

Browse files
committed
Update javadoc about meaning of zero timeout
1 parent 502942b commit b63a31b

File tree

3 files changed

+9
-0
lines changed

3 files changed

+9
-0
lines changed

tls/src/main/java/org/bouncycastle/tls/DTLSRecordLayer.java

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -288,6 +288,9 @@ public int receive(byte[] buf, int off, int len, int waitMillis)
288288
return receive(buf, off, len, waitMillis, null);
289289
}
290290

291+
/**
292+
* A waitMillis of zero is interpreted as an infinite timeout.
293+
*/
291294
int receive(byte[] buf, int off, int len, int waitMillis, DTLSRecordCallback recordCallback)
292295
throws IOException
293296
{

tls/src/main/java/org/bouncycastle/tls/DTLSTransport.java

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,9 @@ public int receive(byte[] buf, int off, int len, int waitMillis)
3131
return receive(buf, off, len, waitMillis, null);
3232
}
3333

34+
/**
35+
* A waitMillis of zero is interpreted as an infinite timeout.
36+
*/
3437
public int receive(byte[] buf, int off, int len, int waitMillis, DTLSRecordCallback recordCallback)
3538
throws IOException
3639
{

tls/src/main/java/org/bouncycastle/tls/DatagramReceiver.java

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,5 +6,8 @@ public interface DatagramReceiver
66
{
77
int getReceiveLimit() throws IOException;
88

9+
/**
10+
* A waitMillis of zero is interpreted as an infinite timeout.
11+
*/
912
int receive(byte[] buf, int off, int len, int waitMillis) throws IOException;
1013
}

0 commit comments

Comments
 (0)