MQTT - RED Brick

This is the description of the MQTT API bindings for the RED Brick. General information and technical specifications for the RED Brick are summarized in its hardware description.

An installation guide for the MQTT API bindings is part of their general description.

Examples

The example code below is Public Domain (CC0 1.0).

API

All published payload to an from the MQTT bindings is in the JSON format.

If an error occures, the bindings publish a JSON object containing the error message as attribute "_ERROR". It is published on the corresponding response topic: .../response/... for .../request/... and .../callback/... for .../register/....

Note

The API documentation for the RED Brick is currently incomplete.

The RED Brick API is meant to be used by the Brick Viewer to implement the offered functionality (getting status information, managing programs etc.). Normal users will not need to use this API, it may only be interesting for power users.

FIXME: explain sessions

The RED Brick API operates on reference counted objects (strings, lists, files, directories, processes and programs) that are identified by their 16bit object ID. Functions that allocate or return an object ID (e.g. request/red_brick/<UID>/allocate_string and request/red_brick/<UID>/get_next_directory_entry) increase the reference count of the returned object. If the object is no longer needed then request/red_brick/<UID>/release_object has to be called to decrease the reference count of the object again. In contrast to allocation and getter functions, the reference count for an object returned by a callback is not increased and request/red_brick/<UID>/release_object must not be called for such an object in response to a callback.

There are functions (e.g. request/red_brick/<UID>/get_file_info) that only return valid objects under certain conditions. This conditions are documented for the specific functions. For invalid objects request/red_brick/<UID>/release_object must not be called.

There are also function (e.g. request/red_brick/<UID>/set_program_stdio_redirection) that have conditionally unused object parameters. Under which conditions an object parameter is unused is documented for the specific functions. For unused object parameters 0 has to be passed as object ID.

The RED Brick API is more complex then the typical Brick API and requires more elaborate error reporting than the TCP/IP protocol can provide with its 2bit error code. Therefore, almost all functions of the RED Brick API return an 8bit error code. Possible error codes are:

  • Success = 0
  • UnknownError = 1
  • InvalidOperation = 2
  • OperationAborted = 3
  • InternalError = 4
  • UnknownSessionID = 5
  • NoFreeSessionID = 6
  • UnknownObjectID = 7
  • NoFreeObjectID = 8
  • ObjectIsLocked = 9
  • NoMoreData = 10
  • WrongListItemType = 11
  • ProgramIsPurged = 12
  • InvalidParameter = 128 (EINVAL)
  • NoFreeMemory = 129 (ENOMEM)
  • NoFreeSpace = 130 (ENOSPC)
  • AccessDenied = 131 (EACCES)
  • AlreadyExists = 132 (EEXIST)
  • DoesNotExist = 133 (ENOENT)
  • Interrupted = 134 (EINTR)
  • IsDirectory = 135 (EISDIR)
  • NotADirectory = 136 (ENOTDIR)
  • WouldBlock = 137 (EWOULDBLOCK)
  • Overflow = 138 (EOVERFLOW)
  • BadFileDescriptor = 139 (EBADF)
  • OutOfRange = 140 (ERANGE)
  • NameTooLong = 141 (ENAMETOOLONG)
  • InvalidSeek = 142 (ESPIPE)
  • NotSupported = 143 (ENOTSUP)
  • TooManyOpenFiles = 144 (EMFILE)

If a function returns an error code other than Success then its other return values (if any) are invalid and must not be used.

The error code InvalidOperation is returned if the requested operation cannot be performed because the current state of the object does not allow it. For example, trying to append an item to a full list object or trying to undefine an already undefined program.

The error code NotSupported is returned if the requested operation can never be performed. For example, trying to append a list object to itself, trying to get the name of a file object with type Pipe or trying to create a directory non-recursively with more than the last part of the directory name referring to non-existing directories.

String objects store UTF-8 encoded data.

Advanced Functions

request/red_brick/<UID>/create_session
Request payload:
 
  • lifetime -- int
Response payload:
 
  • error_code -- int (has symbols)
  • session_id -- int

The following symbols are available for this function:

for error_code:

  • "Success" = 0
  • "UnknownError" = 1
  • "InvalidOperation" = 2
  • "OperationAborted" = 3
  • "InternalError" = 4
  • "UnknownSessionId" = 5
  • "NoFreeSessionId" = 6
  • "UnknownObjectId" = 7
  • "NoFreeObjectId" = 8
  • "ObjectIsLocked" = 9
  • "NoMoreData" = 10
  • "WrongListItemType" = 11
  • "ProgramIsPurged" = 12
  • "InvalidParameter" = 128
  • "NoFreeMemory" = 129
  • "NoFreeSpace" = 130
  • "AccessDenied" = 121
  • "AlreadyExists" = 132
  • "DoesNotExist" = 133
  • "Interrupted" = 134
  • "IsDirectory" = 135
  • "NotADirectory" = 136
  • "WouldBlock" = 137
  • "Overflow" = 138
  • "BadFileDescriptor" = 139
  • "OutOfRange" = 140
  • "NameTooLong" = 141
  • "InvalidSeek" = 142
  • "NotSupported" = 143
  • "TooManyOpenFiles" = 144
request/red_brick/<UID>/expire_session
Request payload:
 
  • session_id -- int
Response payload:
 
  • error_code -- int (has symbols)

The following symbols are available for this function:

for error_code:

  • "Success" = 0
  • "UnknownError" = 1
  • "InvalidOperation" = 2
  • "OperationAborted" = 3
  • "InternalError" = 4
  • "UnknownSessionId" = 5
  • "NoFreeSessionId" = 6
  • "UnknownObjectId" = 7
  • "NoFreeObjectId" = 8
  • "ObjectIsLocked" = 9
  • "NoMoreData" = 10
  • "WrongListItemType" = 11
  • "ProgramIsPurged" = 12
  • "InvalidParameter" = 128
  • "NoFreeMemory" = 129
  • "NoFreeSpace" = 130
  • "AccessDenied" = 121
  • "AlreadyExists" = 132
  • "DoesNotExist" = 133
  • "Interrupted" = 134
  • "IsDirectory" = 135
  • "NotADirectory" = 136
  • "WouldBlock" = 137
  • "Overflow" = 138
  • "BadFileDescriptor" = 139
  • "OutOfRange" = 140
  • "NameTooLong" = 141
  • "InvalidSeek" = 142
  • "NotSupported" = 143
  • "TooManyOpenFiles" = 144
request/red_brick/<UID>/expire_session_unchecked
Request payload:
 
  • session_id -- int
request/red_brick/<UID>/keep_session_alive
Request payload:
 
  • session_id -- int
  • lifetime -- int
Response payload:
 
  • error_code -- int (has symbols)

The following symbols are available for this function:

for error_code:

  • "Success" = 0
  • "UnknownError" = 1
  • "InvalidOperation" = 2
  • "OperationAborted" = 3
  • "InternalError" = 4
  • "UnknownSessionId" = 5
  • "NoFreeSessionId" = 6
  • "UnknownObjectId" = 7
  • "NoFreeObjectId" = 8
  • "ObjectIsLocked" = 9
  • "NoMoreData" = 10
  • "WrongListItemType" = 11
  • "ProgramIsPurged" = 12
  • "InvalidParameter" = 128
  • "NoFreeMemory" = 129
  • "NoFreeSpace" = 130
  • "AccessDenied" = 121
  • "AlreadyExists" = 132
  • "DoesNotExist" = 133
  • "Interrupted" = 134
  • "IsDirectory" = 135
  • "NotADirectory" = 136
  • "WouldBlock" = 137
  • "Overflow" = 138
  • "BadFileDescriptor" = 139
  • "OutOfRange" = 140
  • "NameTooLong" = 141
  • "InvalidSeek" = 142
  • "NotSupported" = 143
  • "TooManyOpenFiles" = 144
request/red_brick/<UID>/release_object
Request payload:
 
  • object_id -- int
  • session_id -- int
Response payload:
 
  • error_code -- int (has symbols)

Decreases the reference count of an object by one and returns the resulting error code. If the reference count reaches zero the object gets destroyed.

The following symbols are available for this function:

for error_code:

  • "Success" = 0
  • "UnknownError" = 1
  • "InvalidOperation" = 2
  • "OperationAborted" = 3
  • "InternalError" = 4
  • "UnknownSessionId" = 5
  • "NoFreeSessionId" = 6
  • "UnknownObjectId" = 7
  • "NoFreeObjectId" = 8
  • "ObjectIsLocked" = 9
  • "NoMoreData" = 10
  • "WrongListItemType" = 11
  • "ProgramIsPurged" = 12
  • "InvalidParameter" = 128
  • "NoFreeMemory" = 129
  • "NoFreeSpace" = 130
  • "AccessDenied" = 121
  • "AlreadyExists" = 132
  • "DoesNotExist" = 133
  • "Interrupted" = 134
  • "IsDirectory" = 135
  • "NotADirectory" = 136
  • "WouldBlock" = 137
  • "Overflow" = 138
  • "BadFileDescriptor" = 139
  • "OutOfRange" = 140
  • "NameTooLong" = 141
  • "InvalidSeek" = 142
  • "NotSupported" = 143
  • "TooManyOpenFiles" = 144
request/red_brick/<UID>/release_object_unchecked
Request payload:
 
  • object_id -- int
  • session_id -- int
request/red_brick/<UID>/allocate_string
Request payload:
 
  • length_to_reserve -- int
  • buffer -- string
  • session_id -- int
Response payload:
 
  • error_code -- int (has symbols)
  • string_id -- int

Allocates a new string object, reserves length_to_reserve bytes memory for it and sets up to the first 60 bytes. Set length_to_reserve to the length of the string that should be stored in the string object.

Returns the object ID of the new string object and the resulting error code.

The following symbols are available for this function:

for error_code:

  • "Success" = 0
  • "UnknownError" = 1
  • "InvalidOperation" = 2
  • "OperationAborted" = 3
  • "InternalError" = 4
  • "UnknownSessionId" = 5
  • "NoFreeSessionId" = 6
  • "UnknownObjectId" = 7
  • "NoFreeObjectId" = 8
  • "ObjectIsLocked" = 9
  • "NoMoreData" = 10
  • "WrongListItemType" = 11
  • "ProgramIsPurged" = 12
  • "InvalidParameter" = 128
  • "NoFreeMemory" = 129
  • "NoFreeSpace" = 130
  • "AccessDenied" = 121
  • "AlreadyExists" = 132
  • "DoesNotExist" = 133
  • "Interrupted" = 134
  • "IsDirectory" = 135
  • "NotADirectory" = 136
  • "WouldBlock" = 137
  • "Overflow" = 138
  • "BadFileDescriptor" = 139
  • "OutOfRange" = 140
  • "NameTooLong" = 141
  • "InvalidSeek" = 142
  • "NotSupported" = 143
  • "TooManyOpenFiles" = 144
request/red_brick/<UID>/truncate_string
Request payload:
 
  • string_id -- int
  • length -- int
Response payload:
 
  • error_code -- int (has symbols)

Truncates a string object to length bytes and returns the resulting error code.

The following symbols are available for this function:

for error_code:

  • "Success" = 0
  • "UnknownError" = 1
  • "InvalidOperation" = 2
  • "OperationAborted" = 3
  • "InternalError" = 4
  • "UnknownSessionId" = 5
  • "NoFreeSessionId" = 6
  • "UnknownObjectId" = 7
  • "NoFreeObjectId" = 8
  • "ObjectIsLocked" = 9
  • "NoMoreData" = 10
  • "WrongListItemType" = 11
  • "ProgramIsPurged" = 12
  • "InvalidParameter" = 128
  • "NoFreeMemory" = 129
  • "NoFreeSpace" = 130
  • "AccessDenied" = 121
  • "AlreadyExists" = 132
  • "DoesNotExist" = 133
  • "Interrupted" = 134
  • "IsDirectory" = 135
  • "NotADirectory" = 136
  • "WouldBlock" = 137
  • "Overflow" = 138
  • "BadFileDescriptor" = 139
  • "OutOfRange" = 140
  • "NameTooLong" = 141
  • "InvalidSeek" = 142
  • "NotSupported" = 143
  • "TooManyOpenFiles" = 144
request/red_brick/<UID>/get_string_length
Request payload:
 
  • string_id -- int
Response payload:
 
  • error_code -- int (has symbols)
  • length -- int

Returns the length of a string object in bytes and the resulting error code.

The following symbols are available for this function:

for error_code:

  • "Success" = 0
  • "UnknownError" = 1
  • "InvalidOperation" = 2
  • "OperationAborted" = 3
  • "InternalError" = 4
  • "UnknownSessionId" = 5
  • "NoFreeSessionId" = 6
  • "UnknownObjectId" = 7
  • "NoFreeObjectId" = 8
  • "ObjectIsLocked" = 9
  • "NoMoreData" = 10
  • "WrongListItemType" = 11
  • "ProgramIsPurged" = 12
  • "InvalidParameter" = 128
  • "NoFreeMemory" = 129
  • "NoFreeSpace" = 130
  • "AccessDenied" = 121
  • "AlreadyExists" = 132
  • "DoesNotExist" = 133
  • "Interrupted" = 134
  • "IsDirectory" = 135
  • "NotADirectory" = 136
  • "WouldBlock" = 137
  • "Overflow" = 138
  • "BadFileDescriptor" = 139
  • "OutOfRange" = 140
  • "NameTooLong" = 141
  • "InvalidSeek" = 142
  • "NotSupported" = 143
  • "TooManyOpenFiles" = 144
request/red_brick/<UID>/set_string_chunk
Request payload:
 
  • string_id -- int
  • offset -- int
  • buffer -- string
Response payload:
 
  • error_code -- int (has symbols)

Sets a chunk of up to 58 bytes in a string object beginning at offset.

Returns the resulting error code.

The following symbols are available for this function:

for error_code:

  • "Success" = 0
  • "UnknownError" = 1
  • "InvalidOperation" = 2
  • "OperationAborted" = 3
  • "InternalError" = 4
  • "UnknownSessionId" = 5
  • "NoFreeSessionId" = 6
  • "UnknownObjectId" = 7
  • "NoFreeObjectId" = 8
  • "ObjectIsLocked" = 9
  • "NoMoreData" = 10
  • "WrongListItemType" = 11
  • "ProgramIsPurged" = 12
  • "InvalidParameter" = 128
  • "NoFreeMemory" = 129
  • "NoFreeSpace" = 130
  • "AccessDenied" = 121
  • "AlreadyExists" = 132
  • "DoesNotExist" = 133
  • "Interrupted" = 134
  • "IsDirectory" = 135
  • "NotADirectory" = 136
  • "WouldBlock" = 137
  • "Overflow" = 138
  • "BadFileDescriptor" = 139
  • "OutOfRange" = 140
  • "NameTooLong" = 141
  • "InvalidSeek" = 142
  • "NotSupported" = 143
  • "TooManyOpenFiles" = 144
request/red_brick/<UID>/get_string_chunk
Request payload:
 
  • string_id -- int
  • offset -- int
Response payload:
 
  • error_code -- int (has symbols)
  • buffer -- string

Returns a chunk up to 63 bytes from a string object beginning at offset and returns the resulting error code.

The following symbols are available for this function:

for error_code:

  • "Success" = 0
  • "UnknownError" = 1
  • "InvalidOperation" = 2
  • "OperationAborted" = 3
  • "InternalError" = 4
  • "UnknownSessionId" = 5
  • "NoFreeSessionId" = 6
  • "UnknownObjectId" = 7
  • "NoFreeObjectId" = 8
  • "ObjectIsLocked" = 9
  • "NoMoreData" = 10
  • "WrongListItemType" = 11
  • "ProgramIsPurged" = 12
  • "InvalidParameter" = 128
  • "NoFreeMemory" = 129
  • "NoFreeSpace" = 130
  • "AccessDenied" = 121
  • "AlreadyExists" = 132
  • "DoesNotExist" = 133
  • "Interrupted" = 134
  • "IsDirectory" = 135
  • "NotADirectory" = 136
  • "WouldBlock" = 137
  • "Overflow" = 138
  • "BadFileDescriptor" = 139
  • "OutOfRange" = 140
  • "NameTooLong" = 141
  • "InvalidSeek" = 142
  • "NotSupported" = 143
  • "TooManyOpenFiles" = 144
request/red_brick/<UID>/allocate_list
Request payload:
 
  • length_to_reserve -- int
  • session_id -- int
Response payload:
 
  • error_code -- int (has symbols)
  • list_id -- int

Allocates a new list object and reserves memory for length_to_reserve items. Set length_to_reserve to the number of items that should be stored in the list object.

Returns the object ID of the new list object and the resulting error code.

When a list object gets destroyed then the reference count of each object in the list object is decreased by one.

The following symbols are available for this function:

for error_code:

  • "Success" = 0
  • "UnknownError" = 1
  • "InvalidOperation" = 2
  • "OperationAborted" = 3
  • "InternalError" = 4
  • "UnknownSessionId" = 5
  • "NoFreeSessionId" = 6
  • "UnknownObjectId" = 7
  • "NoFreeObjectId" = 8
  • "ObjectIsLocked" = 9
  • "NoMoreData" = 10
  • "WrongListItemType" = 11
  • "ProgramIsPurged" = 12
  • "InvalidParameter" = 128
  • "NoFreeMemory" = 129
  • "NoFreeSpace" = 130
  • "AccessDenied" = 121
  • "AlreadyExists" = 132
  • "DoesNotExist" = 133
  • "Interrupted" = 134
  • "IsDirectory" = 135
  • "NotADirectory" = 136
  • "WouldBlock" = 137
  • "Overflow" = 138
  • "BadFileDescriptor" = 139
  • "OutOfRange" = 140
  • "NameTooLong" = 141
  • "InvalidSeek" = 142
  • "NotSupported" = 143
  • "TooManyOpenFiles" = 144
request/red_brick/<UID>/get_list_length
Request payload:
 
  • list_id -- int
Response payload:
 
  • error_code -- int (has symbols)
  • length -- int

Returns the length of a list object in items and the resulting error code.

The following symbols are available for this function:

for error_code:

  • "Success" = 0
  • "UnknownError" = 1
  • "InvalidOperation" = 2
  • "OperationAborted" = 3
  • "InternalError" = 4
  • "UnknownSessionId" = 5
  • "NoFreeSessionId" = 6
  • "UnknownObjectId" = 7
  • "NoFreeObjectId" = 8
  • "ObjectIsLocked" = 9
  • "NoMoreData" = 10
  • "WrongListItemType" = 11
  • "ProgramIsPurged" = 12
  • "InvalidParameter" = 128
  • "NoFreeMemory" = 129
  • "NoFreeSpace" = 130
  • "AccessDenied" = 121
  • "AlreadyExists" = 132
  • "DoesNotExist" = 133
  • "Interrupted" = 134
  • "IsDirectory" = 135
  • "NotADirectory" = 136
  • "WouldBlock" = 137
  • "Overflow" = 138
  • "BadFileDescriptor" = 139
  • "OutOfRange" = 140
  • "NameTooLong" = 141
  • "InvalidSeek" = 142
  • "NotSupported" = 143
  • "TooManyOpenFiles" = 144
request/red_brick/<UID>/get_list_item
Request payload:
 
  • list_id -- int
  • index -- int
  • session_id -- int
Response payload:
 
  • error_code -- int (has symbols)
  • item_object_id -- int
  • type -- int (has symbols)

Returns the object ID and type of the object stored at index in a list object and returns the resulting error code.

Possible object types are:

  • String = 0
  • List = 1
  • File = 2
  • Directory = 3
  • Process = 4
  • Program = 5

The following symbols are available for this function:

for error_code:

  • "Success" = 0
  • "UnknownError" = 1
  • "InvalidOperation" = 2
  • "OperationAborted" = 3
  • "InternalError" = 4
  • "UnknownSessionId" = 5
  • "NoFreeSessionId" = 6
  • "UnknownObjectId" = 7
  • "NoFreeObjectId" = 8
  • "ObjectIsLocked" = 9
  • "NoMoreData" = 10
  • "WrongListItemType" = 11
  • "ProgramIsPurged" = 12
  • "InvalidParameter" = 128
  • "NoFreeMemory" = 129
  • "NoFreeSpace" = 130
  • "AccessDenied" = 121
  • "AlreadyExists" = 132
  • "DoesNotExist" = 133
  • "Interrupted" = 134
  • "IsDirectory" = 135
  • "NotADirectory" = 136
  • "WouldBlock" = 137
  • "Overflow" = 138
  • "BadFileDescriptor" = 139
  • "OutOfRange" = 140
  • "NameTooLong" = 141
  • "InvalidSeek" = 142
  • "NotSupported" = 143
  • "TooManyOpenFiles" = 144

for type:

  • "String" = 0
  • "List" = 1
  • "File" = 2
  • "Directory" = 3
  • "Process" = 4
  • "Program" = 5
request/red_brick/<UID>/append_to_list
Request payload:
 
  • list_id -- int
  • item_object_id -- int
Response payload:
 
  • error_code -- int (has symbols)

Appends an object to a list object and increases the reference count of the appended object by one.

Returns the resulting error code.

The following symbols are available for this function:

for error_code:

  • "Success" = 0
  • "UnknownError" = 1
  • "InvalidOperation" = 2
  • "OperationAborted" = 3
  • "InternalError" = 4
  • "UnknownSessionId" = 5
  • "NoFreeSessionId" = 6
  • "UnknownObjectId" = 7
  • "NoFreeObjectId" = 8
  • "ObjectIsLocked" = 9
  • "NoMoreData" = 10
  • "WrongListItemType" = 11
  • "ProgramIsPurged" = 12
  • "InvalidParameter" = 128
  • "NoFreeMemory" = 129
  • "NoFreeSpace" = 130
  • "AccessDenied" = 121
  • "AlreadyExists" = 132
  • "DoesNotExist" = 133
  • "Interrupted" = 134
  • "IsDirectory" = 135
  • "NotADirectory" = 136
  • "WouldBlock" = 137
  • "Overflow" = 138
  • "BadFileDescriptor" = 139
  • "OutOfRange" = 140
  • "NameTooLong" = 141
  • "InvalidSeek" = 142
  • "NotSupported" = 143
  • "TooManyOpenFiles" = 144
request/red_brick/<UID>/remove_from_list
Request payload:
 
  • list_id -- int
  • index -- int
Response payload:
 
  • error_code -- int (has symbols)

Removes the object stored at index from a list object and decreases the reference count of the removed object by one.

Returns the resulting error code.

The following symbols are available for this function:

for error_code:

  • "Success" = 0
  • "UnknownError" = 1
  • "InvalidOperation" = 2
  • "OperationAborted" = 3
  • "InternalError" = 4
  • "UnknownSessionId" = 5
  • "NoFreeSessionId" = 6
  • "UnknownObjectId" = 7
  • "NoFreeObjectId" = 8
  • "ObjectIsLocked" = 9
  • "NoMoreData" = 10
  • "WrongListItemType" = 11
  • "ProgramIsPurged" = 12
  • "InvalidParameter" = 128
  • "NoFreeMemory" = 129
  • "NoFreeSpace" = 130
  • "AccessDenied" = 121
  • "AlreadyExists" = 132
  • "DoesNotExist" = 133
  • "Interrupted" = 134
  • "IsDirectory" = 135
  • "NotADirectory" = 136
  • "WouldBlock" = 137
  • "Overflow" = 138
  • "BadFileDescriptor" = 139
  • "OutOfRange" = 140
  • "NameTooLong" = 141
  • "InvalidSeek" = 142
  • "NotSupported" = 143
  • "TooManyOpenFiles" = 144
request/red_brick/<UID>/open_file
Request payload:
 
  • name_string_id -- int
  • flags -- int (has symbols)
  • permissions -- int (has symbols)
  • uid -- int
  • gid -- int
  • session_id -- int
Response payload:
 
  • error_code -- int (has symbols)
  • file_id -- int

Opens an existing file or creates a new file and allocates a new file object for it.

FIXME: name has to be absolute

The reference count of the name string object is increased by one. When the file object gets destroyed then the reference count of the name string object is decreased by one. Also the name string object is locked and cannot be modified while the file object holds a reference to it.

The flags parameter takes a ORed combination of the following possible file flags (in hexadecimal notation):

  • ReadOnly = 0x0001 (O_RDONLY)
  • WriteOnly = 0x0002 (O_WRONLY)
  • ReadWrite = 0x0004 (O_RDWR)
  • Append = 0x0008 (O_APPEND)
  • Create = 0x0010 (O_CREAT)
  • Exclusive = 0x0020 (O_EXCL)
  • NonBlocking = 0x0040 (O_NONBLOCK)
  • Truncate = 0x0080 (O_TRUNC)
  • Temporary = 0x0100
  • Replace = 0x0200

FIXME: explain Temporary and Replace flag

The permissions parameter takes a ORed combination of the following possible file permissions (in octal notation) that match the common UNIX permission bits:

  • UserRead = 00400
  • UserWrite = 00200
  • UserExecute = 00100
  • GroupRead = 00040
  • GroupWrite = 00020
  • GroupExecute = 00010
  • OthersRead = 00004
  • OthersWrite = 00002
  • OthersExecute = 00001

Returns the object ID of the new file object and the resulting error code.

The following symbols are available for this function:

for flags:

  • "ReadOnly" = 1
  • "WriteOnly" = 2
  • "ReadWrite" = 4
  • "Append" = 8
  • "Create" = 16
  • "Exclusive" = 32
  • "NonBlocking" = 64
  • "Truncate" = 128
  • "Temporary" = 256
  • "Replace" = 512

for permissions:

  • "UserAll" = 448
  • "UserRead" = 256
  • "UserWrite" = 128
  • "UserExecute" = 64
  • "GroupAll" = 56
  • "GroupRead" = 32
  • "GroupWrite" = 16
  • "GroupExecute" = 8
  • "OthersAll" = 7
  • "OthersRead" = 4
  • "OthersWrite" = 2
  • "OthersExecute" = 1

for error_code:

  • "Success" = 0
  • "UnknownError" = 1
  • "InvalidOperation" = 2
  • "OperationAborted" = 3
  • "InternalError" = 4
  • "UnknownSessionId" = 5
  • "NoFreeSessionId" = 6
  • "UnknownObjectId" = 7
  • "NoFreeObjectId" = 8
  • "ObjectIsLocked" = 9
  • "NoMoreData" = 10
  • "WrongListItemType" = 11
  • "ProgramIsPurged" = 12
  • "InvalidParameter" = 128
  • "NoFreeMemory" = 129
  • "NoFreeSpace" = 130
  • "AccessDenied" = 121
  • "AlreadyExists" = 132
  • "DoesNotExist" = 133
  • "Interrupted" = 134
  • "IsDirectory" = 135
  • "NotADirectory" = 136
  • "WouldBlock" = 137
  • "Overflow" = 138
  • "BadFileDescriptor" = 139
  • "OutOfRange" = 140
  • "NameTooLong" = 141
  • "InvalidSeek" = 142
  • "NotSupported" = 143
  • "TooManyOpenFiles" = 144
request/red_brick/<UID>/create_pipe
Request payload:
 
  • flags -- int (has symbols)
  • length -- int
  • session_id -- int
Response payload:
 
  • error_code -- int (has symbols)
  • file_id -- int

Creates a new pipe and allocates a new file object for it.

The flags parameter takes a ORed combination of the following possible pipe flags (in hexadecimal notation):

  • NonBlockingRead = 0x0001
  • NonBlockingWrite = 0x0002

The length of the pipe buffer can be specified with the length parameter in bytes. If length is set to zero, then the default pipe buffer length is used.

Returns the object ID of the new file object and the resulting error code.

The following symbols are available for this function:

for flags:

  • "NonBlockingRead" = 1
  • "NonBlockingWrite" = 2

for error_code:

  • "Success" = 0
  • "UnknownError" = 1
  • "InvalidOperation" = 2
  • "OperationAborted" = 3
  • "InternalError" = 4
  • "UnknownSessionId" = 5
  • "NoFreeSessionId" = 6
  • "UnknownObjectId" = 7
  • "NoFreeObjectId" = 8
  • "ObjectIsLocked" = 9
  • "NoMoreData" = 10
  • "WrongListItemType" = 11
  • "ProgramIsPurged" = 12
  • "InvalidParameter" = 128
  • "NoFreeMemory" = 129
  • "NoFreeSpace" = 130
  • "AccessDenied" = 121
  • "AlreadyExists" = 132
  • "DoesNotExist" = 133
  • "Interrupted" = 134
  • "IsDirectory" = 135
  • "NotADirectory" = 136
  • "WouldBlock" = 137
  • "Overflow" = 138
  • "BadFileDescriptor" = 139
  • "OutOfRange" = 140
  • "NameTooLong" = 141
  • "InvalidSeek" = 142
  • "NotSupported" = 143
  • "TooManyOpenFiles" = 144
request/red_brick/<UID>/get_file_info
Request payload:
 
  • file_id -- int
  • session_id -- int
Response payload:
 
  • error_code -- int (has symbols)
  • type -- int (has symbols)
  • name_string_id -- int
  • flags -- int
  • permissions -- int (has symbols)
  • uid -- int
  • gid -- int
  • length -- int
  • access_timestamp -- int
  • modification_timestamp -- int
  • status_change_timestamp -- int

Returns various information about a file and the resulting error code.

Possible file types are:

  • Unknown = 0
  • Regular = 1
  • Directory = 2
  • Character = 3
  • Block = 4
  • FIFO = 5
  • Symlink = 6
  • Socket = 7
  • Pipe = 8

If the file type is Pipe then the returned name string object is invalid, because a pipe has no name. Otherwise the returned name string object was used to open or create the file object, as passed to request/red_brick/<UID>/open_file.

The returned flags were used to open or create the file object, as passed to request/red_brick/<UID>/open_file or request/red_brick/<UID>/create_pipe. See the respective function for a list of possible file and pipe flags.

FIXME: everything except flags and length is invalid if file type is Pipe

The following symbols are available for this function:

for error_code:

  • "Success" = 0
  • "UnknownError" = 1
  • "InvalidOperation" = 2
  • "OperationAborted" = 3
  • "InternalError" = 4
  • "UnknownSessionId" = 5
  • "NoFreeSessionId" = 6
  • "UnknownObjectId" = 7
  • "NoFreeObjectId" = 8
  • "ObjectIsLocked" = 9
  • "NoMoreData" = 10
  • "WrongListItemType" = 11
  • "ProgramIsPurged" = 12
  • "InvalidParameter" = 128
  • "NoFreeMemory" = 129
  • "NoFreeSpace" = 130
  • "AccessDenied" = 121
  • "AlreadyExists" = 132
  • "DoesNotExist" = 133
  • "Interrupted" = 134
  • "IsDirectory" = 135
  • "NotADirectory" = 136
  • "WouldBlock" = 137
  • "Overflow" = 138
  • "BadFileDescriptor" = 139
  • "OutOfRange" = 140
  • "NameTooLong" = 141
  • "InvalidSeek" = 142
  • "NotSupported" = 143
  • "TooManyOpenFiles" = 144

for type:

  • "Unknown" = 0
  • "Regular" = 1
  • "Directory" = 2
  • "Character" = 3
  • "Block" = 4
  • "FIFO" = 5
  • "Symlink" = 6
  • "Socket" = 7
  • "Pipe" = 8

for permissions:

  • "UserAll" = 448
  • "UserRead" = 256
  • "UserWrite" = 128
  • "UserExecute" = 64
  • "GroupAll" = 56
  • "GroupRead" = 32
  • "GroupWrite" = 16
  • "GroupExecute" = 8
  • "OthersAll" = 7
  • "OthersRead" = 4
  • "OthersWrite" = 2
  • "OthersExecute" = 1
request/red_brick/<UID>/read_file
Request payload:
 
  • file_id -- int
  • length_to_read -- int
Response payload:
 
  • error_code -- int (has symbols)
  • buffer -- [int,... (x62)]
  • length_read -- int

Reads up to 62 bytes from a file object.

Returns the bytes read, the actual number of bytes read and the resulting error code.

If there is not data to be read, either because the file position reached end-of-file or because there is not data in the pipe, then zero bytes are returned.

If the file object was created by request/red_brick/<UID>/open_file without the NonBlocking flag or by request/red_brick/<UID>/create_pipe without the NonBlockingRead flag then the error code NotSupported is returned.

The following symbols are available for this function:

for error_code:

  • "Success" = 0
  • "UnknownError" = 1
  • "InvalidOperation" = 2
  • "OperationAborted" = 3
  • "InternalError" = 4
  • "UnknownSessionId" = 5
  • "NoFreeSessionId" = 6
  • "UnknownObjectId" = 7
  • "NoFreeObjectId" = 8
  • "ObjectIsLocked" = 9
  • "NoMoreData" = 10
  • "WrongListItemType" = 11
  • "ProgramIsPurged" = 12
  • "InvalidParameter" = 128
  • "NoFreeMemory" = 129
  • "NoFreeSpace" = 130
  • "AccessDenied" = 121
  • "AlreadyExists" = 132
  • "DoesNotExist" = 133
  • "Interrupted" = 134
  • "IsDirectory" = 135
  • "NotADirectory" = 136
  • "WouldBlock" = 137
  • "Overflow" = 138
  • "BadFileDescriptor" = 139
  • "OutOfRange" = 140
  • "NameTooLong" = 141
  • "InvalidSeek" = 142
  • "NotSupported" = 143
  • "TooManyOpenFiles" = 144
request/red_brick/<UID>/read_file_async
Request payload:
 
  • file_id -- int
  • length_to_read -- int

Reads up to 263 - 1 bytes from a file object asynchronously.

Reports the bytes read (in 60 byte chunks), the actual number of bytes read and the resulting error code via the register/red_brick/<UID>/async_file_read callback.

If there is not data to be read, either because the file position reached end-of-file or because there is not data in the pipe, then zero bytes are reported.

If the file object was created by request/red_brick/<UID>/open_file without the NonBlocking flag or by request/red_brick/<UID>/create_pipe without the NonBlockingRead flag then the error code NotSupported is reported via the register/red_brick/<UID>/async_file_read callback.

request/red_brick/<UID>/abort_async_file_read
Request payload:
 
  • file_id -- int
Response payload:
 
  • error_code -- int (has symbols)

Aborts a request/red_brick/<UID>/read_file_async operation in progress.

Returns the resulting error code.

On success the register/red_brick/<UID>/async_file_read callback will report OperationAborted.

The following symbols are available for this function:

for error_code:

  • "Success" = 0
  • "UnknownError" = 1
  • "InvalidOperation" = 2
  • "OperationAborted" = 3
  • "InternalError" = 4
  • "UnknownSessionId" = 5
  • "NoFreeSessionId" = 6
  • "UnknownObjectId" = 7
  • "NoFreeObjectId" = 8
  • "ObjectIsLocked" = 9
  • "NoMoreData" = 10
  • "WrongListItemType" = 11
  • "ProgramIsPurged" = 12
  • "InvalidParameter" = 128
  • "NoFreeMemory" = 129
  • "NoFreeSpace" = 130
  • "AccessDenied" = 121
  • "AlreadyExists" = 132
  • "DoesNotExist" = 133
  • "Interrupted" = 134
  • "IsDirectory" = 135
  • "NotADirectory" = 136
  • "WouldBlock" = 137
  • "Overflow" = 138
  • "BadFileDescriptor" = 139
  • "OutOfRange" = 140
  • "NameTooLong" = 141
  • "InvalidSeek" = 142
  • "NotSupported" = 143
  • "TooManyOpenFiles" = 144
request/red_brick/<UID>/write_file
Request payload:
 
  • file_id -- int
  • buffer -- [int,... (x61)]
  • length_to_write -- int
Response payload:
 
  • error_code -- int (has symbols)
  • length_written -- int

Writes up to 61 bytes to a file object.

Returns the actual number of bytes written and the resulting error code.

If the file object was created by request/red_brick/<UID>/open_file without the NonBlocking flag or by request/red_brick/<UID>/create_pipe without the NonBlockingWrite flag then the error code NotSupported is returned.

The following symbols are available for this function:

for error_code:

  • "Success" = 0
  • "UnknownError" = 1
  • "InvalidOperation" = 2
  • "OperationAborted" = 3
  • "InternalError" = 4
  • "UnknownSessionId" = 5
  • "NoFreeSessionId" = 6
  • "UnknownObjectId" = 7
  • "NoFreeObjectId" = 8
  • "ObjectIsLocked" = 9
  • "NoMoreData" = 10
  • "WrongListItemType" = 11
  • "ProgramIsPurged" = 12
  • "InvalidParameter" = 128
  • "NoFreeMemory" = 129
  • "NoFreeSpace" = 130
  • "AccessDenied" = 121
  • "AlreadyExists" = 132
  • "DoesNotExist" = 133
  • "Interrupted" = 134
  • "IsDirectory" = 135
  • "NotADirectory" = 136
  • "WouldBlock" = 137
  • "Overflow" = 138
  • "BadFileDescriptor" = 139
  • "OutOfRange" = 140
  • "NameTooLong" = 141
  • "InvalidSeek" = 142
  • "NotSupported" = 143
  • "TooManyOpenFiles" = 144
request/red_brick/<UID>/write_file_unchecked
Request payload:
 
  • file_id -- int
  • buffer -- [int,... (x61)]
  • length_to_write -- int

Writes up to 61 bytes to a file object.

Does neither report the actual number of bytes written nor the resulting error code.

If the file object was created by request/red_brick/<UID>/open_file without the NonBlocking flag or by request/red_brick/<UID>/create_pipe without the NonBlockingWrite flag then the write operation will fail silently.

request/red_brick/<UID>/write_file_async
Request payload:
 
  • file_id -- int
  • buffer -- [int,... (x61)]
  • length_to_write -- int

Writes up to 61 bytes to a file object.

Reports the actual number of bytes written and the resulting error code via the register/red_brick/<UID>/async_file_write callback.

If the file object was created by request/red_brick/<UID>/open_file without the NonBlocking flag or by request/red_brick/<UID>/create_pipe without the NonBlockingWrite flag then the error code NotSupported is reported via the register/red_brick/<UID>/async_file_write callback.

request/red_brick/<UID>/set_file_position
Request payload:
 
  • file_id -- int
  • offset -- int
  • origin -- int (has symbols)
Response payload:
 
  • error_code -- int (has symbols)
  • position -- int

Set the current seek position of a file object in bytes relative to origin.

Possible file origins are:

  • Beginning = 0
  • Current = 1
  • End = 2

Returns the resulting absolute seek position and error code.

If the file object was created by request/red_brick/<UID>/create_pipe then it has no seek position and the error code InvalidSeek is returned.

The following symbols are available for this function:

for origin:

  • "Beginning" = 0
  • "Current" = 1
  • "End" = 2

for error_code:

  • "Success" = 0
  • "UnknownError" = 1
  • "InvalidOperation" = 2
  • "OperationAborted" = 3
  • "InternalError" = 4
  • "UnknownSessionId" = 5
  • "NoFreeSessionId" = 6
  • "UnknownObjectId" = 7
  • "NoFreeObjectId" = 8
  • "ObjectIsLocked" = 9
  • "NoMoreData" = 10
  • "WrongListItemType" = 11
  • "ProgramIsPurged" = 12
  • "InvalidParameter" = 128
  • "NoFreeMemory" = 129
  • "NoFreeSpace" = 130
  • "AccessDenied" = 121
  • "AlreadyExists" = 132
  • "DoesNotExist" = 133
  • "Interrupted" = 134
  • "IsDirectory" = 135
  • "NotADirectory" = 136
  • "WouldBlock" = 137
  • "Overflow" = 138
  • "BadFileDescriptor" = 139
  • "OutOfRange" = 140
  • "NameTooLong" = 141
  • "InvalidSeek" = 142
  • "NotSupported" = 143
  • "TooManyOpenFiles" = 144
request/red_brick/<UID>/get_file_position
Request payload:
 
  • file_id -- int
Response payload:
 
  • error_code -- int (has symbols)
  • position -- int

Returns the current seek position of a file object in bytes and returns the resulting error code.

If the file object was created by request/red_brick/<UID>/create_pipe then it has no seek position and the error code InvalidSeek is returned.

The following symbols are available for this function:

for error_code:

  • "Success" = 0
  • "UnknownError" = 1
  • "InvalidOperation" = 2
  • "OperationAborted" = 3
  • "InternalError" = 4
  • "UnknownSessionId" = 5
  • "NoFreeSessionId" = 6
  • "UnknownObjectId" = 7
  • "NoFreeObjectId" = 8
  • "ObjectIsLocked" = 9
  • "NoMoreData" = 10
  • "WrongListItemType" = 11
  • "ProgramIsPurged" = 12
  • "InvalidParameter" = 128
  • "NoFreeMemory" = 129
  • "NoFreeSpace" = 130
  • "AccessDenied" = 121
  • "AlreadyExists" = 132
  • "DoesNotExist" = 133
  • "Interrupted" = 134
  • "IsDirectory" = 135
  • "NotADirectory" = 136
  • "WouldBlock" = 137
  • "Overflow" = 138
  • "BadFileDescriptor" = 139
  • "OutOfRange" = 140
  • "NameTooLong" = 141
  • "InvalidSeek" = 142
  • "NotSupported" = 143
  • "TooManyOpenFiles" = 144
request/red_brick/<UID>/set_file_events
Request payload:
 
  • file_id -- int
  • events -- int (has symbols)
Response payload:
 
  • error_code -- int (has symbols)

The following symbols are available for this function:

for events:

  • "Readable" = 1
  • "Writable" = 2

for error_code:

  • "Success" = 0
  • "UnknownError" = 1
  • "InvalidOperation" = 2
  • "OperationAborted" = 3
  • "InternalError" = 4
  • "UnknownSessionId" = 5
  • "NoFreeSessionId" = 6
  • "UnknownObjectId" = 7
  • "NoFreeObjectId" = 8
  • "ObjectIsLocked" = 9
  • "NoMoreData" = 10
  • "WrongListItemType" = 11
  • "ProgramIsPurged" = 12
  • "InvalidParameter" = 128
  • "NoFreeMemory" = 129
  • "NoFreeSpace" = 130
  • "AccessDenied" = 121
  • "AlreadyExists" = 132
  • "DoesNotExist" = 133
  • "Interrupted" = 134
  • "IsDirectory" = 135
  • "NotADirectory" = 136
  • "WouldBlock" = 137
  • "Overflow" = 138
  • "BadFileDescriptor" = 139
  • "OutOfRange" = 140
  • "NameTooLong" = 141
  • "InvalidSeek" = 142
  • "NotSupported" = 143
  • "TooManyOpenFiles" = 144
request/red_brick/<UID>/get_file_events
Request payload:
 
  • file_id -- int
Response payload:
 
  • error_code -- int (has symbols)
  • events -- int (has symbols)

The following symbols are available for this function:

for error_code:

  • "Success" = 0
  • "UnknownError" = 1
  • "InvalidOperation" = 2
  • "OperationAborted" = 3
  • "InternalError" = 4
  • "UnknownSessionId" = 5
  • "NoFreeSessionId" = 6
  • "UnknownObjectId" = 7
  • "NoFreeObjectId" = 8
  • "ObjectIsLocked" = 9
  • "NoMoreData" = 10
  • "WrongListItemType" = 11
  • "ProgramIsPurged" = 12
  • "InvalidParameter" = 128
  • "NoFreeMemory" = 129
  • "NoFreeSpace" = 130
  • "AccessDenied" = 121
  • "AlreadyExists" = 132
  • "DoesNotExist" = 133
  • "Interrupted" = 134
  • "IsDirectory" = 135
  • "NotADirectory" = 136
  • "WouldBlock" = 137
  • "Overflow" = 138
  • "BadFileDescriptor" = 139
  • "OutOfRange" = 140
  • "NameTooLong" = 141
  • "InvalidSeek" = 142
  • "NotSupported" = 143
  • "TooManyOpenFiles" = 144

for events:

  • "Readable" = 1
  • "Writable" = 2
request/red_brick/<UID>/open_directory
Request payload:
 
  • name_string_id -- int
  • session_id -- int
Response payload:
 
  • error_code -- int (has symbols)
  • directory_id -- int

Opens an existing directory and allocates a new directory object for it.

FIXME: name has to be absolute

The reference count of the name string object is increased by one. When the directory object is destroyed then the reference count of the name string object is decreased by one. Also the name string object is locked and cannot be modified while the directory object holds a reference to it.

Returns the object ID of the new directory object and the resulting error code.

The following symbols are available for this function:

for error_code:

  • "Success" = 0
  • "UnknownError" = 1
  • "InvalidOperation" = 2
  • "OperationAborted" = 3
  • "InternalError" = 4
  • "UnknownSessionId" = 5
  • "NoFreeSessionId" = 6
  • "UnknownObjectId" = 7
  • "NoFreeObjectId" = 8
  • "ObjectIsLocked" = 9
  • "NoMoreData" = 10
  • "WrongListItemType" = 11
  • "ProgramIsPurged" = 12
  • "InvalidParameter" = 128
  • "NoFreeMemory" = 129
  • "NoFreeSpace" = 130
  • "AccessDenied" = 121
  • "AlreadyExists" = 132
  • "DoesNotExist" = 133
  • "Interrupted" = 134
  • "IsDirectory" = 135
  • "NotADirectory" = 136
  • "WouldBlock" = 137
  • "Overflow" = 138
  • "BadFileDescriptor" = 139
  • "OutOfRange" = 140
  • "NameTooLong" = 141
  • "InvalidSeek" = 142
  • "NotSupported" = 143
  • "TooManyOpenFiles" = 144
request/red_brick/<UID>/get_directory_name
Request payload:
 
  • directory_id -- int
  • session_id -- int
Response payload:
 
  • error_code -- int (has symbols)
  • name_string_id -- int

Returns the name of a directory object, as passed to request/red_brick/<UID>/open_directory, and the resulting error code.

The following symbols are available for this function:

for error_code:

  • "Success" = 0
  • "UnknownError" = 1
  • "InvalidOperation" = 2
  • "OperationAborted" = 3
  • "InternalError" = 4
  • "UnknownSessionId" = 5
  • "NoFreeSessionId" = 6
  • "UnknownObjectId" = 7
  • "NoFreeObjectId" = 8
  • "ObjectIsLocked" = 9
  • "NoMoreData" = 10
  • "WrongListItemType" = 11
  • "ProgramIsPurged" = 12
  • "InvalidParameter" = 128
  • "NoFreeMemory" = 129
  • "NoFreeSpace" = 130
  • "AccessDenied" = 121
  • "AlreadyExists" = 132
  • "DoesNotExist" = 133
  • "Interrupted" = 134
  • "IsDirectory" = 135
  • "NotADirectory" = 136
  • "WouldBlock" = 137
  • "Overflow" = 138
  • "BadFileDescriptor" = 139
  • "OutOfRange" = 140
  • "NameTooLong" = 141
  • "InvalidSeek" = 142
  • "NotSupported" = 143
  • "TooManyOpenFiles" = 144
request/red_brick/<UID>/get_next_directory_entry
Request payload:
 
  • directory_id -- int
  • session_id -- int
Response payload:
 
  • error_code -- int (has symbols)
  • name_string_id -- int
  • type -- int (has symbols)

Returns the next entry in a directory object and the resulting error code.

If there is not next entry then error code NoMoreData is returned. To rewind a directory object call request/red_brick/<UID>/rewind_directory.

Possible directory entry types are:

  • Unknown = 0
  • Regular = 1
  • Directory = 2
  • Character = 3
  • Block = 4
  • FIFO = 5
  • Symlink = 6
  • Socket = 7

The following symbols are available for this function:

for error_code:

  • "Success" = 0
  • "UnknownError" = 1
  • "InvalidOperation" = 2
  • "OperationAborted" = 3
  • "InternalError" = 4
  • "UnknownSessionId" = 5
  • "NoFreeSessionId" = 6
  • "UnknownObjectId" = 7
  • "NoFreeObjectId" = 8
  • "ObjectIsLocked" = 9
  • "NoMoreData" = 10
  • "WrongListItemType" = 11
  • "ProgramIsPurged" = 12
  • "InvalidParameter" = 128
  • "NoFreeMemory" = 129
  • "NoFreeSpace" = 130
  • "AccessDenied" = 121
  • "AlreadyExists" = 132
  • "DoesNotExist" = 133
  • "Interrupted" = 134
  • "IsDirectory" = 135
  • "NotADirectory" = 136
  • "WouldBlock" = 137
  • "Overflow" = 138
  • "BadFileDescriptor" = 139
  • "OutOfRange" = 140
  • "NameTooLong" = 141
  • "InvalidSeek" = 142
  • "NotSupported" = 143
  • "TooManyOpenFiles" = 144

for type:

  • "Unknown" = 0
  • "Regular" = 1
  • "Directory" = 2
  • "Character" = 3
  • "Block" = 4
  • "FIFO" = 5
  • "Symlink" = 6
  • "Socket" = 7
request/red_brick/<UID>/rewind_directory
Request payload:
 
  • directory_id -- int
Response payload:
 
  • error_code -- int (has symbols)

Rewinds a directory object and returns the resulting error code.

The following symbols are available for this function:

for error_code:

  • "Success" = 0
  • "UnknownError" = 1
  • "InvalidOperation" = 2
  • "OperationAborted" = 3
  • "InternalError" = 4
  • "UnknownSessionId" = 5
  • "NoFreeSessionId" = 6
  • "UnknownObjectId" = 7
  • "NoFreeObjectId" = 8
  • "ObjectIsLocked" = 9
  • "NoMoreData" = 10
  • "WrongListItemType" = 11
  • "ProgramIsPurged" = 12
  • "InvalidParameter" = 128
  • "NoFreeMemory" = 129
  • "NoFreeSpace" = 130
  • "AccessDenied" = 121
  • "AlreadyExists" = 132
  • "DoesNotExist" = 133
  • "Interrupted" = 134
  • "IsDirectory" = 135
  • "NotADirectory" = 136
  • "WouldBlock" = 137
  • "Overflow" = 138
  • "BadFileDescriptor" = 139
  • "OutOfRange" = 140
  • "NameTooLong" = 141
  • "InvalidSeek" = 142
  • "NotSupported" = 143
  • "TooManyOpenFiles" = 144
request/red_brick/<UID>/create_directory
Request payload:
 
  • name_string_id -- int
  • flags -- int (has symbols)
  • permissions -- int (has symbols)
  • uid -- int
  • gid -- int
Response payload:
 
  • error_code -- int (has symbols)

FIXME: name has to be absolute

The following symbols are available for this function:

for flags:

  • "Recursive" = 1
  • "Exclusive" = 2

for permissions:

  • "UserAll" = 448
  • "UserRead" = 256
  • "UserWrite" = 128
  • "UserExecute" = 64
  • "GroupAll" = 56
  • "GroupRead" = 32
  • "GroupWrite" = 16
  • "GroupExecute" = 8
  • "OthersAll" = 7
  • "OthersRead" = 4
  • "OthersWrite" = 2
  • "OthersExecute" = 1

for error_code:

  • "Success" = 0
  • "UnknownError" = 1
  • "InvalidOperation" = 2
  • "OperationAborted" = 3
  • "InternalError" = 4
  • "UnknownSessionId" = 5
  • "NoFreeSessionId" = 6
  • "UnknownObjectId" = 7
  • "NoFreeObjectId" = 8
  • "ObjectIsLocked" = 9
  • "NoMoreData" = 10
  • "WrongListItemType" = 11
  • "ProgramIsPurged" = 12
  • "InvalidParameter" = 128
  • "NoFreeMemory" = 129
  • "NoFreeSpace" = 130
  • "AccessDenied" = 121
  • "AlreadyExists" = 132
  • "DoesNotExist" = 133
  • "Interrupted" = 134
  • "IsDirectory" = 135
  • "NotADirectory" = 136
  • "WouldBlock" = 137
  • "Overflow" = 138
  • "BadFileDescriptor" = 139
  • "OutOfRange" = 140
  • "NameTooLong" = 141
  • "InvalidSeek" = 142
  • "NotSupported" = 143
  • "TooManyOpenFiles" = 144
request/red_brick/<UID>/get_processes
Request payload:
 
  • session_id -- int
Response payload:
 
  • error_code -- int (has symbols)
  • processes_list_id -- int

The following symbols are available for this function:

for error_code:

  • "Success" = 0
  • "UnknownError" = 1
  • "InvalidOperation" = 2
  • "OperationAborted" = 3
  • "InternalError" = 4
  • "UnknownSessionId" = 5
  • "NoFreeSessionId" = 6
  • "UnknownObjectId" = 7
  • "NoFreeObjectId" = 8
  • "ObjectIsLocked" = 9
  • "NoMoreData" = 10
  • "WrongListItemType" = 11
  • "ProgramIsPurged" = 12
  • "InvalidParameter" = 128
  • "NoFreeMemory" = 129
  • "NoFreeSpace" = 130
  • "AccessDenied" = 121
  • "AlreadyExists" = 132
  • "DoesNotExist" = 133
  • "Interrupted" = 134
  • "IsDirectory" = 135
  • "NotADirectory" = 136
  • "WouldBlock" = 137
  • "Overflow" = 138
  • "BadFileDescriptor" = 139
  • "OutOfRange" = 140
  • "NameTooLong" = 141
  • "InvalidSeek" = 142
  • "NotSupported" = 143
  • "TooManyOpenFiles" = 144
request/red_brick/<UID>/spawn_process
Request payload:
 
  • executable_string_id -- int
  • arguments_list_id -- int
  • environment_list_id -- int
  • working_directory_string_id -- int
  • uid -- int
  • gid -- int
  • stdin_file_id -- int
  • stdout_file_id -- int
  • stderr_file_id -- int
  • session_id -- int
Response payload:
 
  • error_code -- int (has symbols)
  • process_id -- int

The following symbols are available for this function:

for error_code:

  • "Success" = 0
  • "UnknownError" = 1
  • "InvalidOperation" = 2
  • "OperationAborted" = 3
  • "InternalError" = 4
  • "UnknownSessionId" = 5
  • "NoFreeSessionId" = 6
  • "UnknownObjectId" = 7
  • "NoFreeObjectId" = 8
  • "ObjectIsLocked" = 9
  • "NoMoreData" = 10
  • "WrongListItemType" = 11
  • "ProgramIsPurged" = 12
  • "InvalidParameter" = 128
  • "NoFreeMemory" = 129
  • "NoFreeSpace" = 130
  • "AccessDenied" = 121
  • "AlreadyExists" = 132
  • "DoesNotExist" = 133
  • "Interrupted" = 134
  • "IsDirectory" = 135
  • "NotADirectory" = 136
  • "WouldBlock" = 137
  • "Overflow" = 138
  • "BadFileDescriptor" = 139
  • "OutOfRange" = 140
  • "NameTooLong" = 141
  • "InvalidSeek" = 142
  • "NotSupported" = 143
  • "TooManyOpenFiles" = 144
request/red_brick/<UID>/kill_process
Request payload:
 
  • process_id -- int
  • signal -- int (has symbols)
Response payload:
 
  • error_code -- int (has symbols)

Sends a UNIX signal to a process object and returns the resulting error code.

Possible UNIX signals are:

  • Interrupt = 2
  • Quit = 3
  • Abort = 6
  • Kill = 9
  • User1 = 10
  • User2 = 12
  • Terminate = 15
  • Continue = 18
  • Stop = 19

The following symbols are available for this function:

for signal:

  • "Interrupt" = 2
  • "Quit" = 3
  • "Abort" = 6
  • "Kill" = 9
  • "User1" = 10
  • "User2" = 12
  • "Terminate" = 15
  • "Continue" = 18
  • "Stop" = 19

for error_code:

  • "Success" = 0
  • "UnknownError" = 1
  • "InvalidOperation" = 2
  • "OperationAborted" = 3
  • "InternalError" = 4
  • "UnknownSessionId" = 5
  • "NoFreeSessionId" = 6
  • "UnknownObjectId" = 7
  • "NoFreeObjectId" = 8
  • "ObjectIsLocked" = 9
  • "NoMoreData" = 10
  • "WrongListItemType" = 11
  • "ProgramIsPurged" = 12
  • "InvalidParameter" = 128
  • "NoFreeMemory" = 129
  • "NoFreeSpace" = 130
  • "AccessDenied" = 121
  • "AlreadyExists" = 132
  • "DoesNotExist" = 133
  • "Interrupted" = 134
  • "IsDirectory" = 135
  • "NotADirectory" = 136
  • "WouldBlock" = 137
  • "Overflow" = 138
  • "BadFileDescriptor" = 139
  • "OutOfRange" = 140
  • "NameTooLong" = 141
  • "InvalidSeek" = 142
  • "NotSupported" = 143
  • "TooManyOpenFiles" = 144
request/red_brick/<UID>/get_process_command
Request payload:
 
  • process_id -- int
  • session_id -- int
Response payload:
 
  • error_code -- int (has symbols)
  • executable_string_id -- int
  • arguments_list_id -- int
  • environment_list_id -- int
  • working_directory_string_id -- int

Returns the executable, arguments, environment and working directory used to spawn a process object, as passed to request/red_brick/<UID>/spawn_process, and the resulting error code.

The following symbols are available for this function:

for error_code:

  • "Success" = 0
  • "UnknownError" = 1
  • "InvalidOperation" = 2
  • "OperationAborted" = 3
  • "InternalError" = 4
  • "UnknownSessionId" = 5
  • "NoFreeSessionId" = 6
  • "UnknownObjectId" = 7
  • "NoFreeObjectId" = 8
  • "ObjectIsLocked" = 9
  • "NoMoreData" = 10
  • "WrongListItemType" = 11
  • "ProgramIsPurged" = 12
  • "InvalidParameter" = 128
  • "NoFreeMemory" = 129
  • "NoFreeSpace" = 130
  • "AccessDenied" = 121
  • "AlreadyExists" = 132
  • "DoesNotExist" = 133
  • "Interrupted" = 134
  • "IsDirectory" = 135
  • "NotADirectory" = 136
  • "WouldBlock" = 137
  • "Overflow" = 138
  • "BadFileDescriptor" = 139
  • "OutOfRange" = 140
  • "NameTooLong" = 141
  • "InvalidSeek" = 142
  • "NotSupported" = 143
  • "TooManyOpenFiles" = 144
request/red_brick/<UID>/get_process_identity
Request payload:
 
  • process_id -- int
Response payload:
 
  • error_code -- int (has symbols)
  • pid -- int
  • uid -- int
  • gid -- int

Returns the process ID and the user and group ID used to spawn a process object, as passed to request/red_brick/<UID>/spawn_process, and the resulting error code.

The process ID is only valid if the state is Running or Stopped, see request/red_brick/<UID>/get_process_state.

The following symbols are available for this function:

for error_code:

  • "Success" = 0
  • "UnknownError" = 1
  • "InvalidOperation" = 2
  • "OperationAborted" = 3
  • "InternalError" = 4
  • "UnknownSessionId" = 5
  • "NoFreeSessionId" = 6
  • "UnknownObjectId" = 7
  • "NoFreeObjectId" = 8
  • "ObjectIsLocked" = 9
  • "NoMoreData" = 10
  • "WrongListItemType" = 11
  • "ProgramIsPurged" = 12
  • "InvalidParameter" = 128
  • "NoFreeMemory" = 129
  • "NoFreeSpace" = 130
  • "AccessDenied" = 121
  • "AlreadyExists" = 132
  • "DoesNotExist" = 133
  • "Interrupted" = 134
  • "IsDirectory" = 135
  • "NotADirectory" = 136
  • "WouldBlock" = 137
  • "Overflow" = 138
  • "BadFileDescriptor" = 139
  • "OutOfRange" = 140
  • "NameTooLong" = 141
  • "InvalidSeek" = 142
  • "NotSupported" = 143
  • "TooManyOpenFiles" = 144
request/red_brick/<UID>/get_process_stdio
Request payload:
 
  • process_id -- int
  • session_id -- int
Response payload:
 
  • error_code -- int (has symbols)
  • stdin_file_id -- int
  • stdout_file_id -- int
  • stderr_file_id -- int

Returns the stdin, stdout and stderr files used to spawn a process object, as passed to request/red_brick/<UID>/spawn_process, and the resulting error code.

The following symbols are available for this function:

for error_code:

  • "Success" = 0
  • "UnknownError" = 1
  • "InvalidOperation" = 2
  • "OperationAborted" = 3
  • "InternalError" = 4
  • "UnknownSessionId" = 5
  • "NoFreeSessionId" = 6
  • "UnknownObjectId" = 7
  • "NoFreeObjectId" = 8
  • "ObjectIsLocked" = 9
  • "NoMoreData" = 10
  • "WrongListItemType" = 11
  • "ProgramIsPurged" = 12
  • "InvalidParameter" = 128
  • "NoFreeMemory" = 129
  • "NoFreeSpace" = 130
  • "AccessDenied" = 121
  • "AlreadyExists" = 132
  • "DoesNotExist" = 133
  • "Interrupted" = 134
  • "IsDirectory" = 135
  • "NotADirectory" = 136
  • "WouldBlock" = 137
  • "Overflow" = 138
  • "BadFileDescriptor" = 139
  • "OutOfRange" = 140
  • "NameTooLong" = 141
  • "InvalidSeek" = 142
  • "NotSupported" = 143
  • "TooManyOpenFiles" = 144
request/red_brick/<UID>/get_process_state
Request payload:
 
  • process_id -- int
Response payload:
 
  • error_code -- int (has symbols)
  • state -- int (has symbols)
  • timestamp -- int
  • exit_code -- int

Returns the current state, timestamp and exit code of a process object, and the resulting error code.

Possible process states are:

  • Unknown = 0
  • Running = 1
  • Error = 2
  • Exited = 3
  • Killed = 4
  • Stopped = 5

The timestamp represents the UNIX time since when the process is in its current state.

The exit code is only valid if the state is Error, Exited, Killed or Stopped and has different meanings depending on the state:

  • Error: error code for error occurred while spawning the process (see below)
  • Exited: exit status of the process
  • Killed: UNIX signal number used to kill the process
  • Stopped: UNIX signal number used to stop the process

Possible exit/error codes in Error state are:

  • InternalError = 125
  • CannotExecute = 126
  • DoesNotExist = 127

The CannotExecute error can be caused by the executable being opened for writing.

The following symbols are available for this function:

for error_code:

  • "Success" = 0
  • "UnknownError" = 1
  • "InvalidOperation" = 2
  • "OperationAborted" = 3
  • "InternalError" = 4
  • "UnknownSessionId" = 5
  • "NoFreeSessionId" = 6
  • "UnknownObjectId" = 7
  • "NoFreeObjectId" = 8
  • "ObjectIsLocked" = 9
  • "NoMoreData" = 10
  • "WrongListItemType" = 11
  • "ProgramIsPurged" = 12
  • "InvalidParameter" = 128
  • "NoFreeMemory" = 129
  • "NoFreeSpace" = 130
  • "AccessDenied" = 121
  • "AlreadyExists" = 132
  • "DoesNotExist" = 133
  • "Interrupted" = 134
  • "IsDirectory" = 135
  • "NotADirectory" = 136
  • "WouldBlock" = 137
  • "Overflow" = 138
  • "BadFileDescriptor" = 139
  • "OutOfRange" = 140
  • "NameTooLong" = 141
  • "InvalidSeek" = 142
  • "NotSupported" = 143
  • "TooManyOpenFiles" = 144

for state:

  • "Unknown" = 0
  • "Running" = 1
  • "Error" = 2
  • "Exited" = 3
  • "Killed" = 4
  • "Stopped" = 5
request/red_brick/<UID>/get_programs
Request payload:
 
  • session_id -- int
Response payload:
 
  • error_code -- int (has symbols)
  • programs_list_id -- int

The following symbols are available for this function:

for error_code:

  • "Success" = 0
  • "UnknownError" = 1
  • "InvalidOperation" = 2
  • "OperationAborted" = 3
  • "InternalError" = 4
  • "UnknownSessionId" = 5
  • "NoFreeSessionId" = 6
  • "UnknownObjectId" = 7
  • "NoFreeObjectId" = 8
  • "ObjectIsLocked" = 9
  • "NoMoreData" = 10
  • "WrongListItemType" = 11
  • "ProgramIsPurged" = 12
  • "InvalidParameter" = 128
  • "NoFreeMemory" = 129
  • "NoFreeSpace" = 130
  • "AccessDenied" = 121
  • "AlreadyExists" = 132
  • "DoesNotExist" = 133
  • "Interrupted" = 134
  • "IsDirectory" = 135
  • "NotADirectory" = 136
  • "WouldBlock" = 137
  • "Overflow" = 138
  • "BadFileDescriptor" = 139
  • "OutOfRange" = 140
  • "NameTooLong" = 141
  • "InvalidSeek" = 142
  • "NotSupported" = 143
  • "TooManyOpenFiles" = 144
request/red_brick/<UID>/define_program
Request payload:
 
  • identifier_string_id -- int
  • session_id -- int
Response payload:
 
  • error_code -- int (has symbols)
  • program_id -- int

The following symbols are available for this function:

for error_code:

  • "Success" = 0
  • "UnknownError" = 1
  • "InvalidOperation" = 2
  • "OperationAborted" = 3
  • "InternalError" = 4
  • "UnknownSessionId" = 5
  • "NoFreeSessionId" = 6
  • "UnknownObjectId" = 7
  • "NoFreeObjectId" = 8
  • "ObjectIsLocked" = 9
  • "NoMoreData" = 10
  • "WrongListItemType" = 11
  • "ProgramIsPurged" = 12
  • "InvalidParameter" = 128
  • "NoFreeMemory" = 129
  • "NoFreeSpace" = 130
  • "AccessDenied" = 121
  • "AlreadyExists" = 132
  • "DoesNotExist" = 133
  • "Interrupted" = 134
  • "IsDirectory" = 135
  • "NotADirectory" = 136
  • "WouldBlock" = 137
  • "Overflow" = 138
  • "BadFileDescriptor" = 139
  • "OutOfRange" = 140
  • "NameTooLong" = 141
  • "InvalidSeek" = 142
  • "NotSupported" = 143
  • "TooManyOpenFiles" = 144
request/red_brick/<UID>/purge_program
Request payload:
 
  • program_id -- int
  • cookie -- int
Response payload:
 
  • error_code -- int (has symbols)

The following symbols are available for this function:

for error_code:

  • "Success" = 0
  • "UnknownError" = 1
  • "InvalidOperation" = 2
  • "OperationAborted" = 3
  • "InternalError" = 4
  • "UnknownSessionId" = 5
  • "NoFreeSessionId" = 6
  • "UnknownObjectId" = 7
  • "NoFreeObjectId" = 8
  • "ObjectIsLocked" = 9
  • "NoMoreData" = 10
  • "WrongListItemType" = 11
  • "ProgramIsPurged" = 12
  • "InvalidParameter" = 128
  • "NoFreeMemory" = 129
  • "NoFreeSpace" = 130
  • "AccessDenied" = 121
  • "AlreadyExists" = 132
  • "DoesNotExist" = 133
  • "Interrupted" = 134
  • "IsDirectory" = 135
  • "NotADirectory" = 136
  • "WouldBlock" = 137
  • "Overflow" = 138
  • "BadFileDescriptor" = 139
  • "OutOfRange" = 140
  • "NameTooLong" = 141
  • "InvalidSeek" = 142
  • "NotSupported" = 143
  • "TooManyOpenFiles" = 144
request/red_brick/<UID>/get_program_identifier
Request payload:
 
  • program_id -- int
  • session_id -- int
Response payload:
 
  • error_code -- int (has symbols)
  • identifier_string_id -- int

The following symbols are available for this function:

for error_code:

  • "Success" = 0
  • "UnknownError" = 1
  • "InvalidOperation" = 2
  • "OperationAborted" = 3
  • "InternalError" = 4
  • "UnknownSessionId" = 5
  • "NoFreeSessionId" = 6
  • "UnknownObjectId" = 7
  • "NoFreeObjectId" = 8
  • "ObjectIsLocked" = 9
  • "NoMoreData" = 10
  • "WrongListItemType" = 11
  • "ProgramIsPurged" = 12
  • "InvalidParameter" = 128
  • "NoFreeMemory" = 129
  • "NoFreeSpace" = 130
  • "AccessDenied" = 121
  • "AlreadyExists" = 132
  • "DoesNotExist" = 133
  • "Interrupted" = 134
  • "IsDirectory" = 135
  • "NotADirectory" = 136
  • "WouldBlock" = 137
  • "Overflow" = 138
  • "BadFileDescriptor" = 139
  • "OutOfRange" = 140
  • "NameTooLong" = 141
  • "InvalidSeek" = 142
  • "NotSupported" = 143
  • "TooManyOpenFiles" = 144
request/red_brick/<UID>/get_program_root_directory
Request payload:
 
  • program_id -- int
  • session_id -- int
Response payload:
 
  • error_code -- int (has symbols)
  • root_directory_string_id -- int

FIXME: root directory is absolute: <home>/programs/<identifier>

The following symbols are available for this function:

for error_code:

  • "Success" = 0
  • "UnknownError" = 1
  • "InvalidOperation" = 2
  • "OperationAborted" = 3
  • "InternalError" = 4
  • "UnknownSessionId" = 5
  • "NoFreeSessionId" = 6
  • "UnknownObjectId" = 7
  • "NoFreeObjectId" = 8
  • "ObjectIsLocked" = 9
  • "NoMoreData" = 10
  • "WrongListItemType" = 11
  • "ProgramIsPurged" = 12
  • "InvalidParameter" = 128
  • "NoFreeMemory" = 129
  • "NoFreeSpace" = 130
  • "AccessDenied" = 121
  • "AlreadyExists" = 132
  • "DoesNotExist" = 133
  • "Interrupted" = 134
  • "IsDirectory" = 135
  • "NotADirectory" = 136
  • "WouldBlock" = 137
  • "Overflow" = 138
  • "BadFileDescriptor" = 139
  • "OutOfRange" = 140
  • "NameTooLong" = 141
  • "InvalidSeek" = 142
  • "NotSupported" = 143
  • "TooManyOpenFiles" = 144
request/red_brick/<UID>/set_program_command
Request payload:
 
  • program_id -- int
  • executable_string_id -- int
  • arguments_list_id -- int
  • environment_list_id -- int
  • working_directory_string_id -- int
Response payload:
 
  • error_code -- int (has symbols)

FIXME: working directory is relative to <home>/programs/<identifier>/bin

The following symbols are available for this function:

for error_code:

  • "Success" = 0
  • "UnknownError" = 1
  • "InvalidOperation" = 2
  • "OperationAborted" = 3
  • "InternalError" = 4
  • "UnknownSessionId" = 5
  • "NoFreeSessionId" = 6
  • "UnknownObjectId" = 7
  • "NoFreeObjectId" = 8
  • "ObjectIsLocked" = 9
  • "NoMoreData" = 10
  • "WrongListItemType" = 11
  • "ProgramIsPurged" = 12
  • "InvalidParameter" = 128
  • "NoFreeMemory" = 129
  • "NoFreeSpace" = 130
  • "AccessDenied" = 121
  • "AlreadyExists" = 132
  • "DoesNotExist" = 133
  • "Interrupted" = 134
  • "IsDirectory" = 135
  • "NotADirectory" = 136
  • "WouldBlock" = 137
  • "Overflow" = 138
  • "BadFileDescriptor" = 139
  • "OutOfRange" = 140
  • "NameTooLong" = 141
  • "InvalidSeek" = 142
  • "NotSupported" = 143
  • "TooManyOpenFiles" = 144
request/red_brick/<UID>/get_program_command
Request payload:
 
  • program_id -- int
  • session_id -- int
Response payload:
 
  • error_code -- int (has symbols)
  • executable_string_id -- int
  • arguments_list_id -- int
  • environment_list_id -- int
  • working_directory_string_id -- int

FIXME: working directory is relative to <home>/programs/<identifier>/bin

The following symbols are available for this function:

for error_code:

  • "Success" = 0
  • "UnknownError" = 1
  • "InvalidOperation" = 2
  • "OperationAborted" = 3
  • "InternalError" = 4
  • "UnknownSessionId" = 5
  • "NoFreeSessionId" = 6
  • "UnknownObjectId" = 7
  • "NoFreeObjectId" = 8
  • "ObjectIsLocked" = 9
  • "NoMoreData" = 10
  • "WrongListItemType" = 11
  • "ProgramIsPurged" = 12
  • "InvalidParameter" = 128
  • "NoFreeMemory" = 129
  • "NoFreeSpace" = 130
  • "AccessDenied" = 121
  • "AlreadyExists" = 132
  • "DoesNotExist" = 133
  • "Interrupted" = 134
  • "IsDirectory" = 135
  • "NotADirectory" = 136
  • "WouldBlock" = 137
  • "Overflow" = 138
  • "BadFileDescriptor" = 139
  • "OutOfRange" = 140
  • "NameTooLong" = 141
  • "InvalidSeek" = 142
  • "NotSupported" = 143
  • "TooManyOpenFiles" = 144
request/red_brick/<UID>/set_program_stdio_redirection
Request payload:
 
  • program_id -- int
  • stdin_redirection -- int (has symbols)
  • stdin_file_name_string_id -- int
  • stdout_redirection -- int (has symbols)
  • stdout_file_name_string_id -- int
  • stderr_redirection -- int (has symbols)
  • stderr_file_name_string_id -- int
Response payload:
 
  • error_code -- int (has symbols)

FIXME: stdio file names are relative to <home>/programs/<identifier>/bin

The following symbols are available for this function:

for stdin_redirection:

  • "DevNull" = 0
  • "Pipe" = 1
  • "File" = 2
  • "IndividualLog" = 3
  • "ContinuousLog" = 4
  • "Stdout" = 5

for error_code:

  • "Success" = 0
  • "UnknownError" = 1
  • "InvalidOperation" = 2
  • "OperationAborted" = 3
  • "InternalError" = 4
  • "UnknownSessionId" = 5
  • "NoFreeSessionId" = 6
  • "UnknownObjectId" = 7
  • "NoFreeObjectId" = 8
  • "ObjectIsLocked" = 9
  • "NoMoreData" = 10
  • "WrongListItemType" = 11
  • "ProgramIsPurged" = 12
  • "InvalidParameter" = 128
  • "NoFreeMemory" = 129
  • "NoFreeSpace" = 130
  • "AccessDenied" = 121
  • "AlreadyExists" = 132
  • "DoesNotExist" = 133
  • "Interrupted" = 134
  • "IsDirectory" = 135
  • "NotADirectory" = 136
  • "WouldBlock" = 137
  • "Overflow" = 138
  • "BadFileDescriptor" = 139
  • "OutOfRange" = 140
  • "NameTooLong" = 141
  • "InvalidSeek" = 142
  • "NotSupported" = 143
  • "TooManyOpenFiles" = 144
request/red_brick/<UID>/get_program_stdio_redirection
Request payload:
 
  • program_id -- int
  • session_id -- int
Response payload:
 
  • error_code -- int (has symbols)
  • stdin_redirection -- int (has symbols)
  • stdin_file_name_string_id -- int
  • stdout_redirection -- int (has symbols)
  • stdout_file_name_string_id -- int
  • stderr_redirection -- int (has symbols)
  • stderr_file_name_string_id -- int

FIXME: stdio file names are relative to <home>/programs/<identifier>/bin

The following symbols are available for this function:

for error_code:

  • "Success" = 0
  • "UnknownError" = 1
  • "InvalidOperation" = 2
  • "OperationAborted" = 3
  • "InternalError" = 4
  • "UnknownSessionId" = 5
  • "NoFreeSessionId" = 6
  • "UnknownObjectId" = 7
  • "NoFreeObjectId" = 8
  • "ObjectIsLocked" = 9
  • "NoMoreData" = 10
  • "WrongListItemType" = 11
  • "ProgramIsPurged" = 12
  • "InvalidParameter" = 128
  • "NoFreeMemory" = 129
  • "NoFreeSpace" = 130
  • "AccessDenied" = 121
  • "AlreadyExists" = 132
  • "DoesNotExist" = 133
  • "Interrupted" = 134
  • "IsDirectory" = 135
  • "NotADirectory" = 136
  • "WouldBlock" = 137
  • "Overflow" = 138
  • "BadFileDescriptor" = 139
  • "OutOfRange" = 140
  • "NameTooLong" = 141
  • "InvalidSeek" = 142
  • "NotSupported" = 143
  • "TooManyOpenFiles" = 144

for stdin_redirection:

  • "DevNull" = 0
  • "Pipe" = 1
  • "File" = 2
  • "IndividualLog" = 3
  • "ContinuousLog" = 4
  • "Stdout" = 5
request/red_brick/<UID>/set_program_schedule
Request payload:
 
  • program_id -- int
  • start_mode -- int (has symbols)
  • continue_after_error -- bool
  • start_interval -- int
  • start_fields_string_id -- int
Response payload:
 
  • error_code -- int (has symbols)

The following symbols are available for this function:

for start_mode:

  • "Never" = 0
  • "Always" = 1
  • "Interval" = 2
  • "Cron" = 3

for error_code:

  • "Success" = 0
  • "UnknownError" = 1
  • "InvalidOperation" = 2
  • "OperationAborted" = 3
  • "InternalError" = 4
  • "UnknownSessionId" = 5
  • "NoFreeSessionId" = 6
  • "UnknownObjectId" = 7
  • "NoFreeObjectId" = 8
  • "ObjectIsLocked" = 9
  • "NoMoreData" = 10
  • "WrongListItemType" = 11
  • "ProgramIsPurged" = 12
  • "InvalidParameter" = 128
  • "NoFreeMemory" = 129
  • "NoFreeSpace" = 130
  • "AccessDenied" = 121
  • "AlreadyExists" = 132
  • "DoesNotExist" = 133
  • "Interrupted" = 134
  • "IsDirectory" = 135
  • "NotADirectory" = 136
  • "WouldBlock" = 137
  • "Overflow" = 138
  • "BadFileDescriptor" = 139
  • "OutOfRange" = 140
  • "NameTooLong" = 141
  • "InvalidSeek" = 142
  • "NotSupported" = 143
  • "TooManyOpenFiles" = 144
request/red_brick/<UID>/get_program_schedule
Request payload:
 
  • program_id -- int
  • session_id -- int
Response payload:
 
  • error_code -- int (has symbols)
  • start_mode -- int (has symbols)
  • continue_after_error -- bool
  • start_interval -- int
  • start_fields_string_id -- int

The following symbols are available for this function:

for error_code:

  • "Success" = 0
  • "UnknownError" = 1
  • "InvalidOperation" = 2
  • "OperationAborted" = 3
  • "InternalError" = 4
  • "UnknownSessionId" = 5
  • "NoFreeSessionId" = 6
  • "UnknownObjectId" = 7
  • "NoFreeObjectId" = 8
  • "ObjectIsLocked" = 9
  • "NoMoreData" = 10
  • "WrongListItemType" = 11
  • "ProgramIsPurged" = 12
  • "InvalidParameter" = 128
  • "NoFreeMemory" = 129
  • "NoFreeSpace" = 130
  • "AccessDenied" = 121
  • "AlreadyExists" = 132
  • "DoesNotExist" = 133
  • "Interrupted" = 134
  • "IsDirectory" = 135
  • "NotADirectory" = 136
  • "WouldBlock" = 137
  • "Overflow" = 138
  • "BadFileDescriptor" = 139
  • "OutOfRange" = 140
  • "NameTooLong" = 141
  • "InvalidSeek" = 142
  • "NotSupported" = 143
  • "TooManyOpenFiles" = 144

for start_mode:

  • "Never" = 0
  • "Always" = 1
  • "Interval" = 2
  • "Cron" = 3
request/red_brick/<UID>/get_program_scheduler_state
Request payload:
 
  • program_id -- int
  • session_id -- int
Response payload:
 
  • error_code -- int (has symbols)
  • state -- int (has symbols)
  • timestamp -- int
  • message_string_id -- int

FIXME: message is currently valid in error-occurred state only

The following symbols are available for this function:

for error_code:

  • "Success" = 0
  • "UnknownError" = 1
  • "InvalidOperation" = 2
  • "OperationAborted" = 3
  • "InternalError" = 4
  • "UnknownSessionId" = 5
  • "NoFreeSessionId" = 6
  • "UnknownObjectId" = 7
  • "NoFreeObjectId" = 8
  • "ObjectIsLocked" = 9
  • "NoMoreData" = 10
  • "WrongListItemType" = 11
  • "ProgramIsPurged" = 12
  • "InvalidParameter" = 128
  • "NoFreeMemory" = 129
  • "NoFreeSpace" = 130
  • "AccessDenied" = 121
  • "AlreadyExists" = 132
  • "DoesNotExist" = 133
  • "Interrupted" = 134
  • "IsDirectory" = 135
  • "NotADirectory" = 136
  • "WouldBlock" = 137
  • "Overflow" = 138
  • "BadFileDescriptor" = 139
  • "OutOfRange" = 140
  • "NameTooLong" = 141
  • "InvalidSeek" = 142
  • "NotSupported" = 143
  • "TooManyOpenFiles" = 144

for state:

  • "Stopped" = 0
  • "Running" = 1
request/red_brick/<UID>/continue_program_schedule
Request payload:
 
  • program_id -- int
Response payload:
 
  • error_code -- int (has symbols)

The following symbols are available for this function:

for error_code:

  • "Success" = 0
  • "UnknownError" = 1
  • "InvalidOperation" = 2
  • "OperationAborted" = 3
  • "InternalError" = 4
  • "UnknownSessionId" = 5
  • "NoFreeSessionId" = 6
  • "UnknownObjectId" = 7
  • "NoFreeObjectId" = 8
  • "ObjectIsLocked" = 9
  • "NoMoreData" = 10
  • "WrongListItemType" = 11
  • "ProgramIsPurged" = 12
  • "InvalidParameter" = 128
  • "NoFreeMemory" = 129
  • "NoFreeSpace" = 130
  • "AccessDenied" = 121
  • "AlreadyExists" = 132
  • "DoesNotExist" = 133
  • "Interrupted" = 134
  • "IsDirectory" = 135
  • "NotADirectory" = 136
  • "WouldBlock" = 137
  • "Overflow" = 138
  • "BadFileDescriptor" = 139
  • "OutOfRange" = 140
  • "NameTooLong" = 141
  • "InvalidSeek" = 142
  • "NotSupported" = 143
  • "TooManyOpenFiles" = 144
request/red_brick/<UID>/start_program
Request payload:
 
  • program_id -- int
Response payload:
 
  • error_code -- int (has symbols)

The following symbols are available for this function:

for error_code:

  • "Success" = 0
  • "UnknownError" = 1
  • "InvalidOperation" = 2
  • "OperationAborted" = 3
  • "InternalError" = 4
  • "UnknownSessionId" = 5
  • "NoFreeSessionId" = 6
  • "UnknownObjectId" = 7
  • "NoFreeObjectId" = 8
  • "ObjectIsLocked" = 9
  • "NoMoreData" = 10
  • "WrongListItemType" = 11
  • "ProgramIsPurged" = 12
  • "InvalidParameter" = 128
  • "NoFreeMemory" = 129
  • "NoFreeSpace" = 130
  • "AccessDenied" = 121
  • "AlreadyExists" = 132
  • "DoesNotExist" = 133
  • "Interrupted" = 134
  • "IsDirectory" = 135
  • "NotADirectory" = 136
  • "WouldBlock" = 137
  • "Overflow" = 138
  • "BadFileDescriptor" = 139
  • "OutOfRange" = 140
  • "NameTooLong" = 141
  • "InvalidSeek" = 142
  • "NotSupported" = 143
  • "TooManyOpenFiles" = 144
request/red_brick/<UID>/get_last_spawned_program_process
Request payload:
 
  • program_id -- int
  • session_id -- int
Response payload:
 
  • error_code -- int (has symbols)
  • process_id -- int
  • timestamp -- int

The following symbols are available for this function:

for error_code:

  • "Success" = 0
  • "UnknownError" = 1
  • "InvalidOperation" = 2
  • "OperationAborted" = 3
  • "InternalError" = 4
  • "UnknownSessionId" = 5
  • "NoFreeSessionId" = 6
  • "UnknownObjectId" = 7
  • "NoFreeObjectId" = 8
  • "ObjectIsLocked" = 9
  • "NoMoreData" = 10
  • "WrongListItemType" = 11
  • "ProgramIsPurged" = 12
  • "InvalidParameter" = 128
  • "NoFreeMemory" = 129
  • "NoFreeSpace" = 130
  • "AccessDenied" = 121
  • "AlreadyExists" = 132
  • "DoesNotExist" = 133
  • "Interrupted" = 134
  • "IsDirectory" = 135
  • "NotADirectory" = 136
  • "WouldBlock" = 137
  • "Overflow" = 138
  • "BadFileDescriptor" = 139
  • "OutOfRange" = 140
  • "NameTooLong" = 141
  • "InvalidSeek" = 142
  • "NotSupported" = 143
  • "TooManyOpenFiles" = 144
request/red_brick/<UID>/get_custom_program_option_names
Request payload:
 
  • program_id -- int
  • session_id -- int
Response payload:
 
  • error_code -- int (has symbols)
  • names_list_id -- int

The following symbols are available for this function:

for error_code:

  • "Success" = 0
  • "UnknownError" = 1
  • "InvalidOperation" = 2
  • "OperationAborted" = 3
  • "InternalError" = 4
  • "UnknownSessionId" = 5
  • "NoFreeSessionId" = 6
  • "UnknownObjectId" = 7
  • "NoFreeObjectId" = 8
  • "ObjectIsLocked" = 9
  • "NoMoreData" = 10
  • "WrongListItemType" = 11
  • "ProgramIsPurged" = 12
  • "InvalidParameter" = 128
  • "NoFreeMemory" = 129
  • "NoFreeSpace" = 130
  • "AccessDenied" = 121
  • "AlreadyExists" = 132
  • "DoesNotExist" = 133
  • "Interrupted" = 134
  • "IsDirectory" = 135
  • "NotADirectory" = 136
  • "WouldBlock" = 137
  • "Overflow" = 138
  • "BadFileDescriptor" = 139
  • "OutOfRange" = 140
  • "NameTooLong" = 141
  • "InvalidSeek" = 142
  • "NotSupported" = 143
  • "TooManyOpenFiles" = 144
request/red_brick/<UID>/set_custom_program_option_value
Request payload:
 
  • program_id -- int
  • name_string_id -- int
  • value_string_id -- int
Response payload:
 
  • error_code -- int (has symbols)

The following symbols are available for this function:

for error_code:

  • "Success" = 0
  • "UnknownError" = 1
  • "InvalidOperation" = 2
  • "OperationAborted" = 3
  • "InternalError" = 4
  • "UnknownSessionId" = 5
  • "NoFreeSessionId" = 6
  • "UnknownObjectId" = 7
  • "NoFreeObjectId" = 8
  • "ObjectIsLocked" = 9
  • "NoMoreData" = 10
  • "WrongListItemType" = 11
  • "ProgramIsPurged" = 12
  • "InvalidParameter" = 128
  • "NoFreeMemory" = 129
  • "NoFreeSpace" = 130
  • "AccessDenied" = 121
  • "AlreadyExists" = 132
  • "DoesNotExist" = 133
  • "Interrupted" = 134
  • "IsDirectory" = 135
  • "NotADirectory" = 136
  • "WouldBlock" = 137
  • "Overflow" = 138
  • "BadFileDescriptor" = 139
  • "OutOfRange" = 140
  • "NameTooLong" = 141
  • "InvalidSeek" = 142
  • "NotSupported" = 143
  • "TooManyOpenFiles" = 144
request/red_brick/<UID>/get_custom_program_option_value
Request payload:
 
  • program_id -- int
  • name_string_id -- int
  • session_id -- int
Response payload:
 
  • error_code -- int (has symbols)
  • value_string_id -- int

The following symbols are available for this function:

for error_code:

  • "Success" = 0
  • "UnknownError" = 1
  • "InvalidOperation" = 2
  • "OperationAborted" = 3
  • "InternalError" = 4
  • "UnknownSessionId" = 5
  • "NoFreeSessionId" = 6
  • "UnknownObjectId" = 7
  • "NoFreeObjectId" = 8
  • "ObjectIsLocked" = 9
  • "NoMoreData" = 10
  • "WrongListItemType" = 11
  • "ProgramIsPurged" = 12
  • "InvalidParameter" = 128
  • "NoFreeMemory" = 129
  • "NoFreeSpace" = 130
  • "AccessDenied" = 121
  • "AlreadyExists" = 132
  • "DoesNotExist" = 133
  • "Interrupted" = 134
  • "IsDirectory" = 135
  • "NotADirectory" = 136
  • "WouldBlock" = 137
  • "Overflow" = 138
  • "BadFileDescriptor" = 139
  • "OutOfRange" = 140
  • "NameTooLong" = 141
  • "InvalidSeek" = 142
  • "NotSupported" = 143
  • "TooManyOpenFiles" = 144
request/red_brick/<UID>/remove_custom_program_option
Request payload:
 
  • program_id -- int
  • name_string_id -- int
Response payload:
 
  • error_code -- int (has symbols)

The following symbols are available for this function:

for error_code:

  • "Success" = 0
  • "UnknownError" = 1
  • "InvalidOperation" = 2
  • "OperationAborted" = 3
  • "InternalError" = 4
  • "UnknownSessionId" = 5
  • "NoFreeSessionId" = 6
  • "UnknownObjectId" = 7
  • "NoFreeObjectId" = 8
  • "ObjectIsLocked" = 9
  • "NoMoreData" = 10
  • "WrongListItemType" = 11
  • "ProgramIsPurged" = 12
  • "InvalidParameter" = 128
  • "NoFreeMemory" = 129
  • "NoFreeSpace" = 130
  • "AccessDenied" = 121
  • "AlreadyExists" = 132
  • "DoesNotExist" = 133
  • "Interrupted" = 134
  • "IsDirectory" = 135
  • "NotADirectory" = 136
  • "WouldBlock" = 137
  • "Overflow" = 138
  • "BadFileDescriptor" = 139
  • "OutOfRange" = 140
  • "NameTooLong" = 141
  • "InvalidSeek" = 142
  • "NotSupported" = 143
  • "TooManyOpenFiles" = 144
request/red_brick/<UID>/get_identity
Response payload:
 
  • uid -- string
  • connected_uid -- string
  • position -- string
  • hardware_version -- [int,int,int]
  • firmware_version -- [int,int,int]
  • device_identifier -- int (has symbols)
  • _display_name -- string

Returns the UID, the UID where the Brick is connected to, the position, the hardware and firmware version as well as the device identifier.

The position can be '0'-'8' (stack position).

The device identifier numbers can be found here. If symbolic output is not disabled, the device identifier is mapped to the corresponding name in the format used in topics.

The display name contains the RED's name in a human readable form.

Callback Configuration Functions

Callbacks

Callbacks can be registered to receive time critical or recurring data from the device. The registration is done with the corresponding .../register/... topic and an optional suffix. This suffix can be used to deregister the callback later.

Note

Using callbacks for recurring events is always preferred compared to using getters. It will use less USB bandwidth and the latency will be a lot better, since there is no round trip time.

register/red_brick/<UID>/async_file_read
Request payload:
 
  • register -- bool
Response payload:
 
  • file_id -- int
  • error_code -- int (has symbols)
  • buffer -- [int,... (x60)]
  • length_read -- int

A callback can be registered for this event by publishing to the .../register/red_brick/<UID>/async_file_read[/<SUFFIX>] topic with the payload "true". An added callback can be removed by publishing to the same topic with the payload "false". To support multiple (de)registrations, e.g. for message filtering, an optional suffix can be used.

If the callback is triggered, a message with it's payload is published under the corresponding .../callback/red_brick/<UID>/async_file_read[/<SUFFIX>] topic for each registered suffix.

This callback reports the result of a call to the request/red_brick/<UID>/read_file_async function.

The following symbols are available for this function:

for error_code:

  • "Success" = 0
  • "UnknownError" = 1
  • "InvalidOperation" = 2
  • "OperationAborted" = 3
  • "InternalError" = 4
  • "UnknownSessionId" = 5
  • "NoFreeSessionId" = 6
  • "UnknownObjectId" = 7
  • "NoFreeObjectId" = 8
  • "ObjectIsLocked" = 9
  • "NoMoreData" = 10
  • "WrongListItemType" = 11
  • "ProgramIsPurged" = 12
  • "InvalidParameter" = 128
  • "NoFreeMemory" = 129
  • "NoFreeSpace" = 130
  • "AccessDenied" = 121
  • "AlreadyExists" = 132
  • "DoesNotExist" = 133
  • "Interrupted" = 134
  • "IsDirectory" = 135
  • "NotADirectory" = 136
  • "WouldBlock" = 137
  • "Overflow" = 138
  • "BadFileDescriptor" = 139
  • "OutOfRange" = 140
  • "NameTooLong" = 141
  • "InvalidSeek" = 142
  • "NotSupported" = 143
  • "TooManyOpenFiles" = 144
register/red_brick/<UID>/async_file_write
Request payload:
 
  • register -- bool
Response payload:
 
  • file_id -- int
  • error_code -- int (has symbols)
  • length_written -- int

A callback can be registered for this event by publishing to the .../register/red_brick/<UID>/async_file_write[/<SUFFIX>] topic with the payload "true". An added callback can be removed by publishing to the same topic with the payload "false". To support multiple (de)registrations, e.g. for message filtering, an optional suffix can be used.

If the callback is triggered, a message with it's payload is published under the corresponding .../callback/red_brick/<UID>/async_file_write[/<SUFFIX>] topic for each registered suffix.

This callback reports the result of a call to the request/red_brick/<UID>/write_file_async function.

The following symbols are available for this function:

for error_code:

  • "Success" = 0
  • "UnknownError" = 1
  • "InvalidOperation" = 2
  • "OperationAborted" = 3
  • "InternalError" = 4
  • "UnknownSessionId" = 5
  • "NoFreeSessionId" = 6
  • "UnknownObjectId" = 7
  • "NoFreeObjectId" = 8
  • "ObjectIsLocked" = 9
  • "NoMoreData" = 10
  • "WrongListItemType" = 11
  • "ProgramIsPurged" = 12
  • "InvalidParameter" = 128
  • "NoFreeMemory" = 129
  • "NoFreeSpace" = 130
  • "AccessDenied" = 121
  • "AlreadyExists" = 132
  • "DoesNotExist" = 133
  • "Interrupted" = 134
  • "IsDirectory" = 135
  • "NotADirectory" = 136
  • "WouldBlock" = 137
  • "Overflow" = 138
  • "BadFileDescriptor" = 139
  • "OutOfRange" = 140
  • "NameTooLong" = 141
  • "InvalidSeek" = 142
  • "NotSupported" = 143
  • "TooManyOpenFiles" = 144
register/red_brick/<UID>/file_events_occurred
Request payload:
 
  • register -- bool
Response payload:
 
  • file_id -- int
  • events -- int (has symbols)

A callback can be registered for this event by publishing to the .../register/red_brick/<UID>/file_events_occurred[/<SUFFIX>] topic with the payload "true". An added callback can be removed by publishing to the same topic with the payload "false". To support multiple (de)registrations, e.g. for message filtering, an optional suffix can be used.

If the callback is triggered, a message with it's payload is published under the corresponding .../callback/red_brick/<UID>/file_events_occurred[/<SUFFIX>] topic for each registered suffix.

The following symbols are available for this function:

for events:

  • "Readable" = 1
  • "Writable" = 2
register/red_brick/<UID>/process_state_changed
Request payload:
 
  • register -- bool
Response payload:
 
  • process_id -- int
  • state -- int (has symbols)
  • timestamp -- int
  • exit_code -- int

A callback can be registered for this event by publishing to the .../register/red_brick/<UID>/process_state_changed[/<SUFFIX>] topic with the payload "true". An added callback can be removed by publishing to the same topic with the payload "false". To support multiple (de)registrations, e.g. for message filtering, an optional suffix can be used.

If the callback is triggered, a message with it's payload is published under the corresponding .../callback/red_brick/<UID>/process_state_changed[/<SUFFIX>] topic for each registered suffix.

The following symbols are available for this function:

for state:

  • "Unknown" = 0
  • "Running" = 1
  • "Error" = 2
  • "Exited" = 3
  • "Killed" = 4
  • "Stopped" = 5
register/red_brick/<UID>/program_scheduler_state_changed
Request payload:
 
  • register -- bool
Response payload:
 
  • program_id -- int

A callback can be registered for this event by publishing to the .../register/red_brick/<UID>/program_scheduler_state_changed[/<SUFFIX>] topic with the payload "true". An added callback can be removed by publishing to the same topic with the payload "false". To support multiple (de)registrations, e.g. for message filtering, an optional suffix can be used.

If the callback is triggered, a message with it's payload is published under the corresponding .../callback/red_brick/<UID>/program_scheduler_state_changed[/<SUFFIX>] topic for each registered suffix.

register/red_brick/<UID>/program_process_spawned
Request payload:
 
  • register -- bool
Response payload:
 
  • program_id -- int

A callback can be registered for this event by publishing to the .../register/red_brick/<UID>/program_process_spawned[/<SUFFIX>] topic with the payload "true". An added callback can be removed by publishing to the same topic with the payload "false". To support multiple (de)registrations, e.g. for message filtering, an optional suffix can be used.

If the callback is triggered, a message with it's payload is published under the corresponding .../callback/red_brick/<UID>/program_process_spawned[/<SUFFIX>] topic for each registered suffix.