socket/io.devconsole.socket/SocketRecorder

SocketRecorder

class SocketRecorder(redaction: RedactionEngine, store: SocketStore, enabled: Boolean = true, clock: () -> Long = System::currentTimeMillis)

Manual socket capture API. Every method is fail-open so host socket behavior remains isolated. When enabled is false, every method returns immediately without redacting or touching store.

One small function per socket lifecycle/frame event type plus the session-binding helpers; splitting further would fragment one cohesive fail-open recording boundary.

Constructors

SocketRecorder

constructor(redaction: RedactionEngine, store: SocketStore, enabled: Boolean = true, clock: () -> Long = System::currentTimeMillis)

constructor(redaction: RedactionEngine, store: SocketStore, enabled: Boolean, clock: () -> Long, binaryPreviewPolicy: BinaryPreviewPolicy)

Types

Companion

object Companion

Properties

protocol

val protocol: SocketProtocol

The protocol this recorder stamps onto every connection it opens. See withProtocol.

Functions

bindToCurrentSession

fun bindToCurrentSession(): SocketRecorder

Freezes the current app-run for delayed listener callbacks.

onBinaryMessage

fun onBinaryMessage(connectionId: String, direction: SocketDirection, bytes: ByteArray, contentType: String? = null)

fun onBinaryMessage(connectionId: String, direction: SocketDirection, length: Long, contentType: String? = null)

onCancelled

fun onCancelled(connectionId: String, reason: String? = null)

A host-initiated cancel is not a failure: it closes the connection like onClosed but with its own SocketLifecycleType.CANCELLED event so it reads as intentional, not an error.

onClosed

fun onClosed(connectionId: String, failed: Boolean = false, error: String? = null)

onClosing

fun onClosing(connectionId: String, code: Int? = null, reason: String? = null)

onCreated

fun onCreated(connectionId: String, url: String, reconnectAttempt: Int = 0)

onFailure

fun onFailure(connectionId: String, error: Throwable)

onMessage

fun onMessage(connectionId: String, direction: SocketDirection, text: String, contentType: String? = null)

onOpen

fun onOpen(connectionId: String, url: String, reconnectAttempt: Int = 0)

onPing

fun onPing(connectionId: String, direction: SocketDirection, bytes: ByteArray = ByteArray(0))

onPong

fun onPong(connectionId: String, direction: SocketDirection, bytes: ByteArray = ByteArray(0))

withOperationLock

fun withOperationLock(lock: Any): SocketRecorder

withProtocol

fun withProtocol(protocol: SocketProtocol): SocketRecorder

Returns a configured COPY stamped with protocol -- built the same way bindToCurrentSession builds one -- so the facade can hand the same base recorder instance to both a WebSocket and an MQTT adapter without either mutating the other's protocol.

withProtocolGate

fun withProtocolGate(gate: (SocketProtocol) -> Boolean): SocketRecorder

Apply-style, matching withSessionIdProvider/withOperationLock. Fail-open: see canRecord.

withSessionIdProvider

fun withSessionIdProvider(provider: () -> String?): SocketRecorder