srtdroid-ktx/io.github.thibaultbee.srtdroid.ktx/CoroutineSrtSocket

CoroutineSrtSocket

class CoroutineSrtSocket : ConfigurableSrtSocket, CoroutineScope

A coroutine-based SRT socket.

Constructors

CoroutineSrtSocket

constructor()

Types

Companion

object Companion

IncomingSocket

data class IncomingSocket(val socket: CoroutineSrtSocket, val streamId: String)

Listening socket data class. Use to store the socket and the stream ID.

Properties

connectionTime

val connectionTime: Long

Gets the time when SRT socket was open to establish a connection.

coroutineContext

open override val coroutineContext: CompletableJob

incomingSocket

val incomingSocket: Flow<CoroutineSrtSocket.IncomingSocket>

Flow of incoming sockets. It is a hook before returning from accept. Reject an incoming connection by throwing an exception. Only for server sockets.

inetAddress

val inetAddress: InetAddress

Retrieves the remote InetAddress to which the socket is connected.

isBound

val isBound: Boolean

Tests if the SRT socket is bound.

isClose

val isClose: Boolean

Tests if the SRT socket is closed.

isConnected

val isConnected: Boolean

Tests if the SRT socket is connected.

isValid

val isValid: Boolean

Check if the SRT socket is a valid SRT socket.

localAddress

val localAddress: InetAddress

Extracts the InetAddress to which the socket was bound.

localPort

val localPort: Int

Extracts the port to which the socket was bound.

peerName

val peerName: InetSocketAddress

Retrieves the remote InetSocketAddress to which the SRT socket is connected.

port

val port: Int

Retrieves the port to which the SRT socket is connected.

receiveBufferSize

var receiveBufferSize: Int

Sets/gets the value of the SockOpt.RCVBUF option for this SRT socket.

rejectReason

var rejectReason: RejectReason

Set/get detailed reason for a failed connection attempt.

reuseAddress

var reuseAddress: Boolean

Tests if SockOpt.REUSEADDR is enabled.

sendBufferSize

var sendBufferSize: Int

Sets/gets the value of the SockOpt.SNDBUF option for this SRT socket.

socketContext

val socketContext: CompletableJob

sockName

val sockName: InetSocketAddress

Extracts the InetSocketAddress to which the socket was bound.

sockState

val sockState: SockStatus

Gets the current status of the socket.

soLinger

var soLinger: Int

Returns setting for SockOpt.LINGER.

Functions

suspend fun accept(): Pair<CoroutineSrtSocket, InetSocketAddress?>

Accepts a pending connection.

available

fun available(): Int

Get the size of the available data in the receive buffer.

bind

suspend fun bind(address: InetSocketAddress)

Binds the socket to a local address.

bind

suspend fun CoroutineSrtSocket.bind(srtUrl: SrtUrl)

suspend fun CoroutineSrtSocket.bind(url: String)

suspend fun CoroutineSrtSocket.bind(address: InetAddress, port: Int)

suspend fun CoroutineSrtSocket.bind(address: String, port: Int)

Binds the socket to a local address.

bistats

fun bistats(clear: Boolean, instantaneous: Boolean): Stats

Reports the current statistics.

bstats

fun bstats(clear: Boolean): Stats

Reports the current statistics.

fun close()

Closes the socket or group and frees all used resources.

connect

suspend fun connect(address: InetSocketAddress)

Connects a socket to a specified address and port.

connect

suspend fun CoroutineSrtSocket.connect(srtUrl: SrtUrl)

suspend fun CoroutineSrtSocket.connect(url: String)

Connects a socket to an URL.

suspend fun CoroutineSrtSocket.connect(address: InetAddress, port: Int)

suspend fun CoroutineSrtSocket.connect(address: String, port: Int)

Connects a socket to a specified address and port.

equals

open operator override fun equals(other: Any?): Boolean

getSockFlag

open override fun getSockFlag(opt: SockOpt): Any

Gets the value of the given socket option.

hashCode

open override fun hashCode(): Int

listen

fun listen(backlog: Int)

Sets up the listening state on a socket.

recv

suspend fun recv(size: Int): ByteArray

suspend fun recv(size: Int, msgCtrl: MsgCtrl): ByteArray

suspend fun recv(buffer: ByteArray, offset: Int = 0, byteCount: Int = buffer.size): Int

suspend fun recv(buffer: ByteArray, offset: Int = 0, byteCount: Int = buffer.size, msgCtrl: MsgCtrl): Int

Received a message from a remote device

recvFile

suspend fun recvFile(path: String, offset: Long = 0, size: Long, block: Int = 364000): Long

Receives a file. File will be located at path.

recvFile

suspend fun CoroutineSrtSocket.recvFile(file: File, offset: Long = 0, size: Long, block: Int = 7280000): Long

Receives a file. File is create in file.

rendezVous

suspend fun rendezVous(localAddress: InetSocketAddress, remoteAddress: InetSocketAddress)

Performs a rendezvous connection.

rendezVous

suspend fun CoroutineSrtSocket.rendezVous(srtUrl: SrtUrl)

suspend fun CoroutineSrtSocket.rendezVous(url: String)

suspend fun CoroutineSrtSocket.rendezVous(localAddress: InetAddress, remoteAddress: InetAddress, port: Int)

suspend fun CoroutineSrtSocket.rendezVous(localAddress: String, remoteAddress: String, port: Int)

Performs a rendezvous connection.

send

suspend fun send(msg: ByteBuffer): Int

suspend fun send(msg: ByteBuffer, msgCtrl: MsgCtrl): Int

suspend fun send(msg: ByteArray, offset: Int = 0, size: Int = msg.size): Int

suspend fun send(msg: ByteArray, offset: Int, size: Int, msgCtrl: MsgCtrl): Int

Sends a message to a remote party.

send

suspend fun CoroutineSrtSocket.send(msg: String): Int

Sends a message to a remote party.

sendFile

suspend fun sendFile(path: String, offset: Long = 0, size: Long, block: Int = 364000): Long

Sends a specified file.

sendFile

suspend fun CoroutineSrtSocket.sendFile(file: File, offset: Long = 0, size: Long = file.length(), block: Int = 364000): Long

Sends a specified file.

setSockFlag

open override fun setSockFlag(opt: SockOpt, value: Any)

Sets the value of the given socket option.