Client tcp connection notify

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
use lori = ".."
use net = "net"
use "ssl/net"

trait ClientTCPConnectionNotify
  """
  Callbacks for a client-side TCP connection. Implement this trait and pass it
  to `ClientTCPConnection` to handle connection events.

  All callbacks receive the connection as `conn ref`, so synchronous methods
  on the connection (socket options, `buffer_until`, `close`, etc.) are
  callable from any callback. Behaviors like `write` are also callable but
  execute on the next turn.

  Every callback has a default implementation except `on_connect_failed`,
  which must be implemented because ignoring a failed connection is never
  correct.
  """
  fun ref on_connecting(conn: ClientTCPConnection ref, count: U32) =>
    """
    Called when at least one TCP connection attempt is in progress. `count` is
    the number of attempts currently inflight. Called again each time the count
    changes, until `on_connected` or `on_connect_failed` fires.
    """
    None

  fun ref on_connected(conn: ClientTCPConnection ref) =>
    """
    Called when the connection is ready for application data. For SSL
    connections, this fires after the TLS handshake completes.
    """
    None

  fun ref on_connect_failed(conn: ClientTCPConnection ref,
    reason: lori.ConnectionFailureReason)
    """
    Called when the connection cannot be established. `reason` identifies the
    failure stage: DNS resolution, TCP connect, SSL handshake, timeout, or
    timer error.
    """

  fun ref on_received(conn: ClientTCPConnection ref, data: Array[U8] iso):
    lori.ReadAction
  =>
    """
    Called when data arrives on the connection. Return `KeepReading` to
    continue reading or `YieldReading` to stop after this message and give
    other actors a turn.
    """
    lori.KeepReading

  fun ref on_send_accepted(conn: ClientTCPConnection ref,
    token: lori.SendToken,
    data: (ByteSeq | ByteSeqIter))
  =>
    """
    Called when a `write` or `writev` is accepted. Because `write` and `writev`
    are behaviors, this fires in their behavior turn, not during the callback
    that called `write`. `token` identifies this send and arrives exactly once
    more at `on_sent` or `on_send_failed`.
    """
    None

  fun ref on_sent(conn: ClientTCPConnection ref, token: lori.SendToken) =>
    """
    Called when the bytes from an accepted send have been handed to the OS.
    The token matches the one delivered by `on_send_accepted`.
    """
    None

  fun ref on_send_failed(conn: ClientTCPConnection ref,
    token: lori.SendToken)
  =>
    """
    Called when an accepted send's bytes could not reach the OS because the
    connection was lost or hard-closed first. Arrives after `on_closed`.
    """
    None

  fun ref on_throttled(conn: ClientTCPConnection ref) =>
    """
    Called when the connection applies backpressure. `write` calls after this
    are silently dropped until `on_unthrottled` fires.
    """
    None

  fun ref on_unthrottled(conn: ClientTCPConnection ref) =>
    """
    Called when backpressure is released and the connection is writeable again.
    """
    None

  fun ref on_closed(conn: ClientTCPConnection ref) =>
    """
    Called when the connection is closed.
    """
    None

  fun ref on_tls_ready(conn: ClientTCPConnection ref) =>
    """
    Called when a TLS handshake initiated by `start_tls()` completes. The
    connection is now encrypted.
    """
    None

  fun ref on_tls_failure(conn: ClientTCPConnection ref,
    reason: lori.TLSFailureReason)
  =>
    """
    Called when a TLS handshake initiated by `start_tls()` fails. `on_closed`
    follows.
    """
    None

  fun ref on_idle_timeout(conn: ClientTCPConnection ref) =>
    """
    Called when no data has been sent or received for the duration configured
    by `conn.idle_timeout()`. The timer re-arms automatically.
    """
    None

  fun ref on_idle_timer_failure(conn: ClientTCPConnection ref) =>
    """
    Called when the idle timer's ASIO event subscription fails. The timer has
    been cancelled; call `conn.idle_timeout(duration)` to retry.
    """
    None

  fun ref on_timer(conn: ClientTCPConnection ref, token: lori.TimerToken) =>
    """
    Called when a one-shot timer created by `conn.set_timer()` fires. The
    token matches the one returned by `set_timer()`. Call `set_timer()` again
    to re-arm.
    """
    None

  fun ref on_timer_failure(conn: ClientTCPConnection ref) =>
    """
    Called when a user timer's ASIO event subscription fails. The timer has
    been cancelled; call `conn.set_timer(duration)` to create a new one.
    """
    None