From 5581ff0d0ee7dde1019fcf34cd9a051f220e3bd5 Mon Sep 17 00:00:00 2001 From: Nathan Zimmerberg <39104088+nhz2@users.noreply.github.com> Date: Sun, 8 Sep 2024 12:06:08 -0400 Subject: [PATCH] Add more details on order. --- src/codec.jl | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/src/codec.jl b/src/codec.jl index 0c0809f..75d03bd 100644 --- a/src/codec.jl +++ b/src/codec.jl @@ -84,10 +84,11 @@ the stream will become the close mode for safety. ### `startproc` The `startproc(codec::C, mode::Symbol, error::Error)::Symbol` method takes -`codec`, `mode` and `error`, and returns a status code. This is called just -before the stream starts reading or writing data. `mode` is either `:read` or -`:write` and then the stream starts reading or writing, respectively. The -return code must be `:ok` if `codec` is ready to read or write data. Otherwise, +`codec`, `mode`, and `error`, and returns a status code. This resets the state +of the codec and is called before the stream starts processing data. +After a call to `startproc`, `pledgeinsize` can be optionally called. +`mode` is either `:read` or `:write`. The +return code must be `:ok` if `codec` is ready to process data. Otherwise, it must be `:error` and the `error` argument must be set to an exception object. ### `process`