Rename SSLReceiveOK to SSLAccepted, add InvalidOperation

SSLReceiveOK named the plumbing; SSLAccepted says what happened.
InvalidOperation signals a call on a session that is no longer
operational — _Disposed.receive and _Disposed.read return it
instead of silently pretending the operation succeeded.

Author: SeanTAllen

.release-notes/next-release.md

@@ -4,7 +4,7 @@
 
 ## Replace state polling with return values from receive, read, and send
 
-`state()`, `can_send()`, `SSLState`, `SSLHandshake`, and `SSLDisposed` are removed. The return values of `receive()`, `read()`, and `send()` carry the outcome of each operation.
+`state()`, `can_send()`, `SSLState`, `SSLHandshake`, and `SSLDisposed` are removed. The return values of `receive()`, `read()`, and `send()` carry the outcome of each operation. `InvalidOperation` signals a call on a session that is no longer operational (disposed).
 
 `receive(data)` returns `SSLReceiveResult`:
 
@@ -21,10 +21,11 @@ end
 
 // After
 match ssl.receive(data)
-| SSLReceiveOK => None
+| SSLAccepted => None
 | SSLReady => // ...
 | SSLAuthFail => // ...
 | SSLError => // ...
+| InvalidOperation => // ...
 end
 ```
 
@@ -43,6 +44,7 @@ match ssl.read()
 | None => // ...
 | SSLClosed => // ...
 | SSLError => // ...
+| InvalidOperation => // ...
 end
 ```
 

ssl/net/_ssl_session_state.pony

@@ -32,7 +32,7 @@ class _Handshaking is _SSLSessionState
 class _Ready is _SSLSessionState
   fun ref receive(ssl: SSL ref, data: ByteSeq): SSLReceiveResult =>
     ssl._do_receive(data)
-    SSLReceiveOK
+    SSLAccepted
 
   fun ref read(ssl: SSL ref, expect: USize): SSLReadResult =>
     ssl._do_read(expect)
@@ -60,14 +60,15 @@ class _Closing is _SSLSessionState
 
   fun ref receive(ssl: SSL ref, data: ByteSeq): SSLReceiveResult =>
     ssl._do_receive(data)
-    SSLReceiveOK
+    SSLAccepted
 
   fun ref read(ssl: SSL ref, expect: USize): SSLReadResult =>
     match \exhaustive\ ssl._do_read(expect)
     | let data: Array[U8] iso => consume data
     | None => SSLClosed
     | SSLClosed => SSLClosed
     | SSLError => SSLError
+    | InvalidOperation => _Unreachable(); SSLError
     end
 
   fun ref write(ssl: SSL ref, data: ByteSeq) ? => error
@@ -91,7 +92,7 @@ class _Closed is _SSLSessionState
 
   fun ref receive(ssl: SSL ref, data: ByteSeq): SSLReceiveResult =>
     ssl._do_receive(data)
-    SSLReceiveOK
+    SSLAccepted
 
   fun ref read(ssl: SSL ref, expect: USize): SSLReadResult =>
     let result = ssl._do_read(expect)
@@ -101,6 +102,7 @@ class _Closed is _SSLSessionState
     | None => SSLClosed
     | SSLClosed => SSLClosed
     | SSLError => SSLError
+    | InvalidOperation => _Unreachable(); SSLError
     end
 
   fun ref write(ssl: SSL ref, data: ByteSeq) ? => error
@@ -118,9 +120,9 @@ class _Closed is _SSLSessionState
 
 class _Disposed is _SSLSessionState
   fun ref receive(ssl: SSL ref, data: ByteSeq): SSLReceiveResult =>
-    SSLReceiveOK
+    InvalidOperation
 
-  fun ref read(ssl: SSL ref, expect: USize): SSLReadResult => None
+  fun ref read(ssl: SSL ref, expect: USize): SSLReadResult => InvalidOperation
 
   fun ref write(ssl: SSL ref, data: ByteSeq) => None