refactor(ktx): move extension to CoroutineSrtSocket

ThibaultBee · Sep 19, 2024 · 7d29a0d · 7d29a0d
1 parent 230a83e
commit 7d29a0d
Show file tree

Hide file tree

Showing 2 changed files with 230 additions and 239 deletions.
diff --git a/srtdroid-ktx/src/main/java/io/github/thibaultbee/srtdroid/ktx/CoroutineSrtSocket.kt b/srtdroid-ktx/src/main/java/io/github/thibaultbee/srtdroid/ktx/CoroutineSrtSocket.kt
@@ -12,6 +12,7 @@ import io.github.thibaultbee.srtdroid.core.models.MsgCtrl
 import io.github.thibaultbee.srtdroid.core.models.SrtError
 import io.github.thibaultbee.srtdroid.core.models.SrtSocket
 import io.github.thibaultbee.srtdroid.core.models.SrtSocket.ServerListener
+import io.github.thibaultbee.srtdroid.core.models.SrtUrl
 import io.github.thibaultbee.srtdroid.core.models.Stats
 import io.github.thibaultbee.srtdroid.core.models.rejectreason.InternalRejectReason
 import io.github.thibaultbee.srtdroid.core.models.rejectreason.PredefinedRejectReason
@@ -29,6 +30,7 @@ import kotlinx.coroutines.isActive
 import kotlinx.coroutines.suspendCancellableCoroutine
 import kotlinx.coroutines.withContext
 import kotlinx.coroutines.withTimeout
+import java.io.File
 import java.io.IOException
 import java.net.BindException
 import java.net.ConnectException
@@ -867,4 +869,231 @@ private constructor(
      * Use to store the socket and the stream ID.
      */
     data class IncomingSocket(val socket: CoroutineSrtSocket, val streamId: String)
-}
+}
+
+/**
+ * Binds the socket to a local address.
+ *
+ * **See Also:** [srt_bind](https://github.com/Haivision/srt/blob/master/docs/API/API-functions.md#srt_bind)
+ *
+ * @param url the URL to bind to in FFmpeg format srt://hostname:port[?options]
+ *
+ * @throws BindException if bind has failed
+ */
+suspend fun CoroutineSrtSocket.bind(url: String) = bind(SrtUrl(url))
+
+/**
+ * Binds the socket to a local address.
+ *
+ * **See Also:** [srt_bind](https://github.com/Haivision/srt/blob/master/docs/API/API-functions.md#srt_bind)
+ *
+ * @param srtUrl the URL to bind to in FFmpeg format srt://hostname:port[?options]
+ *
+ * @throws BindException if bind has failed
+ */
+suspend fun CoroutineSrtSocket.bind(srtUrl: SrtUrl) {
+    if (srtUrl.mode != null) {
+        require(srtUrl.mode != SrtUrl.Mode.CALLER) { "Bind is only for `listener` or `rendezvous` mode but ${srtUrl.mode}" }
+    }
+
+    srtUrl.preApplyTo(this)
+    srtUrl.preBindApplyTo(this)
+    bind(srtUrl.hostname, srtUrl.port)
+    srtUrl.postApplyTo(this)
+}
+
+/**
+ * Binds the socket to a local address.
+ *
+ * **See Also:** [srt_bind](https://github.com/Haivision/srt/blob/master/docs/API/API-functions.md#srt_bind)
+ *
+ * @param address the address to bind to
+ * @param port the port to bind to
+ * @throws BindException if bind has failed
+ */
+suspend fun CoroutineSrtSocket.bind(address: String, port: Int) =
+    bind(InetSocketAddress(address, port))
+
+/**
+ * Binds the socket to a local address.
+ *
+ * **See Also:** [srt_bind](https://github.com/Haivision/srt/blob/master/docs/API/API-functions.md#srt_bind)
+ *
+ * @param address the [InetAddress] to bind to
+ * @param port the port to bind to
+ *
+ * @throws BindException if bind has failed
+ */
+suspend fun CoroutineSrtSocket.bind(address: InetAddress, port: Int) =
+    bind(InetSocketAddress(address, port))
+
+
+/**
+ * Connects a socket to an URL.
+ *
+ * **See Also:** [srt_connect](https://github.com/Haivision/srt/blob/master/docs/API/API-functions.md#srt_connect)
+ *
+ * @param url the URL to connect to in FFmpeg format srt://hostname:port[?options]
+ * @throws ConnectException if connection has failed
+ */
+suspend fun CoroutineSrtSocket.connect(url: String) = connect(SrtUrl(url))
+
+/**
+ * Connects a socket to an URL.
+ *
+ * **See Also:** [srt_connect](https://github.com/Haivision/srt/blob/master/docs/API/API-functions.md#srt_connect)
+ *
+ * @param srtUrl the URL to connect to in FFmpeg format srt://hostname:port[?options]
+ * @throws ConnectException if connection has failed
+ */
+suspend fun CoroutineSrtSocket.connect(srtUrl: SrtUrl) {
+    if (srtUrl.mode != null) {
+        require(srtUrl.mode != SrtUrl.Mode.LISTENER) { "Connect is only for `caller` or `rendezvous` mode but ${srtUrl.mode}" }
+    }
+
+    srtUrl.preApplyTo(this)
+    connect(srtUrl.hostname, srtUrl.port)
+    srtUrl.postApplyTo(this)
+}
+
+/**
+ * Connects a socket to a specified address and port.
+ *
+ * **See Also:** [srt_connect](https://github.com/Haivision/srt/blob/master/docs/API/API-functions.md#srt_connect)
+ *
+ * @param address the address to connect to
+ * @param port the port to connect to
+ * @throws ConnectException if connection has failed
+ */
+suspend fun CoroutineSrtSocket.connect(address: String, port: Int) =
+    connect(InetSocketAddress(address, port))
+
+/**
+ * Connects a socket to a specified address and port.
+ *
+ * **See Also:** [srt_connect](https://github.com/Haivision/srt/blob/master/docs/API/API-functions.md#srt_connect)
+ *
+ * @param address the [InetAddress] to connect to
+ * @param port the port to connect to
+ * @throws ConnectException if connection has failed
+ */
+suspend fun CoroutineSrtSocket.connect(address: InetAddress, port: Int) =
+    connect(InetSocketAddress(address, port))
+
+/**
+ * Performs a rendezvous connection.
+ *
+ * **See Also:** [srt_rendezvous](https://github.com/Haivision/srt/blob/master/docs/API/API-functions.md#srt_rendezvous)
+ *
+ * @param url the URL to rendezvous to in FFmpeg format srt://hostname:port[?options]
+ * @throws SocketException if rendezvous connection has failed
+ */
+suspend fun CoroutineSrtSocket.rendezVous(url: String) = rendezVous(SrtUrl(url))
+
+/**
+ * Performs a rendezvous connection.
+ *
+ * **See Also:** [srt_rendezvous](https://github.com/Haivision/srt/blob/master/docs/API/API-functions.md#srt_rendezvous)
+ *
+ * @param srtUrl the URL to rendezvous to in FFmpeg format srt://hostname:port[?options]
+ * @throws SocketException if rendezvous connection has failed
+ */
+suspend fun CoroutineSrtSocket.rendezVous(
+    srtUrl: SrtUrl
+) {
+    if (srtUrl.mode != null) {
+        require(srtUrl.mode == SrtUrl.Mode.RENDEZ_VOUS) { "Connect is only for `caller` or `rendezvous` mode but ${srtUrl.mode}" }
+    }
+
+    srtUrl.preApplyTo(this)
+    rendezVous(srtUrl.hostname, srtUrl.hostname, srtUrl.port)
+    srtUrl.postApplyTo(this)
+}
+
+/**
+ * Performs a rendezvous connection.
+ *
+ * **See Also:** [srt_rendezvous](https://github.com/Haivision/srt/blob/master/docs/API/API-functions.md#srt_rendezvous)
+ *
+ * @param localAddress the local address to bind to
+ * @param remoteAddress the remote address to connect to
+ * @throws SocketException if rendezvous connection has failed
+ */
+suspend fun CoroutineSrtSocket.rendezVous(localAddress: String, remoteAddress: String, port: Int) =
+    rendezVous(
+        InetSocketAddress(localAddress, port),
+        InetSocketAddress(remoteAddress, port)
+    )
+
+/**
+ * Performs a rendezvous connection.
+ *
+ * **See Also:** [srt_rendezvous](https://github.com/Haivision/srt/blob/master/docs/API/API-functions.md#srt_rendezvous)
+ *
+ * @param localAddress the local [InetAddress] to bind to
+ * @param remoteAddress the remote [InetAddress] to connect to
+ * @throws SocketException if rendezvous connection has failed
+ */
+suspend fun CoroutineSrtSocket.rendezVous(
+    localAddress: InetAddress,
+    remoteAddress: InetAddress,
+    port: Int
+) = rendezVous(
+    InetSocketAddress(localAddress, port),
+    InetSocketAddress(remoteAddress, port)
+)
+
+/**
+ * Sends a message to a remote party.
+ *
+ * **See Also:** [srt_send](https://github.com/Haivision/srt/blob/master/docs/API/API-functions.md#srt_send)
+ *
+ * @param msg the [String] to send
+ * @return the number of byte sent
+ * @throws SocketException if it has failed to send message
+ * @throws SocketTimeoutException if a timeout has been triggered
+ * @see [recv]
+ */
+suspend fun CoroutineSrtSocket.send(msg: String) = send(msg.toByteArray())
+
+/**
+ * Sends a specified file.
+ *
+ * **See Also:** [srt_sendfile](https://github.com/Haivision/srt/blob/master/docs/API/API-functions.md#srt_sendfile)
+ *
+ * @param file the [File] to send
+ * @param offset the offset used to read file from
+ * @param size the size of the file
+ * @param block the size of the single block to read at once before writing it to a file
+ * @return the size (>0) of the transmitted data of a file.
+ * @throws SocketException if it has failed to send message
+ * @throws SocketTimeoutException if a timeout has been triggered
+ * @see [recvFile]
+ */
+suspend fun CoroutineSrtSocket.sendFile(
+    file: File,
+    offset: Long = 0,
+    size: Long = file.length(),
+    block: Int = 364000
+) = sendFile(file.path, offset, size, block)
+
+/**
+ * Receives a file. File is create in [file].
+ *
+ * **See Also:** [srt_recvfile](https://github.com/Haivision/srt/blob/master/docs/API/API-functions.md#srt_recvfile)
+ *
+ * @param file the [File] where to write received data
+ * @param offset the offset used to write file
+ * @param size the size of the file
+ * @param block the size of the single block to read at once before writing it to a file
+ * @return the size (>0) of the received data of a file.
+ * @throws SocketException if it has failed to send message
+ * @throws SocketTimeoutException if a timeout has been triggered
+ * @see [sendFile]
+ */
+suspend fun CoroutineSrtSocket.recvFile(
+    file: File,
+    offset: Long = 0,
+    size: Long,
+    block: Int = 7280000
+) = recvFile(file.path, offset, size, block)