SSLConnection

[Source]

Wrap another protocol in an SSL connection.

A finished handshake reaches the wrapped protocol as connected on a session that connected out, or accepted on one that was connected to. A failed one reaches it as auth_failed when the session is in SSLAuthFail, and as nothing at all when the session is in SSLError. The connection closes on either failure. SSLAuthFail and SSLError each list the failures they cover.

class ref SSLConnection is
  TCPConnectionNotify ref

Implements

• TCPConnectionNotify ref

---

Constructors

create

[Source]

Initialise with a wrapped protocol and an SSL session.

new iso create(
  notify: TCPConnectionNotify iso,
  ssl: SSL iso)
: SSLConnection iso^

Parameters

• notify: TCPConnectionNotify iso
• ssl: SSL iso

Returns

• SSLConnection iso^

---

Public Functions

accepted

[Source]

Swallow this event until the handshake is complete.

fun ref accepted(
  conn: TCPConnection ref)
: None val

Parameters

• conn: TCPConnection ref

Returns

• None val

---

connecting

[Source]

Forward to the wrapped protocol.

fun ref connecting(
  conn: TCPConnection ref,
  count: U32 val)
: None val

Parameters

• conn: TCPConnection ref
• count: U32 val

Returns

• None val

---

connected

[Source]

Swallow this event until the handshake is complete.

fun ref connected(
  conn: TCPConnection ref)
: None val

Parameters

• conn: TCPConnection ref

Returns

• None val

---

connect_failed

[Source]

Forward to the wrapped protocol.

fun ref connect_failed(
  conn: TCPConnection ref)
: None val

Parameters

• conn: TCPConnection ref

Returns

• None val

---

sent

[Source]

Pass the data to the SSL session and check for both new application data and new destination data.

fun ref sent(
  conn: TCPConnection ref,
  data: ByteSeq)
: ByteSeq

Parameters

• conn: TCPConnection ref
• data: ByteSeq

Returns

• ByteSeq

---

sentv

[Source]

Pass each sequence to the SSL session and check for both new application data and new destination data. Returns an empty sequence: what leaves the connection is the ciphertext _poll writes, not these bytes.

fun ref sentv(
  conn: TCPConnection ref,
  data: ByteSeqIter val)
: ByteSeqIter val

Parameters

• conn: TCPConnection ref
• data: ByteSeqIter val

Returns

• ByteSeqIter val

---

received

[Source]

Pass the data to the SSL session and check for both new application data and new destination data.

fun ref received(
  conn: TCPConnection ref,
  data: Array[U8 val] iso,
  times: USize val)
: Bool val

Parameters

• conn: TCPConnection ref
• data: Array[U8 val] iso
• times: USize val

Returns

• Bool val

---

expect

[Source]

Keep track of the expect count for the wrapped protocol. Always tell the TCPConnection to read all available data.

fun ref expect(
  conn: TCPConnection ref,
  qty: USize val)
: USize val

Parameters

• conn: TCPConnection ref
• qty: USize val

Returns

• USize val

---

closed

[Source]

Forward to the wrapped protocol.

fun ref closed(
  conn: TCPConnection ref)
: None val

Parameters

• conn: TCPConnection ref

Returns

• None val

---

throttled

[Source]

Forward to the wrapped protocol.

fun ref throttled(
  conn: TCPConnection ref)
: None val

Parameters

• conn: TCPConnection ref

Returns

• None val

---

unthrottled

[Source]

Forward to the wrapped protocol.

fun ref unthrottled(
  conn: TCPConnection ref)
: None val

Parameters

• conn: TCPConnection ref

Returns

• None val

---

proxy_via

[Source]

fun ref proxy_via(
  host: String val,
  service: String val)
: (String val , String val)

Parameters

• host: String val
• service: String val

Returns

• (String val , String val)

---

auth_failed

[Source]

fun ref auth_failed(
  conn: TCPConnection ref)
: None val

Parameters

• conn: TCPConnection ref

Returns

• None val

---