diff options
| author | Gerhard Sittig <gerhard.sittig@gmx.net> | 2021-12-26 07:42:27 +0100 |
|---|---|---|
| committer | Gerhard Sittig <gerhard.sittig@gmx.net> | 2021-12-26 13:45:09 +0100 |
| commit | 819e508972da02a0dcff7f81178f0283546a9afd (patch) | |
| tree | 5a48cb02cf7b712e2d152e547b7fab6ab969c8dd /libsigrokdecode.h | |
| parent | 487890c822762d9886dfd022ed599c9909ceaab9 (diff) | |
| download | libsigrokdecode-819e508972da02a0dcff7f81178f0283546a9afd.tar.gz libsigrokdecode-819e508972da02a0dcff7f81178f0283546a9afd.zip | |
session: introduce the public "send EOF" API routine
Introduce the public srd_session_send_eof() routine which is backed by
the internal srd_inst_send_eof() helper. Applications can tell decoders
when the input stream of sample data is exhausted, so that decoders can
optionally "flush" their previously accumulated information when
desired. Previous implementations just kept decoders in blocking .wait()
calls and somehow terminated them at arbitrary times afterwards.
When EOF is sent to the decoder session, then calls to the .wait()
method which typically are done from .decode() or its descendents will
end with an EOFError Python exception. Termination of .decode() with the
EOFError exception is non-fatal for backwards compatibility and to keep
the convenience for current decoder implementations. Decoders can either
catch the exception, or use context managers, or do nothing.
This API extension is motivated by research for bug #1581 and provides
the infrastructure to address bug #292. Decoders need to remain careful,
and should not claim that protocol activities would have completed when
their end condition was not even seen in the capture. Marking incomplete
activities with warnings is the most appropriate reaction.
Diffstat (limited to 'libsigrokdecode.h')
| -rw-r--r-- | libsigrokdecode.h | 4 |
1 files changed, 4 insertions, 0 deletions
diff --git a/libsigrokdecode.h b/libsigrokdecode.h index 3ce6ae5..cf6479c 100644 --- a/libsigrokdecode.h +++ b/libsigrokdecode.h @@ -291,6 +291,9 @@ struct srd_decoder_inst { /** Requests termination of wait() and decode(). */ gboolean want_wait_terminate; + /** Requests that .wait() terminates a Python iteration. */ + gboolean communicate_eof; + /** Indicates the current state of the decoder stack. */ int decoder_state; @@ -353,6 +356,7 @@ SRD_API int srd_session_metadata_set(struct srd_session *sess, int key, SRD_API int srd_session_send(struct srd_session *sess, uint64_t abs_start_samplenum, uint64_t abs_end_samplenum, const uint8_t *inbuf, uint64_t inbuflen, uint64_t unitsize); +SRD_API int srd_session_send_eof(struct srd_session *sess); SRD_API int srd_session_terminate_reset(struct srd_session *sess); SRD_API int srd_session_destroy(struct srd_session *sess); SRD_API int srd_pd_output_callback_add(struct srd_session *sess, |