Skip to content

//okhttp/okhttp3/Handshake

Handshake

[jvm]\ class Handshake

A record of a TLS handshake. For HTTPS clients, the client is local and the remote server is its peer.

This value object describes a completed handshake. Use ConnectionSpec to set policy for new handshakes.

Types

Name Summary
Companion [jvm]
object Companion

Functions

Name Summary
equals [jvm]
open operator override fun equals(other: Any?): Boolean
hashCode [jvm]
open override fun hashCode(): Int
toString [jvm]
open override fun toString(): String

Properties

Name Summary
cipherSuite [jvm]
@get:JvmName(name = "cipherSuite")
val cipherSuite: CipherSuite
Returns the cipher suite used for the connection.
localCertificates [jvm]
@get:JvmName(name = "localCertificates")
val localCertificates: List<Certificate>
Returns a possibly-empty list of certificates that identify this peer.
localPrincipal [jvm]
@get:JvmName(name = "localPrincipal")
val localPrincipal: Principal?
Returns the local principle, or null if this peer is anonymous.
peerCertificates [jvm]
@get:JvmName(name = "peerCertificates")
val peerCertificates: List<Certificate>
Returns a possibly-empty list of certificates that identify the remote peer.
peerPrincipal [jvm]
@get:JvmName(name = "peerPrincipal")
val peerPrincipal: Principal?
Returns the remote peer’s principle, or null if that peer is anonymous.
tlsVersion [jvm]
@get:JvmName(name = "tlsVersion")
val tlsVersion: TlsVersion
Returns the TLS version used for this connection. This value wasn’t tracked prior to OkHttp 3.0. For responses cached by preceding versions this returns TlsVersion.SSL_3_0.