summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorEdoardo La Greca2025-06-20 18:01:47 +0200
committerEdoardo La Greca2025-06-20 18:01:47 +0200
commitc916a1c14813fbb96288b0c75efd29e01ee6a0df (patch)
tree5719f3865e3601da440edab835507f55e9e59c84
parentff805c250c0ac7a794c851bdbfc252ae30bc80f8 (diff)
add clarification about exceptions thrown in constructors of NetworkPacketTransporter implementors
-rw-r--r--src/main/kotlin/NetworkPacketTransporter.kt3
1 files changed, 3 insertions, 0 deletions
diff --git a/src/main/kotlin/NetworkPacketTransporter.kt b/src/main/kotlin/NetworkPacketTransporter.kt
index 86f651a..4b11967 100644
--- a/src/main/kotlin/NetworkPacketTransporter.kt
+++ b/src/main/kotlin/NetworkPacketTransporter.kt
@@ -8,6 +8,9 @@ import java.io.Closeable
* The address of the remote endpoint can be an IP address (v4 or v6) or a domain name, in which case it is resolved to
* an IP address right before initializing the connection. Every constructor should throw an [UnresolvableHostException]
* if the remote address is a domain name, but it cannot be resolved.
+ *
+ * Depending on the specific given implementation, the constructor of this class might throw other exceptions (e.g. the
+ * [Socket] constructor from [java.net] in [NetworkPacketTransporterJavaNet]).
*/
abstract class NetworkPacketTransporter : Closeable {
val address: String