Skip to content

Latest commit

 

History

History
140 lines (92 loc) · 1.83 KB

input_API.md

File metadata and controls

140 lines (92 loc) · 1.83 KB
Raw

Input actor API

How to use: spawn an actor with script BSAL_INPUT_STREAM_SCRIPT and send it messages to interact with it in order to read sequence data.

Header

#include <input/input_stream.h>

(input/input_stream.h)

Message tags

BSAL_INPUT_OPEN

BSAL_INPUT_OPEN

Open an input file.

  • Request message buffer: File path (char *)
  • Responses:
BSAL_INPUT_OPEN_OK

Successful

  • Response message buffer: empty
BSAL_INPUT_ERROR_FILE_NOT_FOUND

File not found

  • Response message buffer: empty
BSAL_INPUT_ERROR_FORMAT_NOT_SUPPORTED

Format not supported

  • Response message buffer: empty

BSAL_INPUT_COUNT

BSAL_INPUT_COUNT

Count entries

  • Request message buffer: empty
  • Responses:
BSAL_INPUT_COUNT_PROGRESS

This is sent to notify supervisor about the progression.

  • Response message buffer: entries (int)
BSAL_INPUT_COUNT_RESULT

Counting has finished

  • Response message buffer: entries (int)
BSAL_INPUT_ERROR_NOT_OPEN

the actor is not open

  • Respons message buffer: empty

BSAL_INPUT_GET_SEQUENCE

BSAL_INPUT_GET_SEQUENCE

Read a sequence.

  • Request message buffer: empty
  • Responses:
BSAL_INPUT_GET_SEQUENCE_REPLY

The actor is open and there is a sequence to read

  • Response message buffer: sequence number (int), sequence (char *)
BSAL_INPUT_GET_SEQUENCE_END

there is nothing more to read

  • Response message buffer: empty
BSAL_INPUT_ERROR_NOT_OPEN

the actor is not open

  • Respons message buffer: empty

BSAL_INPUT_CLOSE

BSAL_INPUT_CLOSE

Close the file

  • Request message buffer: empty
  • Responses:
BSAL_INPUT_CLOSE_OK

successfully closed

  • Respons message buffer: empty
BSAL_INPUT_ERROR_NOT_OPEN

the actor is not open

  • Respons message buffer: empty