DTLSSession

History

Represents a DTLS association with a single remote peer.

session.send

session.send(data): number

Attributes

data:string | Buffer

The data to send.

Returns:number

The number of bytes written to the DTLS layer.

Send application data to the peer. The data is encrypted by DTLS before being sent over UDP. Can only be called after the handshake completes (session.opened has resolved).

session.close

session.close(): Promise

Returns:Promise

Resolves when the session is closed.

Initiates a graceful DTLS shutdown by sending a close_notify alert.

session.destroy

session.destroy(error?): void

Immediately destroys the session without sending close_notify.

session.opened

Attributes

Promise

Resolves with { protocol } when the DTLS handshake completes.

session.closed

Attributes

Promise

Resolves when the session is fully closed.

session.remoteAddress

Returns:Object

{ address, family, port }

session.protocol

Returns:string

The negotiated DTLS protocol version (e.g., 'DTLSv1.2').

session.cipher

Returns:Object

{ name, standardName, version }

session.peerCertificate

Returns:string | undefined

The peer's certificate in PEM format.

session.alpnProtocol

Returns:string | undefined

The negotiated ALPN protocol.

session.srtpProfile

Returns:string | undefined

The negotiated SRTP protection profile name.

session.stats

History

Type:DTLSSession.Stats

The statistics collected for this session. Read only. The stats object is live and updated as data flows through the session.

session.exportKeyingMaterial

session.exportKeyingMaterial(length, label, context?): Buffer

Attributes

length:number

Number of bytes to export.

label:string

The label for the exported keying material.

context:Buffer

Optional context value.

Returns:Buffer

Exports keying material from the DTLS session, as defined in RFC 5705. This is commonly used with DTLS-SRTP to derive encryption keys for media streams.