srtdroid-core/io.github.thibaultbee.srtdroid.core.models/SrtSocket

SrtSocket

class SrtSocket : ConfigurableSrtSocket, Closeable

This class represents a SRT socket. To avoid creating an unresponsive UI, don't perform SRT network operations on the main thread. Once it has been called, you must release Srt context with Srt.cleanUp when application leaves.

Constructors

constructor(af: StandardProtocolFamily)

Deprecated version of SrtSocket constructor. Argument is ignored. Also, it crashes on old Android version (where StandardProtocolFamily does not exist).

constructor()

Creates an SRT socket.

Types

interface ClientListener

This interface is used by a client SrtSocket to notify SRT socket events.

object Companion

interface ServerListener

This interface is used by a server SrtSocket to notify SRT socket events.

Properties

var clientListener: SrtSocket.ClientListener?

Client listeners

val connectionTime: Long

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

val inetAddress: InetAddress

Retrieves the remote InetAddress to which the socket is connected.

val isBound: Boolean

Tests if the SRT socket is bound.

val isClose: Boolean

Tests if the SRT socket is closed.

val isConnected: Boolean

Tests if the SRT socket is connected.

val isValid: Boolean

Check if the SRT socket is a valid SRT socket.

val localAddress: InetAddress

Extracts the InetAddress to which the socket was bound.

val localPort: Int

Extracts the port to which the socket was bound.

val peerName: InetSocketAddress

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

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.

var rejectReason: RejectReason

Set/get detailed reason for a failed connection attempt.

var reuseAddress: Boolean

Tests if SockOpt.REUSEADDR is enabled.

var sendBufferSize: Int

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

var serverListener: SrtSocket.ServerListener?

Server listeners

val sockName: InetSocketAddress

Extracts the InetSocketAddress to which the socket was bound.

val sockState: SockStatus

Gets the current status of the socket.

var soLinger: Int

Returns setting for SockOpt.LINGER.

Functions

fun accept(): Pair<SrtSocket, InetSocketAddress?>

Accepts a pending connection.

fun available(): Int

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

fun bind(address: InetSocketAddress)

fun bind(address: InetAddress, port: Int)

fun bind(address: String, port: Int)

Binds the socket to a local address.

fun SrtSocket.bind(srtUrl: SrtUrl)

fun SrtSocket.bind(url: String)

Binds the socket to a local address.

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

Reports the current statistics.

external fun bstats(clear: Boolean): Stats

Reports the current statistics.

open override fun close()

Closes the socket or group and frees all used resources.

fun connect(address: InetSocketAddress)

fun connect(address: InetAddress, port: Int)

fun connect(address: String, port: Int)

Connects a socket to a specified address and port.

fun SrtSocket.connect(srtUrl: SrtUrl)

fun SrtSocket.connect(url: String)

Connects a socket to an URL.

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

Return true if internal SRT socket are equals

fun getInputStream(msgCtrl: MsgCtrl? = null): InputStream

Returns an input stream for this socket.

getOutputStream

fun getOutputStream(msgCtrl: MsgCtrl? = null): OutputStream

Returns an output stream for this socket.

open override fun getSockFlag(opt: SockOpt): Any

Gets the value of the given socket option.

open override fun hashCode(): Int

fun listen(backlog: Int)

Sets up the listening state on a socket.

fun recv(size: Int): ByteArray

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

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

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

Received a message from a remote device

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

Receives a file. File will be located at path.

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

Receives a file. File will be located at path.

fun rendezVous(localAddress: InetSocketAddress, remoteAddress: InetSocketAddress)

fun rendezVous(localAddress: InetAddress, remoteAddress: InetAddress, port: Int)

fun rendezVous(localAddress: String, remoteAddress: String, port: Int)

Performs a rendezvous connection.

fun SrtSocket.rendezVous(srtUrl: SrtUrl)

fun SrtSocket.rendezVous(url: String)

Performs a rendezvous connection.

fun send(msg: ByteBuffer): Int

fun send(msg: ByteArray): Int

fun send(msg: String): Int

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

fun send(msg: ByteArray, msgCtrl: MsgCtrl): Int

fun send(msg: String, msgCtrl: MsgCtrl): Int

fun send(msg: ByteBuffer, ttl: Int = -1, inOrder: Boolean = false): Int

fun send(msg: ByteArray, ttl: Int = -1, inOrder: Boolean = false): Int

fun send(msg: ByteArray, offset: Int, size: Int): Int

fun send(msg: String, ttl: Int = -1, inOrder: Boolean = false): Int

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

fun send(msg: ByteArray, offset: Int, size: Int, ttl: Int = -1, inOrder: Boolean = false): Int

Sends a message to a remote party.

fun sendFile(file: File, block: Int = 364000): Long

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

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

Sends a specified file.

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

Sets the value of the given socket option.