API
Generally, every method of the Python bindings can throw an
tinkerforge.ip_connection.Error exception that has a value and a
description property. value can have different values:
- Error.TIMEOUT = -1
- Error.ALREADY_CONNECTED = -7
- Error.NOT_CONNECTED = -8
- Error.INVALID_PARAMETER = -9
- Error.NOT_SUPPORTED = -10
- Error.UNKNOWN_ERROR_CODE = -11
- Error.STREAM_OUT_OF_SYNC = -12
All methods listed below are thread-safe.
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. allocate_string()
and get_next_directory_entry()) increase the reference count of the returned
object. If the object is no longer needed then 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 release_object() must not be called for
such an object in response to a callback.
There are functions (e.g. get_file_info()) that only return valid objects
under certain conditions. This conditions are documented for the specific
functions. For invalid objects release_object() must not be called.
There are also function (e.g. 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
-
BrickRED.create_session(lifetime)
Parameters: | lifetime -- int |
Return type: | (int, int) |
The following constants are available for this function:
- BrickRED.ERROR_CODE_SUCCESS = 0
- BrickRED.ERROR_CODE_UNKNOWN_ERROR = 1
- BrickRED.ERROR_CODE_INVALID_OPERATION = 2
- BrickRED.ERROR_CODE_OPERATION_ABORTED = 3
- BrickRED.ERROR_CODE_INTERNAL_ERROR = 4
- BrickRED.ERROR_CODE_UNKNOWN_SESSION_ID = 5
- BrickRED.ERROR_CODE_NO_FREE_SESSION_ID = 6
- BrickRED.ERROR_CODE_UNKNOWN_OBJECT_ID = 7
- BrickRED.ERROR_CODE_NO_FREE_OBJECT_ID = 8
- BrickRED.ERROR_CODE_OBJECT_IS_LOCKED = 9
- BrickRED.ERROR_CODE_NO_MORE_DATA = 10
- BrickRED.ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
- BrickRED.ERROR_CODE_PROGRAM_IS_PURGED = 12
- BrickRED.ERROR_CODE_INVALID_PARAMETER = 128
- BrickRED.ERROR_CODE_NO_FREE_MEMORY = 129
- BrickRED.ERROR_CODE_NO_FREE_SPACE = 130
- BrickRED.ERROR_CODE_ACCESS_DENIED = 121
- BrickRED.ERROR_CODE_ALREADY_EXISTS = 132
- BrickRED.ERROR_CODE_DOES_NOT_EXIST = 133
- BrickRED.ERROR_CODE_INTERRUPTED = 134
- BrickRED.ERROR_CODE_IS_DIRECTORY = 135
- BrickRED.ERROR_CODE_NOT_A_DIRECTORY = 136
- BrickRED.ERROR_CODE_WOULD_BLOCK = 137
- BrickRED.ERROR_CODE_OVERFLOW = 138
- BrickRED.ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
- BrickRED.ERROR_CODE_OUT_OF_RANGE = 140
- BrickRED.ERROR_CODE_NAME_TOO_LONG = 141
- BrickRED.ERROR_CODE_INVALID_SEEK = 142
- BrickRED.ERROR_CODE_NOT_SUPPORTED = 143
- BrickRED.ERROR_CODE_TOO_MANY_OPEN_FILES = 144
The returned namedtuple has the variables error_code and session_id.
-
BrickRED.expire_session(session_id)
Parameters: | session_id -- int |
Return type: | int |
The following constants are available for this function:
- BrickRED.ERROR_CODE_SUCCESS = 0
- BrickRED.ERROR_CODE_UNKNOWN_ERROR = 1
- BrickRED.ERROR_CODE_INVALID_OPERATION = 2
- BrickRED.ERROR_CODE_OPERATION_ABORTED = 3
- BrickRED.ERROR_CODE_INTERNAL_ERROR = 4
- BrickRED.ERROR_CODE_UNKNOWN_SESSION_ID = 5
- BrickRED.ERROR_CODE_NO_FREE_SESSION_ID = 6
- BrickRED.ERROR_CODE_UNKNOWN_OBJECT_ID = 7
- BrickRED.ERROR_CODE_NO_FREE_OBJECT_ID = 8
- BrickRED.ERROR_CODE_OBJECT_IS_LOCKED = 9
- BrickRED.ERROR_CODE_NO_MORE_DATA = 10
- BrickRED.ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
- BrickRED.ERROR_CODE_PROGRAM_IS_PURGED = 12
- BrickRED.ERROR_CODE_INVALID_PARAMETER = 128
- BrickRED.ERROR_CODE_NO_FREE_MEMORY = 129
- BrickRED.ERROR_CODE_NO_FREE_SPACE = 130
- BrickRED.ERROR_CODE_ACCESS_DENIED = 121
- BrickRED.ERROR_CODE_ALREADY_EXISTS = 132
- BrickRED.ERROR_CODE_DOES_NOT_EXIST = 133
- BrickRED.ERROR_CODE_INTERRUPTED = 134
- BrickRED.ERROR_CODE_IS_DIRECTORY = 135
- BrickRED.ERROR_CODE_NOT_A_DIRECTORY = 136
- BrickRED.ERROR_CODE_WOULD_BLOCK = 137
- BrickRED.ERROR_CODE_OVERFLOW = 138
- BrickRED.ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
- BrickRED.ERROR_CODE_OUT_OF_RANGE = 140
- BrickRED.ERROR_CODE_NAME_TOO_LONG = 141
- BrickRED.ERROR_CODE_INVALID_SEEK = 142
- BrickRED.ERROR_CODE_NOT_SUPPORTED = 143
- BrickRED.ERROR_CODE_TOO_MANY_OPEN_FILES = 144
-
BrickRED.expire_session_unchecked(session_id)
Parameters: | session_id -- int |
Return type: | None |
-
BrickRED.keep_session_alive(session_id, lifetime)
Parameters: |
- session_id -- int
- lifetime -- int
|
Return type: | int
|
The following constants are available for this function:
- BrickRED.ERROR_CODE_SUCCESS = 0
- BrickRED.ERROR_CODE_UNKNOWN_ERROR = 1
- BrickRED.ERROR_CODE_INVALID_OPERATION = 2
- BrickRED.ERROR_CODE_OPERATION_ABORTED = 3
- BrickRED.ERROR_CODE_INTERNAL_ERROR = 4
- BrickRED.ERROR_CODE_UNKNOWN_SESSION_ID = 5
- BrickRED.ERROR_CODE_NO_FREE_SESSION_ID = 6
- BrickRED.ERROR_CODE_UNKNOWN_OBJECT_ID = 7
- BrickRED.ERROR_CODE_NO_FREE_OBJECT_ID = 8
- BrickRED.ERROR_CODE_OBJECT_IS_LOCKED = 9
- BrickRED.ERROR_CODE_NO_MORE_DATA = 10
- BrickRED.ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
- BrickRED.ERROR_CODE_PROGRAM_IS_PURGED = 12
- BrickRED.ERROR_CODE_INVALID_PARAMETER = 128
- BrickRED.ERROR_CODE_NO_FREE_MEMORY = 129
- BrickRED.ERROR_CODE_NO_FREE_SPACE = 130
- BrickRED.ERROR_CODE_ACCESS_DENIED = 121
- BrickRED.ERROR_CODE_ALREADY_EXISTS = 132
- BrickRED.ERROR_CODE_DOES_NOT_EXIST = 133
- BrickRED.ERROR_CODE_INTERRUPTED = 134
- BrickRED.ERROR_CODE_IS_DIRECTORY = 135
- BrickRED.ERROR_CODE_NOT_A_DIRECTORY = 136
- BrickRED.ERROR_CODE_WOULD_BLOCK = 137
- BrickRED.ERROR_CODE_OVERFLOW = 138
- BrickRED.ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
- BrickRED.ERROR_CODE_OUT_OF_RANGE = 140
- BrickRED.ERROR_CODE_NAME_TOO_LONG = 141
- BrickRED.ERROR_CODE_INVALID_SEEK = 142
- BrickRED.ERROR_CODE_NOT_SUPPORTED = 143
- BrickRED.ERROR_CODE_TOO_MANY_OPEN_FILES = 144
-
BrickRED.release_object(object_id, session_id)
Parameters: |
- object_id -- int
- session_id -- int
|
Return type: | int
|
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 constants are available for this function:
- BrickRED.ERROR_CODE_SUCCESS = 0
- BrickRED.ERROR_CODE_UNKNOWN_ERROR = 1
- BrickRED.ERROR_CODE_INVALID_OPERATION = 2
- BrickRED.ERROR_CODE_OPERATION_ABORTED = 3
- BrickRED.ERROR_CODE_INTERNAL_ERROR = 4
- BrickRED.ERROR_CODE_UNKNOWN_SESSION_ID = 5
- BrickRED.ERROR_CODE_NO_FREE_SESSION_ID = 6
- BrickRED.ERROR_CODE_UNKNOWN_OBJECT_ID = 7
- BrickRED.ERROR_CODE_NO_FREE_OBJECT_ID = 8
- BrickRED.ERROR_CODE_OBJECT_IS_LOCKED = 9
- BrickRED.ERROR_CODE_NO_MORE_DATA = 10
- BrickRED.ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
- BrickRED.ERROR_CODE_PROGRAM_IS_PURGED = 12
- BrickRED.ERROR_CODE_INVALID_PARAMETER = 128
- BrickRED.ERROR_CODE_NO_FREE_MEMORY = 129
- BrickRED.ERROR_CODE_NO_FREE_SPACE = 130
- BrickRED.ERROR_CODE_ACCESS_DENIED = 121
- BrickRED.ERROR_CODE_ALREADY_EXISTS = 132
- BrickRED.ERROR_CODE_DOES_NOT_EXIST = 133
- BrickRED.ERROR_CODE_INTERRUPTED = 134
- BrickRED.ERROR_CODE_IS_DIRECTORY = 135
- BrickRED.ERROR_CODE_NOT_A_DIRECTORY = 136
- BrickRED.ERROR_CODE_WOULD_BLOCK = 137
- BrickRED.ERROR_CODE_OVERFLOW = 138
- BrickRED.ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
- BrickRED.ERROR_CODE_OUT_OF_RANGE = 140
- BrickRED.ERROR_CODE_NAME_TOO_LONG = 141
- BrickRED.ERROR_CODE_INVALID_SEEK = 142
- BrickRED.ERROR_CODE_NOT_SUPPORTED = 143
- BrickRED.ERROR_CODE_TOO_MANY_OPEN_FILES = 144
-
BrickRED.release_object_unchecked(object_id, session_id)
Parameters: |
- object_id -- int
- session_id -- int
|
Return type: | None
|
-
BrickRED.allocate_string(length_to_reserve, buffer, session_id)
Parameters: |
- length_to_reserve -- int
- buffer -- str
- session_id -- int
|
Return type: | (int, 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 constants are available for this function:
- BrickRED.ERROR_CODE_SUCCESS = 0
- BrickRED.ERROR_CODE_UNKNOWN_ERROR = 1
- BrickRED.ERROR_CODE_INVALID_OPERATION = 2
- BrickRED.ERROR_CODE_OPERATION_ABORTED = 3
- BrickRED.ERROR_CODE_INTERNAL_ERROR = 4
- BrickRED.ERROR_CODE_UNKNOWN_SESSION_ID = 5
- BrickRED.ERROR_CODE_NO_FREE_SESSION_ID = 6
- BrickRED.ERROR_CODE_UNKNOWN_OBJECT_ID = 7
- BrickRED.ERROR_CODE_NO_FREE_OBJECT_ID = 8
- BrickRED.ERROR_CODE_OBJECT_IS_LOCKED = 9
- BrickRED.ERROR_CODE_NO_MORE_DATA = 10
- BrickRED.ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
- BrickRED.ERROR_CODE_PROGRAM_IS_PURGED = 12
- BrickRED.ERROR_CODE_INVALID_PARAMETER = 128
- BrickRED.ERROR_CODE_NO_FREE_MEMORY = 129
- BrickRED.ERROR_CODE_NO_FREE_SPACE = 130
- BrickRED.ERROR_CODE_ACCESS_DENIED = 121
- BrickRED.ERROR_CODE_ALREADY_EXISTS = 132
- BrickRED.ERROR_CODE_DOES_NOT_EXIST = 133
- BrickRED.ERROR_CODE_INTERRUPTED = 134
- BrickRED.ERROR_CODE_IS_DIRECTORY = 135
- BrickRED.ERROR_CODE_NOT_A_DIRECTORY = 136
- BrickRED.ERROR_CODE_WOULD_BLOCK = 137
- BrickRED.ERROR_CODE_OVERFLOW = 138
- BrickRED.ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
- BrickRED.ERROR_CODE_OUT_OF_RANGE = 140
- BrickRED.ERROR_CODE_NAME_TOO_LONG = 141
- BrickRED.ERROR_CODE_INVALID_SEEK = 142
- BrickRED.ERROR_CODE_NOT_SUPPORTED = 143
- BrickRED.ERROR_CODE_TOO_MANY_OPEN_FILES = 144
The returned namedtuple has the variables error_code and string_id.
-
BrickRED.truncate_string(string_id, length)
Parameters: |
- string_id -- int
- length -- int
|
Return type: | int
|
Truncates a string object to length bytes and returns the resulting
error code.
The following constants are available for this function:
- BrickRED.ERROR_CODE_SUCCESS = 0
- BrickRED.ERROR_CODE_UNKNOWN_ERROR = 1
- BrickRED.ERROR_CODE_INVALID_OPERATION = 2
- BrickRED.ERROR_CODE_OPERATION_ABORTED = 3
- BrickRED.ERROR_CODE_INTERNAL_ERROR = 4
- BrickRED.ERROR_CODE_UNKNOWN_SESSION_ID = 5
- BrickRED.ERROR_CODE_NO_FREE_SESSION_ID = 6
- BrickRED.ERROR_CODE_UNKNOWN_OBJECT_ID = 7
- BrickRED.ERROR_CODE_NO_FREE_OBJECT_ID = 8
- BrickRED.ERROR_CODE_OBJECT_IS_LOCKED = 9
- BrickRED.ERROR_CODE_NO_MORE_DATA = 10
- BrickRED.ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
- BrickRED.ERROR_CODE_PROGRAM_IS_PURGED = 12
- BrickRED.ERROR_CODE_INVALID_PARAMETER = 128
- BrickRED.ERROR_CODE_NO_FREE_MEMORY = 129
- BrickRED.ERROR_CODE_NO_FREE_SPACE = 130
- BrickRED.ERROR_CODE_ACCESS_DENIED = 121
- BrickRED.ERROR_CODE_ALREADY_EXISTS = 132
- BrickRED.ERROR_CODE_DOES_NOT_EXIST = 133
- BrickRED.ERROR_CODE_INTERRUPTED = 134
- BrickRED.ERROR_CODE_IS_DIRECTORY = 135
- BrickRED.ERROR_CODE_NOT_A_DIRECTORY = 136
- BrickRED.ERROR_CODE_WOULD_BLOCK = 137
- BrickRED.ERROR_CODE_OVERFLOW = 138
- BrickRED.ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
- BrickRED.ERROR_CODE_OUT_OF_RANGE = 140
- BrickRED.ERROR_CODE_NAME_TOO_LONG = 141
- BrickRED.ERROR_CODE_INVALID_SEEK = 142
- BrickRED.ERROR_CODE_NOT_SUPPORTED = 143
- BrickRED.ERROR_CODE_TOO_MANY_OPEN_FILES = 144
-
BrickRED.get_string_length(string_id)
Parameters: | string_id -- int |
Return type: | (int, int) |
Returns the length of a string object in bytes and the resulting error code.
The following constants are available for this function:
- BrickRED.ERROR_CODE_SUCCESS = 0
- BrickRED.ERROR_CODE_UNKNOWN_ERROR = 1
- BrickRED.ERROR_CODE_INVALID_OPERATION = 2
- BrickRED.ERROR_CODE_OPERATION_ABORTED = 3
- BrickRED.ERROR_CODE_INTERNAL_ERROR = 4
- BrickRED.ERROR_CODE_UNKNOWN_SESSION_ID = 5
- BrickRED.ERROR_CODE_NO_FREE_SESSION_ID = 6
- BrickRED.ERROR_CODE_UNKNOWN_OBJECT_ID = 7
- BrickRED.ERROR_CODE_NO_FREE_OBJECT_ID = 8
- BrickRED.ERROR_CODE_OBJECT_IS_LOCKED = 9
- BrickRED.ERROR_CODE_NO_MORE_DATA = 10
- BrickRED.ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
- BrickRED.ERROR_CODE_PROGRAM_IS_PURGED = 12
- BrickRED.ERROR_CODE_INVALID_PARAMETER = 128
- BrickRED.ERROR_CODE_NO_FREE_MEMORY = 129
- BrickRED.ERROR_CODE_NO_FREE_SPACE = 130
- BrickRED.ERROR_CODE_ACCESS_DENIED = 121
- BrickRED.ERROR_CODE_ALREADY_EXISTS = 132
- BrickRED.ERROR_CODE_DOES_NOT_EXIST = 133
- BrickRED.ERROR_CODE_INTERRUPTED = 134
- BrickRED.ERROR_CODE_IS_DIRECTORY = 135
- BrickRED.ERROR_CODE_NOT_A_DIRECTORY = 136
- BrickRED.ERROR_CODE_WOULD_BLOCK = 137
- BrickRED.ERROR_CODE_OVERFLOW = 138
- BrickRED.ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
- BrickRED.ERROR_CODE_OUT_OF_RANGE = 140
- BrickRED.ERROR_CODE_NAME_TOO_LONG = 141
- BrickRED.ERROR_CODE_INVALID_SEEK = 142
- BrickRED.ERROR_CODE_NOT_SUPPORTED = 143
- BrickRED.ERROR_CODE_TOO_MANY_OPEN_FILES = 144
The returned namedtuple has the variables error_code and length.
-
BrickRED.set_string_chunk(string_id, offset, buffer)
Parameters: |
- string_id -- int
- offset -- int
- buffer -- str
|
Return type: | int
|
Sets a chunk of up to 58 bytes in a string object beginning at offset.
Returns the resulting error code.
The following constants are available for this function:
- BrickRED.ERROR_CODE_SUCCESS = 0
- BrickRED.ERROR_CODE_UNKNOWN_ERROR = 1
- BrickRED.ERROR_CODE_INVALID_OPERATION = 2
- BrickRED.ERROR_CODE_OPERATION_ABORTED = 3
- BrickRED.ERROR_CODE_INTERNAL_ERROR = 4
- BrickRED.ERROR_CODE_UNKNOWN_SESSION_ID = 5
- BrickRED.ERROR_CODE_NO_FREE_SESSION_ID = 6
- BrickRED.ERROR_CODE_UNKNOWN_OBJECT_ID = 7
- BrickRED.ERROR_CODE_NO_FREE_OBJECT_ID = 8
- BrickRED.ERROR_CODE_OBJECT_IS_LOCKED = 9
- BrickRED.ERROR_CODE_NO_MORE_DATA = 10
- BrickRED.ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
- BrickRED.ERROR_CODE_PROGRAM_IS_PURGED = 12
- BrickRED.ERROR_CODE_INVALID_PARAMETER = 128
- BrickRED.ERROR_CODE_NO_FREE_MEMORY = 129
- BrickRED.ERROR_CODE_NO_FREE_SPACE = 130
- BrickRED.ERROR_CODE_ACCESS_DENIED = 121
- BrickRED.ERROR_CODE_ALREADY_EXISTS = 132
- BrickRED.ERROR_CODE_DOES_NOT_EXIST = 133
- BrickRED.ERROR_CODE_INTERRUPTED = 134
- BrickRED.ERROR_CODE_IS_DIRECTORY = 135
- BrickRED.ERROR_CODE_NOT_A_DIRECTORY = 136
- BrickRED.ERROR_CODE_WOULD_BLOCK = 137
- BrickRED.ERROR_CODE_OVERFLOW = 138
- BrickRED.ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
- BrickRED.ERROR_CODE_OUT_OF_RANGE = 140
- BrickRED.ERROR_CODE_NAME_TOO_LONG = 141
- BrickRED.ERROR_CODE_INVALID_SEEK = 142
- BrickRED.ERROR_CODE_NOT_SUPPORTED = 143
- BrickRED.ERROR_CODE_TOO_MANY_OPEN_FILES = 144
-
BrickRED.get_string_chunk(string_id, offset)
Parameters: |
- string_id -- int
- offset -- int
|
Return type: | (int, str)
|
Returns a chunk up to 63 bytes from a string object beginning at offset and
returns the resulting error code.
The following constants are available for this function:
- BrickRED.ERROR_CODE_SUCCESS = 0
- BrickRED.ERROR_CODE_UNKNOWN_ERROR = 1
- BrickRED.ERROR_CODE_INVALID_OPERATION = 2
- BrickRED.ERROR_CODE_OPERATION_ABORTED = 3
- BrickRED.ERROR_CODE_INTERNAL_ERROR = 4
- BrickRED.ERROR_CODE_UNKNOWN_SESSION_ID = 5
- BrickRED.ERROR_CODE_NO_FREE_SESSION_ID = 6
- BrickRED.ERROR_CODE_UNKNOWN_OBJECT_ID = 7
- BrickRED.ERROR_CODE_NO_FREE_OBJECT_ID = 8
- BrickRED.ERROR_CODE_OBJECT_IS_LOCKED = 9
- BrickRED.ERROR_CODE_NO_MORE_DATA = 10
- BrickRED.ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
- BrickRED.ERROR_CODE_PROGRAM_IS_PURGED = 12
- BrickRED.ERROR_CODE_INVALID_PARAMETER = 128
- BrickRED.ERROR_CODE_NO_FREE_MEMORY = 129
- BrickRED.ERROR_CODE_NO_FREE_SPACE = 130
- BrickRED.ERROR_CODE_ACCESS_DENIED = 121
- BrickRED.ERROR_CODE_ALREADY_EXISTS = 132
- BrickRED.ERROR_CODE_DOES_NOT_EXIST = 133
- BrickRED.ERROR_CODE_INTERRUPTED = 134
- BrickRED.ERROR_CODE_IS_DIRECTORY = 135
- BrickRED.ERROR_CODE_NOT_A_DIRECTORY = 136
- BrickRED.ERROR_CODE_WOULD_BLOCK = 137
- BrickRED.ERROR_CODE_OVERFLOW = 138
- BrickRED.ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
- BrickRED.ERROR_CODE_OUT_OF_RANGE = 140
- BrickRED.ERROR_CODE_NAME_TOO_LONG = 141
- BrickRED.ERROR_CODE_INVALID_SEEK = 142
- BrickRED.ERROR_CODE_NOT_SUPPORTED = 143
- BrickRED.ERROR_CODE_TOO_MANY_OPEN_FILES = 144
The returned namedtuple has the variables error_code and buffer.
-
BrickRED.allocate_list(length_to_reserve, session_id)
Parameters: |
- length_to_reserve -- int
- session_id -- int
|
Return type: | (int, 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 constants are available for this function:
- BrickRED.ERROR_CODE_SUCCESS = 0
- BrickRED.ERROR_CODE_UNKNOWN_ERROR = 1
- BrickRED.ERROR_CODE_INVALID_OPERATION = 2
- BrickRED.ERROR_CODE_OPERATION_ABORTED = 3
- BrickRED.ERROR_CODE_INTERNAL_ERROR = 4
- BrickRED.ERROR_CODE_UNKNOWN_SESSION_ID = 5
- BrickRED.ERROR_CODE_NO_FREE_SESSION_ID = 6
- BrickRED.ERROR_CODE_UNKNOWN_OBJECT_ID = 7
- BrickRED.ERROR_CODE_NO_FREE_OBJECT_ID = 8
- BrickRED.ERROR_CODE_OBJECT_IS_LOCKED = 9
- BrickRED.ERROR_CODE_NO_MORE_DATA = 10
- BrickRED.ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
- BrickRED.ERROR_CODE_PROGRAM_IS_PURGED = 12
- BrickRED.ERROR_CODE_INVALID_PARAMETER = 128
- BrickRED.ERROR_CODE_NO_FREE_MEMORY = 129
- BrickRED.ERROR_CODE_NO_FREE_SPACE = 130
- BrickRED.ERROR_CODE_ACCESS_DENIED = 121
- BrickRED.ERROR_CODE_ALREADY_EXISTS = 132
- BrickRED.ERROR_CODE_DOES_NOT_EXIST = 133
- BrickRED.ERROR_CODE_INTERRUPTED = 134
- BrickRED.ERROR_CODE_IS_DIRECTORY = 135
- BrickRED.ERROR_CODE_NOT_A_DIRECTORY = 136
- BrickRED.ERROR_CODE_WOULD_BLOCK = 137
- BrickRED.ERROR_CODE_OVERFLOW = 138
- BrickRED.ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
- BrickRED.ERROR_CODE_OUT_OF_RANGE = 140
- BrickRED.ERROR_CODE_NAME_TOO_LONG = 141
- BrickRED.ERROR_CODE_INVALID_SEEK = 142
- BrickRED.ERROR_CODE_NOT_SUPPORTED = 143
- BrickRED.ERROR_CODE_TOO_MANY_OPEN_FILES = 144
The returned namedtuple has the variables error_code and list_id.
-
BrickRED.get_list_length(list_id)
Parameters: | list_id -- int |
Return type: | (int, int) |
Returns the length of a list object in items and the resulting error code.
The following constants are available for this function:
- BrickRED.ERROR_CODE_SUCCESS = 0
- BrickRED.ERROR_CODE_UNKNOWN_ERROR = 1
- BrickRED.ERROR_CODE_INVALID_OPERATION = 2
- BrickRED.ERROR_CODE_OPERATION_ABORTED = 3
- BrickRED.ERROR_CODE_INTERNAL_ERROR = 4
- BrickRED.ERROR_CODE_UNKNOWN_SESSION_ID = 5
- BrickRED.ERROR_CODE_NO_FREE_SESSION_ID = 6
- BrickRED.ERROR_CODE_UNKNOWN_OBJECT_ID = 7
- BrickRED.ERROR_CODE_NO_FREE_OBJECT_ID = 8
- BrickRED.ERROR_CODE_OBJECT_IS_LOCKED = 9
- BrickRED.ERROR_CODE_NO_MORE_DATA = 10
- BrickRED.ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
- BrickRED.ERROR_CODE_PROGRAM_IS_PURGED = 12
- BrickRED.ERROR_CODE_INVALID_PARAMETER = 128
- BrickRED.ERROR_CODE_NO_FREE_MEMORY = 129
- BrickRED.ERROR_CODE_NO_FREE_SPACE = 130
- BrickRED.ERROR_CODE_ACCESS_DENIED = 121
- BrickRED.ERROR_CODE_ALREADY_EXISTS = 132
- BrickRED.ERROR_CODE_DOES_NOT_EXIST = 133
- BrickRED.ERROR_CODE_INTERRUPTED = 134
- BrickRED.ERROR_CODE_IS_DIRECTORY = 135
- BrickRED.ERROR_CODE_NOT_A_DIRECTORY = 136
- BrickRED.ERROR_CODE_WOULD_BLOCK = 137
- BrickRED.ERROR_CODE_OVERFLOW = 138
- BrickRED.ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
- BrickRED.ERROR_CODE_OUT_OF_RANGE = 140
- BrickRED.ERROR_CODE_NAME_TOO_LONG = 141
- BrickRED.ERROR_CODE_INVALID_SEEK = 142
- BrickRED.ERROR_CODE_NOT_SUPPORTED = 143
- BrickRED.ERROR_CODE_TOO_MANY_OPEN_FILES = 144
The returned namedtuple has the variables error_code and length.
-
BrickRED.get_list_item(list_id, index, session_id)
Parameters: |
- list_id -- int
- index -- int
- session_id -- int
|
Return type: | (int, int, int)
|
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 constants are available for this function:
- BrickRED.ERROR_CODE_SUCCESS = 0
- BrickRED.ERROR_CODE_UNKNOWN_ERROR = 1
- BrickRED.ERROR_CODE_INVALID_OPERATION = 2
- BrickRED.ERROR_CODE_OPERATION_ABORTED = 3
- BrickRED.ERROR_CODE_INTERNAL_ERROR = 4
- BrickRED.ERROR_CODE_UNKNOWN_SESSION_ID = 5
- BrickRED.ERROR_CODE_NO_FREE_SESSION_ID = 6
- BrickRED.ERROR_CODE_UNKNOWN_OBJECT_ID = 7
- BrickRED.ERROR_CODE_NO_FREE_OBJECT_ID = 8
- BrickRED.ERROR_CODE_OBJECT_IS_LOCKED = 9
- BrickRED.ERROR_CODE_NO_MORE_DATA = 10
- BrickRED.ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
- BrickRED.ERROR_CODE_PROGRAM_IS_PURGED = 12
- BrickRED.ERROR_CODE_INVALID_PARAMETER = 128
- BrickRED.ERROR_CODE_NO_FREE_MEMORY = 129
- BrickRED.ERROR_CODE_NO_FREE_SPACE = 130
- BrickRED.ERROR_CODE_ACCESS_DENIED = 121
- BrickRED.ERROR_CODE_ALREADY_EXISTS = 132
- BrickRED.ERROR_CODE_DOES_NOT_EXIST = 133
- BrickRED.ERROR_CODE_INTERRUPTED = 134
- BrickRED.ERROR_CODE_IS_DIRECTORY = 135
- BrickRED.ERROR_CODE_NOT_A_DIRECTORY = 136
- BrickRED.ERROR_CODE_WOULD_BLOCK = 137
- BrickRED.ERROR_CODE_OVERFLOW = 138
- BrickRED.ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
- BrickRED.ERROR_CODE_OUT_OF_RANGE = 140
- BrickRED.ERROR_CODE_NAME_TOO_LONG = 141
- BrickRED.ERROR_CODE_INVALID_SEEK = 142
- BrickRED.ERROR_CODE_NOT_SUPPORTED = 143
- BrickRED.ERROR_CODE_TOO_MANY_OPEN_FILES = 144
- BrickRED.OBJECT_TYPE_STRING = 0
- BrickRED.OBJECT_TYPE_LIST = 1
- BrickRED.OBJECT_TYPE_FILE = 2
- BrickRED.OBJECT_TYPE_DIRECTORY = 3
- BrickRED.OBJECT_TYPE_PROCESS = 4
- BrickRED.OBJECT_TYPE_PROGRAM = 5
The returned namedtuple has the variables error_code, item_object_id and type.
-
BrickRED.append_to_list(list_id, item_object_id)
Parameters: |
- list_id -- int
- item_object_id -- int
|
Return type: | int
|
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 constants are available for this function:
- BrickRED.ERROR_CODE_SUCCESS = 0
- BrickRED.ERROR_CODE_UNKNOWN_ERROR = 1
- BrickRED.ERROR_CODE_INVALID_OPERATION = 2
- BrickRED.ERROR_CODE_OPERATION_ABORTED = 3
- BrickRED.ERROR_CODE_INTERNAL_ERROR = 4
- BrickRED.ERROR_CODE_UNKNOWN_SESSION_ID = 5
- BrickRED.ERROR_CODE_NO_FREE_SESSION_ID = 6
- BrickRED.ERROR_CODE_UNKNOWN_OBJECT_ID = 7
- BrickRED.ERROR_CODE_NO_FREE_OBJECT_ID = 8
- BrickRED.ERROR_CODE_OBJECT_IS_LOCKED = 9
- BrickRED.ERROR_CODE_NO_MORE_DATA = 10
- BrickRED.ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
- BrickRED.ERROR_CODE_PROGRAM_IS_PURGED = 12
- BrickRED.ERROR_CODE_INVALID_PARAMETER = 128
- BrickRED.ERROR_CODE_NO_FREE_MEMORY = 129
- BrickRED.ERROR_CODE_NO_FREE_SPACE = 130
- BrickRED.ERROR_CODE_ACCESS_DENIED = 121
- BrickRED.ERROR_CODE_ALREADY_EXISTS = 132
- BrickRED.ERROR_CODE_DOES_NOT_EXIST = 133
- BrickRED.ERROR_CODE_INTERRUPTED = 134
- BrickRED.ERROR_CODE_IS_DIRECTORY = 135
- BrickRED.ERROR_CODE_NOT_A_DIRECTORY = 136
- BrickRED.ERROR_CODE_WOULD_BLOCK = 137
- BrickRED.ERROR_CODE_OVERFLOW = 138
- BrickRED.ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
- BrickRED.ERROR_CODE_OUT_OF_RANGE = 140
- BrickRED.ERROR_CODE_NAME_TOO_LONG = 141
- BrickRED.ERROR_CODE_INVALID_SEEK = 142
- BrickRED.ERROR_CODE_NOT_SUPPORTED = 143
- BrickRED.ERROR_CODE_TOO_MANY_OPEN_FILES = 144
-
BrickRED.remove_from_list(list_id, index)
Parameters: |
- list_id -- int
- index -- int
|
Return type: | int
|
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 constants are available for this function:
- BrickRED.ERROR_CODE_SUCCESS = 0
- BrickRED.ERROR_CODE_UNKNOWN_ERROR = 1
- BrickRED.ERROR_CODE_INVALID_OPERATION = 2
- BrickRED.ERROR_CODE_OPERATION_ABORTED = 3
- BrickRED.ERROR_CODE_INTERNAL_ERROR = 4
- BrickRED.ERROR_CODE_UNKNOWN_SESSION_ID = 5
- BrickRED.ERROR_CODE_NO_FREE_SESSION_ID = 6
- BrickRED.ERROR_CODE_UNKNOWN_OBJECT_ID = 7
- BrickRED.ERROR_CODE_NO_FREE_OBJECT_ID = 8
- BrickRED.ERROR_CODE_OBJECT_IS_LOCKED = 9
- BrickRED.ERROR_CODE_NO_MORE_DATA = 10
- BrickRED.ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
- BrickRED.ERROR_CODE_PROGRAM_IS_PURGED = 12
- BrickRED.ERROR_CODE_INVALID_PARAMETER = 128
- BrickRED.ERROR_CODE_NO_FREE_MEMORY = 129
- BrickRED.ERROR_CODE_NO_FREE_SPACE = 130
- BrickRED.ERROR_CODE_ACCESS_DENIED = 121
- BrickRED.ERROR_CODE_ALREADY_EXISTS = 132
- BrickRED.ERROR_CODE_DOES_NOT_EXIST = 133
- BrickRED.ERROR_CODE_INTERRUPTED = 134
- BrickRED.ERROR_CODE_IS_DIRECTORY = 135
- BrickRED.ERROR_CODE_NOT_A_DIRECTORY = 136
- BrickRED.ERROR_CODE_WOULD_BLOCK = 137
- BrickRED.ERROR_CODE_OVERFLOW = 138
- BrickRED.ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
- BrickRED.ERROR_CODE_OUT_OF_RANGE = 140
- BrickRED.ERROR_CODE_NAME_TOO_LONG = 141
- BrickRED.ERROR_CODE_INVALID_SEEK = 142
- BrickRED.ERROR_CODE_NOT_SUPPORTED = 143
- BrickRED.ERROR_CODE_TOO_MANY_OPEN_FILES = 144
-
BrickRED.open_file(name_string_id, flags, permissions, uid, gid, session_id)
Parameters: |
- name_string_id -- int
- flags -- int
- permissions -- int
- uid -- int
- gid -- int
- session_id -- int
|
Return type: | (int, 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 constants are available for this function:
- BrickRED.FILE_FLAG_READ_ONLY = 1
- BrickRED.FILE_FLAG_WRITE_ONLY = 2
- BrickRED.FILE_FLAG_READ_WRITE = 4
- BrickRED.FILE_FLAG_APPEND = 8
- BrickRED.FILE_FLAG_CREATE = 16
- BrickRED.FILE_FLAG_EXCLUSIVE = 32
- BrickRED.FILE_FLAG_NON_BLOCKING = 64
- BrickRED.FILE_FLAG_TRUNCATE = 128
- BrickRED.FILE_FLAG_TEMPORARY = 256
- BrickRED.FILE_FLAG_REPLACE = 512
- BrickRED.FILE_PERMISSION_USER_ALL = 448
- BrickRED.FILE_PERMISSION_USER_READ = 256
- BrickRED.FILE_PERMISSION_USER_WRITE = 128
- BrickRED.FILE_PERMISSION_USER_EXECUTE = 64
- BrickRED.FILE_PERMISSION_GROUP_ALL = 56
- BrickRED.FILE_PERMISSION_GROUP_READ = 32
- BrickRED.FILE_PERMISSION_GROUP_WRITE = 16
- BrickRED.FILE_PERMISSION_GROUP_EXECUTE = 8
- BrickRED.FILE_PERMISSION_OTHERS_ALL = 7
- BrickRED.FILE_PERMISSION_OTHERS_READ = 4
- BrickRED.FILE_PERMISSION_OTHERS_WRITE = 2
- BrickRED.FILE_PERMISSION_OTHERS_EXECUTE = 1
- BrickRED.ERROR_CODE_SUCCESS = 0
- BrickRED.ERROR_CODE_UNKNOWN_ERROR = 1
- BrickRED.ERROR_CODE_INVALID_OPERATION = 2
- BrickRED.ERROR_CODE_OPERATION_ABORTED = 3
- BrickRED.ERROR_CODE_INTERNAL_ERROR = 4
- BrickRED.ERROR_CODE_UNKNOWN_SESSION_ID = 5
- BrickRED.ERROR_CODE_NO_FREE_SESSION_ID = 6
- BrickRED.ERROR_CODE_UNKNOWN_OBJECT_ID = 7
- BrickRED.ERROR_CODE_NO_FREE_OBJECT_ID = 8
- BrickRED.ERROR_CODE_OBJECT_IS_LOCKED = 9
- BrickRED.ERROR_CODE_NO_MORE_DATA = 10
- BrickRED.ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
- BrickRED.ERROR_CODE_PROGRAM_IS_PURGED = 12
- BrickRED.ERROR_CODE_INVALID_PARAMETER = 128
- BrickRED.ERROR_CODE_NO_FREE_MEMORY = 129
- BrickRED.ERROR_CODE_NO_FREE_SPACE = 130
- BrickRED.ERROR_CODE_ACCESS_DENIED = 121
- BrickRED.ERROR_CODE_ALREADY_EXISTS = 132
- BrickRED.ERROR_CODE_DOES_NOT_EXIST = 133
- BrickRED.ERROR_CODE_INTERRUPTED = 134
- BrickRED.ERROR_CODE_IS_DIRECTORY = 135
- BrickRED.ERROR_CODE_NOT_A_DIRECTORY = 136
- BrickRED.ERROR_CODE_WOULD_BLOCK = 137
- BrickRED.ERROR_CODE_OVERFLOW = 138
- BrickRED.ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
- BrickRED.ERROR_CODE_OUT_OF_RANGE = 140
- BrickRED.ERROR_CODE_NAME_TOO_LONG = 141
- BrickRED.ERROR_CODE_INVALID_SEEK = 142
- BrickRED.ERROR_CODE_NOT_SUPPORTED = 143
- BrickRED.ERROR_CODE_TOO_MANY_OPEN_FILES = 144
The returned namedtuple has the variables error_code and file_id.
-
BrickRED.create_pipe(flags, length, session_id)
Parameters: |
- flags -- int
- length -- int
- session_id -- int
|
Return type: | (int, 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 constants are available for this function:
- BrickRED.PIPE_FLAG_NON_BLOCKING_READ = 1
- BrickRED.PIPE_FLAG_NON_BLOCKING_WRITE = 2
- BrickRED.ERROR_CODE_SUCCESS = 0
- BrickRED.ERROR_CODE_UNKNOWN_ERROR = 1
- BrickRED.ERROR_CODE_INVALID_OPERATION = 2
- BrickRED.ERROR_CODE_OPERATION_ABORTED = 3
- BrickRED.ERROR_CODE_INTERNAL_ERROR = 4
- BrickRED.ERROR_CODE_UNKNOWN_SESSION_ID = 5
- BrickRED.ERROR_CODE_NO_FREE_SESSION_ID = 6
- BrickRED.ERROR_CODE_UNKNOWN_OBJECT_ID = 7
- BrickRED.ERROR_CODE_NO_FREE_OBJECT_ID = 8
- BrickRED.ERROR_CODE_OBJECT_IS_LOCKED = 9
- BrickRED.ERROR_CODE_NO_MORE_DATA = 10
- BrickRED.ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
- BrickRED.ERROR_CODE_PROGRAM_IS_PURGED = 12
- BrickRED.ERROR_CODE_INVALID_PARAMETER = 128
- BrickRED.ERROR_CODE_NO_FREE_MEMORY = 129
- BrickRED.ERROR_CODE_NO_FREE_SPACE = 130
- BrickRED.ERROR_CODE_ACCESS_DENIED = 121
- BrickRED.ERROR_CODE_ALREADY_EXISTS = 132
- BrickRED.ERROR_CODE_DOES_NOT_EXIST = 133
- BrickRED.ERROR_CODE_INTERRUPTED = 134
- BrickRED.ERROR_CODE_IS_DIRECTORY = 135
- BrickRED.ERROR_CODE_NOT_A_DIRECTORY = 136
- BrickRED.ERROR_CODE_WOULD_BLOCK = 137
- BrickRED.ERROR_CODE_OVERFLOW = 138
- BrickRED.ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
- BrickRED.ERROR_CODE_OUT_OF_RANGE = 140
- BrickRED.ERROR_CODE_NAME_TOO_LONG = 141
- BrickRED.ERROR_CODE_INVALID_SEEK = 142
- BrickRED.ERROR_CODE_NOT_SUPPORTED = 143
- BrickRED.ERROR_CODE_TOO_MANY_OPEN_FILES = 144
The returned namedtuple has the variables error_code and file_id.
-
BrickRED.get_file_info(file_id, session_id)
Parameters: |
- file_id -- int
- session_id -- int
|
Return type: | (int, int, int, int, int, int, int, int, int, int, 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 open_file().
The returned flags were used to open or create the file object, as passed to
open_file() or 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 constants are available for this function:
- BrickRED.ERROR_CODE_SUCCESS = 0
- BrickRED.ERROR_CODE_UNKNOWN_ERROR = 1
- BrickRED.ERROR_CODE_INVALID_OPERATION = 2
- BrickRED.ERROR_CODE_OPERATION_ABORTED = 3
- BrickRED.ERROR_CODE_INTERNAL_ERROR = 4
- BrickRED.ERROR_CODE_UNKNOWN_SESSION_ID = 5
- BrickRED.ERROR_CODE_NO_FREE_SESSION_ID = 6
- BrickRED.ERROR_CODE_UNKNOWN_OBJECT_ID = 7
- BrickRED.ERROR_CODE_NO_FREE_OBJECT_ID = 8
- BrickRED.ERROR_CODE_OBJECT_IS_LOCKED = 9
- BrickRED.ERROR_CODE_NO_MORE_DATA = 10
- BrickRED.ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
- BrickRED.ERROR_CODE_PROGRAM_IS_PURGED = 12
- BrickRED.ERROR_CODE_INVALID_PARAMETER = 128
- BrickRED.ERROR_CODE_NO_FREE_MEMORY = 129
- BrickRED.ERROR_CODE_NO_FREE_SPACE = 130
- BrickRED.ERROR_CODE_ACCESS_DENIED = 121
- BrickRED.ERROR_CODE_ALREADY_EXISTS = 132
- BrickRED.ERROR_CODE_DOES_NOT_EXIST = 133
- BrickRED.ERROR_CODE_INTERRUPTED = 134
- BrickRED.ERROR_CODE_IS_DIRECTORY = 135
- BrickRED.ERROR_CODE_NOT_A_DIRECTORY = 136
- BrickRED.ERROR_CODE_WOULD_BLOCK = 137
- BrickRED.ERROR_CODE_OVERFLOW = 138
- BrickRED.ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
- BrickRED.ERROR_CODE_OUT_OF_RANGE = 140
- BrickRED.ERROR_CODE_NAME_TOO_LONG = 141
- BrickRED.ERROR_CODE_INVALID_SEEK = 142
- BrickRED.ERROR_CODE_NOT_SUPPORTED = 143
- BrickRED.ERROR_CODE_TOO_MANY_OPEN_FILES = 144
- BrickRED.FILE_TYPE_UNKNOWN = 0
- BrickRED.FILE_TYPE_REGULAR = 1
- BrickRED.FILE_TYPE_DIRECTORY = 2
- BrickRED.FILE_TYPE_CHARACTER = 3
- BrickRED.FILE_TYPE_BLOCK = 4
- BrickRED.FILE_TYPE_FIFO = 5
- BrickRED.FILE_TYPE_SYMLINK = 6
- BrickRED.FILE_TYPE_SOCKET = 7
- BrickRED.FILE_TYPE_PIPE = 8
- BrickRED.FILE_PERMISSION_USER_ALL = 448
- BrickRED.FILE_PERMISSION_USER_READ = 256
- BrickRED.FILE_PERMISSION_USER_WRITE = 128
- BrickRED.FILE_PERMISSION_USER_EXECUTE = 64
- BrickRED.FILE_PERMISSION_GROUP_ALL = 56
- BrickRED.FILE_PERMISSION_GROUP_READ = 32
- BrickRED.FILE_PERMISSION_GROUP_WRITE = 16
- BrickRED.FILE_PERMISSION_GROUP_EXECUTE = 8
- BrickRED.FILE_PERMISSION_OTHERS_ALL = 7
- BrickRED.FILE_PERMISSION_OTHERS_READ = 4
- BrickRED.FILE_PERMISSION_OTHERS_WRITE = 2
- BrickRED.FILE_PERMISSION_OTHERS_EXECUTE = 1
The returned namedtuple has the variables error_code, type, name_string_id, flags, permissions, uid, gid, length, access_timestamp, modification_timestamp and status_change_timestamp.
-
BrickRED.read_file(file_id, length_to_read)
Parameters: |
- file_id -- int
- length_to_read -- int
|
Return type: | (int, [int, int, ..59x.., int], 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 open_file() without the NonBlocking
flag or by create_pipe() without the NonBlockingRead flag then the
error code NotSupported is returned.
The following constants are available for this function:
- BrickRED.ERROR_CODE_SUCCESS = 0
- BrickRED.ERROR_CODE_UNKNOWN_ERROR = 1
- BrickRED.ERROR_CODE_INVALID_OPERATION = 2
- BrickRED.ERROR_CODE_OPERATION_ABORTED = 3
- BrickRED.ERROR_CODE_INTERNAL_ERROR = 4
- BrickRED.ERROR_CODE_UNKNOWN_SESSION_ID = 5
- BrickRED.ERROR_CODE_NO_FREE_SESSION_ID = 6
- BrickRED.ERROR_CODE_UNKNOWN_OBJECT_ID = 7
- BrickRED.ERROR_CODE_NO_FREE_OBJECT_ID = 8
- BrickRED.ERROR_CODE_OBJECT_IS_LOCKED = 9
- BrickRED.ERROR_CODE_NO_MORE_DATA = 10
- BrickRED.ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
- BrickRED.ERROR_CODE_PROGRAM_IS_PURGED = 12
- BrickRED.ERROR_CODE_INVALID_PARAMETER = 128
- BrickRED.ERROR_CODE_NO_FREE_MEMORY = 129
- BrickRED.ERROR_CODE_NO_FREE_SPACE = 130
- BrickRED.ERROR_CODE_ACCESS_DENIED = 121
- BrickRED.ERROR_CODE_ALREADY_EXISTS = 132
- BrickRED.ERROR_CODE_DOES_NOT_EXIST = 133
- BrickRED.ERROR_CODE_INTERRUPTED = 134
- BrickRED.ERROR_CODE_IS_DIRECTORY = 135
- BrickRED.ERROR_CODE_NOT_A_DIRECTORY = 136
- BrickRED.ERROR_CODE_WOULD_BLOCK = 137
- BrickRED.ERROR_CODE_OVERFLOW = 138
- BrickRED.ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
- BrickRED.ERROR_CODE_OUT_OF_RANGE = 140
- BrickRED.ERROR_CODE_NAME_TOO_LONG = 141
- BrickRED.ERROR_CODE_INVALID_SEEK = 142
- BrickRED.ERROR_CODE_NOT_SUPPORTED = 143
- BrickRED.ERROR_CODE_TOO_MANY_OPEN_FILES = 144
The returned namedtuple has the variables error_code, buffer and length_read.
-
BrickRED.read_file_async(file_id, length_to_read)
Parameters: |
- file_id -- int
- length_to_read -- int
|
Return type: | None
|
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 CALLBACK_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 open_file() without the NonBlocking
flag or by create_pipe() without the NonBlockingRead flag then the error
code NotSupported is reported via the CALLBACK_ASYNC_FILE_READ callback.
-
BrickRED.abort_async_file_read(file_id)
Parameters: | file_id -- int |
Return type: | int |
Aborts a read_file_async() operation in progress.
Returns the resulting error code.
On success the CALLBACK_ASYNC_FILE_READ callback will report OperationAborted.
The following constants are available for this function:
- BrickRED.ERROR_CODE_SUCCESS = 0
- BrickRED.ERROR_CODE_UNKNOWN_ERROR = 1
- BrickRED.ERROR_CODE_INVALID_OPERATION = 2
- BrickRED.ERROR_CODE_OPERATION_ABORTED = 3
- BrickRED.ERROR_CODE_INTERNAL_ERROR = 4
- BrickRED.ERROR_CODE_UNKNOWN_SESSION_ID = 5
- BrickRED.ERROR_CODE_NO_FREE_SESSION_ID = 6
- BrickRED.ERROR_CODE_UNKNOWN_OBJECT_ID = 7
- BrickRED.ERROR_CODE_NO_FREE_OBJECT_ID = 8
- BrickRED.ERROR_CODE_OBJECT_IS_LOCKED = 9
- BrickRED.ERROR_CODE_NO_MORE_DATA = 10
- BrickRED.ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
- BrickRED.ERROR_CODE_PROGRAM_IS_PURGED = 12
- BrickRED.ERROR_CODE_INVALID_PARAMETER = 128
- BrickRED.ERROR_CODE_NO_FREE_MEMORY = 129
- BrickRED.ERROR_CODE_NO_FREE_SPACE = 130
- BrickRED.ERROR_CODE_ACCESS_DENIED = 121
- BrickRED.ERROR_CODE_ALREADY_EXISTS = 132
- BrickRED.ERROR_CODE_DOES_NOT_EXIST = 133
- BrickRED.ERROR_CODE_INTERRUPTED = 134
- BrickRED.ERROR_CODE_IS_DIRECTORY = 135
- BrickRED.ERROR_CODE_NOT_A_DIRECTORY = 136
- BrickRED.ERROR_CODE_WOULD_BLOCK = 137
- BrickRED.ERROR_CODE_OVERFLOW = 138
- BrickRED.ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
- BrickRED.ERROR_CODE_OUT_OF_RANGE = 140
- BrickRED.ERROR_CODE_NAME_TOO_LONG = 141
- BrickRED.ERROR_CODE_INVALID_SEEK = 142
- BrickRED.ERROR_CODE_NOT_SUPPORTED = 143
- BrickRED.ERROR_CODE_TOO_MANY_OPEN_FILES = 144
-
BrickRED.write_file(file_id, buffer, length_to_write)
Parameters: |
- file_id -- int
- buffer -- [int, int, ..58x.., int]
- length_to_write -- int
|
Return type: | (int, 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 open_file() without the NonBlocking
flag or by create_pipe() without the NonBlockingWrite flag then the
error code NotSupported is returned.
The following constants are available for this function:
- BrickRED.ERROR_CODE_SUCCESS = 0
- BrickRED.ERROR_CODE_UNKNOWN_ERROR = 1
- BrickRED.ERROR_CODE_INVALID_OPERATION = 2
- BrickRED.ERROR_CODE_OPERATION_ABORTED = 3
- BrickRED.ERROR_CODE_INTERNAL_ERROR = 4
- BrickRED.ERROR_CODE_UNKNOWN_SESSION_ID = 5
- BrickRED.ERROR_CODE_NO_FREE_SESSION_ID = 6
- BrickRED.ERROR_CODE_UNKNOWN_OBJECT_ID = 7
- BrickRED.ERROR_CODE_NO_FREE_OBJECT_ID = 8
- BrickRED.ERROR_CODE_OBJECT_IS_LOCKED = 9
- BrickRED.ERROR_CODE_NO_MORE_DATA = 10
- BrickRED.ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
- BrickRED.ERROR_CODE_PROGRAM_IS_PURGED = 12
- BrickRED.ERROR_CODE_INVALID_PARAMETER = 128
- BrickRED.ERROR_CODE_NO_FREE_MEMORY = 129
- BrickRED.ERROR_CODE_NO_FREE_SPACE = 130
- BrickRED.ERROR_CODE_ACCESS_DENIED = 121
- BrickRED.ERROR_CODE_ALREADY_EXISTS = 132
- BrickRED.ERROR_CODE_DOES_NOT_EXIST = 133
- BrickRED.ERROR_CODE_INTERRUPTED = 134
- BrickRED.ERROR_CODE_IS_DIRECTORY = 135
- BrickRED.ERROR_CODE_NOT_A_DIRECTORY = 136
- BrickRED.ERROR_CODE_WOULD_BLOCK = 137
- BrickRED.ERROR_CODE_OVERFLOW = 138
- BrickRED.ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
- BrickRED.ERROR_CODE_OUT_OF_RANGE = 140
- BrickRED.ERROR_CODE_NAME_TOO_LONG = 141
- BrickRED.ERROR_CODE_INVALID_SEEK = 142
- BrickRED.ERROR_CODE_NOT_SUPPORTED = 143
- BrickRED.ERROR_CODE_TOO_MANY_OPEN_FILES = 144
The returned namedtuple has the variables error_code and length_written.
-
BrickRED.write_file_unchecked(file_id, buffer, length_to_write)
Parameters: |
- file_id -- int
- buffer -- [int, int, ..58x.., int]
- length_to_write -- int
|
Return type: | None
|
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 open_file() without the NonBlocking
flag or by create_pipe() without the NonBlockingWrite flag then the
write operation will fail silently.
-
BrickRED.write_file_async(file_id, buffer, length_to_write)
Parameters: |
- file_id -- int
- buffer -- [int, int, ..58x.., int]
- length_to_write -- int
|
Return type: | None
|
Writes up to 61 bytes to a file object.
Reports the actual number of bytes written and the resulting error code via the
CALLBACK_ASYNC_FILE_WRITE callback.
If the file object was created by open_file() without the NonBlocking
flag or by create_pipe() without the NonBlockingWrite flag then the
error code NotSupported is reported via the CALLBACK_ASYNC_FILE_WRITE callback.
-
BrickRED.set_file_position(file_id, offset, origin)
Parameters: |
- file_id -- int
- offset -- int
- origin -- int
|
Return type: | (int, 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 create_pipe() then it has no seek
position and the error code InvalidSeek is returned.
The following constants are available for this function:
- BrickRED.FILE_ORIGIN_BEGINNING = 0
- BrickRED.FILE_ORIGIN_CURRENT = 1
- BrickRED.FILE_ORIGIN_END = 2
- BrickRED.ERROR_CODE_SUCCESS = 0
- BrickRED.ERROR_CODE_UNKNOWN_ERROR = 1
- BrickRED.ERROR_CODE_INVALID_OPERATION = 2
- BrickRED.ERROR_CODE_OPERATION_ABORTED = 3
- BrickRED.ERROR_CODE_INTERNAL_ERROR = 4
- BrickRED.ERROR_CODE_UNKNOWN_SESSION_ID = 5
- BrickRED.ERROR_CODE_NO_FREE_SESSION_ID = 6
- BrickRED.ERROR_CODE_UNKNOWN_OBJECT_ID = 7
- BrickRED.ERROR_CODE_NO_FREE_OBJECT_ID = 8
- BrickRED.ERROR_CODE_OBJECT_IS_LOCKED = 9
- BrickRED.ERROR_CODE_NO_MORE_DATA = 10
- BrickRED.ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
- BrickRED.ERROR_CODE_PROGRAM_IS_PURGED = 12
- BrickRED.ERROR_CODE_INVALID_PARAMETER = 128
- BrickRED.ERROR_CODE_NO_FREE_MEMORY = 129
- BrickRED.ERROR_CODE_NO_FREE_SPACE = 130
- BrickRED.ERROR_CODE_ACCESS_DENIED = 121
- BrickRED.ERROR_CODE_ALREADY_EXISTS = 132
- BrickRED.ERROR_CODE_DOES_NOT_EXIST = 133
- BrickRED.ERROR_CODE_INTERRUPTED = 134
- BrickRED.ERROR_CODE_IS_DIRECTORY = 135
- BrickRED.ERROR_CODE_NOT_A_DIRECTORY = 136
- BrickRED.ERROR_CODE_WOULD_BLOCK = 137
- BrickRED.ERROR_CODE_OVERFLOW = 138
- BrickRED.ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
- BrickRED.ERROR_CODE_OUT_OF_RANGE = 140
- BrickRED.ERROR_CODE_NAME_TOO_LONG = 141
- BrickRED.ERROR_CODE_INVALID_SEEK = 142
- BrickRED.ERROR_CODE_NOT_SUPPORTED = 143
- BrickRED.ERROR_CODE_TOO_MANY_OPEN_FILES = 144
The returned namedtuple has the variables error_code and position.
-
BrickRED.get_file_position(file_id)
Parameters: | file_id -- int |
Return type: | (int, 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 create_pipe() then it has no seek
position and the error code InvalidSeek is returned.
The following constants are available for this function:
- BrickRED.ERROR_CODE_SUCCESS = 0
- BrickRED.ERROR_CODE_UNKNOWN_ERROR = 1
- BrickRED.ERROR_CODE_INVALID_OPERATION = 2
- BrickRED.ERROR_CODE_OPERATION_ABORTED = 3
- BrickRED.ERROR_CODE_INTERNAL_ERROR = 4
- BrickRED.ERROR_CODE_UNKNOWN_SESSION_ID = 5
- BrickRED.ERROR_CODE_NO_FREE_SESSION_ID = 6
- BrickRED.ERROR_CODE_UNKNOWN_OBJECT_ID = 7
- BrickRED.ERROR_CODE_NO_FREE_OBJECT_ID = 8
- BrickRED.ERROR_CODE_OBJECT_IS_LOCKED = 9
- BrickRED.ERROR_CODE_NO_MORE_DATA = 10
- BrickRED.ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
- BrickRED.ERROR_CODE_PROGRAM_IS_PURGED = 12
- BrickRED.ERROR_CODE_INVALID_PARAMETER = 128
- BrickRED.ERROR_CODE_NO_FREE_MEMORY = 129
- BrickRED.ERROR_CODE_NO_FREE_SPACE = 130
- BrickRED.ERROR_CODE_ACCESS_DENIED = 121
- BrickRED.ERROR_CODE_ALREADY_EXISTS = 132
- BrickRED.ERROR_CODE_DOES_NOT_EXIST = 133
- BrickRED.ERROR_CODE_INTERRUPTED = 134
- BrickRED.ERROR_CODE_IS_DIRECTORY = 135
- BrickRED.ERROR_CODE_NOT_A_DIRECTORY = 136
- BrickRED.ERROR_CODE_WOULD_BLOCK = 137
- BrickRED.ERROR_CODE_OVERFLOW = 138
- BrickRED.ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
- BrickRED.ERROR_CODE_OUT_OF_RANGE = 140
- BrickRED.ERROR_CODE_NAME_TOO_LONG = 141
- BrickRED.ERROR_CODE_INVALID_SEEK = 142
- BrickRED.ERROR_CODE_NOT_SUPPORTED = 143
- BrickRED.ERROR_CODE_TOO_MANY_OPEN_FILES = 144
The returned namedtuple has the variables error_code and position.
-
BrickRED.set_file_events(file_id, events)
Parameters: |
- file_id -- int
- events -- int
|
Return type: | int
|
The following constants are available for this function:
- BrickRED.FILE_EVENT_READABLE = 1
- BrickRED.FILE_EVENT_WRITABLE = 2
- BrickRED.ERROR_CODE_SUCCESS = 0
- BrickRED.ERROR_CODE_UNKNOWN_ERROR = 1
- BrickRED.ERROR_CODE_INVALID_OPERATION = 2
- BrickRED.ERROR_CODE_OPERATION_ABORTED = 3
- BrickRED.ERROR_CODE_INTERNAL_ERROR = 4
- BrickRED.ERROR_CODE_UNKNOWN_SESSION_ID = 5
- BrickRED.ERROR_CODE_NO_FREE_SESSION_ID = 6
- BrickRED.ERROR_CODE_UNKNOWN_OBJECT_ID = 7
- BrickRED.ERROR_CODE_NO_FREE_OBJECT_ID = 8
- BrickRED.ERROR_CODE_OBJECT_IS_LOCKED = 9
- BrickRED.ERROR_CODE_NO_MORE_DATA = 10
- BrickRED.ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
- BrickRED.ERROR_CODE_PROGRAM_IS_PURGED = 12
- BrickRED.ERROR_CODE_INVALID_PARAMETER = 128
- BrickRED.ERROR_CODE_NO_FREE_MEMORY = 129
- BrickRED.ERROR_CODE_NO_FREE_SPACE = 130
- BrickRED.ERROR_CODE_ACCESS_DENIED = 121
- BrickRED.ERROR_CODE_ALREADY_EXISTS = 132
- BrickRED.ERROR_CODE_DOES_NOT_EXIST = 133
- BrickRED.ERROR_CODE_INTERRUPTED = 134
- BrickRED.ERROR_CODE_IS_DIRECTORY = 135
- BrickRED.ERROR_CODE_NOT_A_DIRECTORY = 136
- BrickRED.ERROR_CODE_WOULD_BLOCK = 137
- BrickRED.ERROR_CODE_OVERFLOW = 138
- BrickRED.ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
- BrickRED.ERROR_CODE_OUT_OF_RANGE = 140
- BrickRED.ERROR_CODE_NAME_TOO_LONG = 141
- BrickRED.ERROR_CODE_INVALID_SEEK = 142
- BrickRED.ERROR_CODE_NOT_SUPPORTED = 143
- BrickRED.ERROR_CODE_TOO_MANY_OPEN_FILES = 144
-
BrickRED.get_file_events(file_id)
Parameters: | file_id -- int |
Return type: | (int, int) |
The following constants are available for this function:
- BrickRED.ERROR_CODE_SUCCESS = 0
- BrickRED.ERROR_CODE_UNKNOWN_ERROR = 1
- BrickRED.ERROR_CODE_INVALID_OPERATION = 2
- BrickRED.ERROR_CODE_OPERATION_ABORTED = 3
- BrickRED.ERROR_CODE_INTERNAL_ERROR = 4
- BrickRED.ERROR_CODE_UNKNOWN_SESSION_ID = 5
- BrickRED.ERROR_CODE_NO_FREE_SESSION_ID = 6
- BrickRED.ERROR_CODE_UNKNOWN_OBJECT_ID = 7
- BrickRED.ERROR_CODE_NO_FREE_OBJECT_ID = 8
- BrickRED.ERROR_CODE_OBJECT_IS_LOCKED = 9
- BrickRED.ERROR_CODE_NO_MORE_DATA = 10
- BrickRED.ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
- BrickRED.ERROR_CODE_PROGRAM_IS_PURGED = 12
- BrickRED.ERROR_CODE_INVALID_PARAMETER = 128
- BrickRED.ERROR_CODE_NO_FREE_MEMORY = 129
- BrickRED.ERROR_CODE_NO_FREE_SPACE = 130
- BrickRED.ERROR_CODE_ACCESS_DENIED = 121
- BrickRED.ERROR_CODE_ALREADY_EXISTS = 132
- BrickRED.ERROR_CODE_DOES_NOT_EXIST = 133
- BrickRED.ERROR_CODE_INTERRUPTED = 134
- BrickRED.ERROR_CODE_IS_DIRECTORY = 135
- BrickRED.ERROR_CODE_NOT_A_DIRECTORY = 136
- BrickRED.ERROR_CODE_WOULD_BLOCK = 137
- BrickRED.ERROR_CODE_OVERFLOW = 138
- BrickRED.ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
- BrickRED.ERROR_CODE_OUT_OF_RANGE = 140
- BrickRED.ERROR_CODE_NAME_TOO_LONG = 141
- BrickRED.ERROR_CODE_INVALID_SEEK = 142
- BrickRED.ERROR_CODE_NOT_SUPPORTED = 143
- BrickRED.ERROR_CODE_TOO_MANY_OPEN_FILES = 144
- BrickRED.FILE_EVENT_READABLE = 1
- BrickRED.FILE_EVENT_WRITABLE = 2
The returned namedtuple has the variables error_code and events.
-
BrickRED.open_directory(name_string_id, session_id)
Parameters: |
- name_string_id -- int
- session_id -- int
|
Return type: | (int, 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 constants are available for this function:
- BrickRED.ERROR_CODE_SUCCESS = 0
- BrickRED.ERROR_CODE_UNKNOWN_ERROR = 1
- BrickRED.ERROR_CODE_INVALID_OPERATION = 2
- BrickRED.ERROR_CODE_OPERATION_ABORTED = 3
- BrickRED.ERROR_CODE_INTERNAL_ERROR = 4
- BrickRED.ERROR_CODE_UNKNOWN_SESSION_ID = 5
- BrickRED.ERROR_CODE_NO_FREE_SESSION_ID = 6
- BrickRED.ERROR_CODE_UNKNOWN_OBJECT_ID = 7
- BrickRED.ERROR_CODE_NO_FREE_OBJECT_ID = 8
- BrickRED.ERROR_CODE_OBJECT_IS_LOCKED = 9
- BrickRED.ERROR_CODE_NO_MORE_DATA = 10
- BrickRED.ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
- BrickRED.ERROR_CODE_PROGRAM_IS_PURGED = 12
- BrickRED.ERROR_CODE_INVALID_PARAMETER = 128
- BrickRED.ERROR_CODE_NO_FREE_MEMORY = 129
- BrickRED.ERROR_CODE_NO_FREE_SPACE = 130
- BrickRED.ERROR_CODE_ACCESS_DENIED = 121
- BrickRED.ERROR_CODE_ALREADY_EXISTS = 132
- BrickRED.ERROR_CODE_DOES_NOT_EXIST = 133
- BrickRED.ERROR_CODE_INTERRUPTED = 134
- BrickRED.ERROR_CODE_IS_DIRECTORY = 135
- BrickRED.ERROR_CODE_NOT_A_DIRECTORY = 136
- BrickRED.ERROR_CODE_WOULD_BLOCK = 137
- BrickRED.ERROR_CODE_OVERFLOW = 138
- BrickRED.ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
- BrickRED.ERROR_CODE_OUT_OF_RANGE = 140
- BrickRED.ERROR_CODE_NAME_TOO_LONG = 141
- BrickRED.ERROR_CODE_INVALID_SEEK = 142
- BrickRED.ERROR_CODE_NOT_SUPPORTED = 143
- BrickRED.ERROR_CODE_TOO_MANY_OPEN_FILES = 144
The returned namedtuple has the variables error_code and directory_id.
-
BrickRED.get_directory_name(directory_id, session_id)
Parameters: |
- directory_id -- int
- session_id -- int
|
Return type: | (int, int)
|
Returns the name of a directory object, as passed to open_directory(), and
the resulting error code.
The following constants are available for this function:
- BrickRED.ERROR_CODE_SUCCESS = 0
- BrickRED.ERROR_CODE_UNKNOWN_ERROR = 1
- BrickRED.ERROR_CODE_INVALID_OPERATION = 2
- BrickRED.ERROR_CODE_OPERATION_ABORTED = 3
- BrickRED.ERROR_CODE_INTERNAL_ERROR = 4
- BrickRED.ERROR_CODE_UNKNOWN_SESSION_ID = 5
- BrickRED.ERROR_CODE_NO_FREE_SESSION_ID = 6
- BrickRED.ERROR_CODE_UNKNOWN_OBJECT_ID = 7
- BrickRED.ERROR_CODE_NO_FREE_OBJECT_ID = 8
- BrickRED.ERROR_CODE_OBJECT_IS_LOCKED = 9
- BrickRED.ERROR_CODE_NO_MORE_DATA = 10
- BrickRED.ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
- BrickRED.ERROR_CODE_PROGRAM_IS_PURGED = 12
- BrickRED.ERROR_CODE_INVALID_PARAMETER = 128
- BrickRED.ERROR_CODE_NO_FREE_MEMORY = 129
- BrickRED.ERROR_CODE_NO_FREE_SPACE = 130
- BrickRED.ERROR_CODE_ACCESS_DENIED = 121
- BrickRED.ERROR_CODE_ALREADY_EXISTS = 132
- BrickRED.ERROR_CODE_DOES_NOT_EXIST = 133
- BrickRED.ERROR_CODE_INTERRUPTED = 134
- BrickRED.ERROR_CODE_IS_DIRECTORY = 135
- BrickRED.ERROR_CODE_NOT_A_DIRECTORY = 136
- BrickRED.ERROR_CODE_WOULD_BLOCK = 137
- BrickRED.ERROR_CODE_OVERFLOW = 138
- BrickRED.ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
- BrickRED.ERROR_CODE_OUT_OF_RANGE = 140
- BrickRED.ERROR_CODE_NAME_TOO_LONG = 141
- BrickRED.ERROR_CODE_INVALID_SEEK = 142
- BrickRED.ERROR_CODE_NOT_SUPPORTED = 143
- BrickRED.ERROR_CODE_TOO_MANY_OPEN_FILES = 144
The returned namedtuple has the variables error_code and name_string_id.
-
BrickRED.get_next_directory_entry(directory_id, session_id)
Parameters: |
- directory_id -- int
- session_id -- int
|
Return type: | (int, int, int)
|
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 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 constants are available for this function:
- BrickRED.ERROR_CODE_SUCCESS = 0
- BrickRED.ERROR_CODE_UNKNOWN_ERROR = 1
- BrickRED.ERROR_CODE_INVALID_OPERATION = 2
- BrickRED.ERROR_CODE_OPERATION_ABORTED = 3
- BrickRED.ERROR_CODE_INTERNAL_ERROR = 4
- BrickRED.ERROR_CODE_UNKNOWN_SESSION_ID = 5
- BrickRED.ERROR_CODE_NO_FREE_SESSION_ID = 6
- BrickRED.ERROR_CODE_UNKNOWN_OBJECT_ID = 7
- BrickRED.ERROR_CODE_NO_FREE_OBJECT_ID = 8
- BrickRED.ERROR_CODE_OBJECT_IS_LOCKED = 9
- BrickRED.ERROR_CODE_NO_MORE_DATA = 10
- BrickRED.ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
- BrickRED.ERROR_CODE_PROGRAM_IS_PURGED = 12
- BrickRED.ERROR_CODE_INVALID_PARAMETER = 128
- BrickRED.ERROR_CODE_NO_FREE_MEMORY = 129
- BrickRED.ERROR_CODE_NO_FREE_SPACE = 130
- BrickRED.ERROR_CODE_ACCESS_DENIED = 121
- BrickRED.ERROR_CODE_ALREADY_EXISTS = 132
- BrickRED.ERROR_CODE_DOES_NOT_EXIST = 133
- BrickRED.ERROR_CODE_INTERRUPTED = 134
- BrickRED.ERROR_CODE_IS_DIRECTORY = 135
- BrickRED.ERROR_CODE_NOT_A_DIRECTORY = 136
- BrickRED.ERROR_CODE_WOULD_BLOCK = 137
- BrickRED.ERROR_CODE_OVERFLOW = 138
- BrickRED.ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
- BrickRED.ERROR_CODE_OUT_OF_RANGE = 140
- BrickRED.ERROR_CODE_NAME_TOO_LONG = 141
- BrickRED.ERROR_CODE_INVALID_SEEK = 142
- BrickRED.ERROR_CODE_NOT_SUPPORTED = 143
- BrickRED.ERROR_CODE_TOO_MANY_OPEN_FILES = 144
- BrickRED.DIRECTORY_ENTRY_TYPE_UNKNOWN = 0
- BrickRED.DIRECTORY_ENTRY_TYPE_REGULAR = 1
- BrickRED.DIRECTORY_ENTRY_TYPE_DIRECTORY = 2
- BrickRED.DIRECTORY_ENTRY_TYPE_CHARACTER = 3
- BrickRED.DIRECTORY_ENTRY_TYPE_BLOCK = 4
- BrickRED.DIRECTORY_ENTRY_TYPE_FIFO = 5
- BrickRED.DIRECTORY_ENTRY_TYPE_SYMLINK = 6
- BrickRED.DIRECTORY_ENTRY_TYPE_SOCKET = 7
The returned namedtuple has the variables error_code, name_string_id and type.
-
BrickRED.rewind_directory(directory_id)
Parameters: | directory_id -- int |
Return type: | int |
Rewinds a directory object and returns the resulting error code.
The following constants are available for this function:
- BrickRED.ERROR_CODE_SUCCESS = 0
- BrickRED.ERROR_CODE_UNKNOWN_ERROR = 1
- BrickRED.ERROR_CODE_INVALID_OPERATION = 2
- BrickRED.ERROR_CODE_OPERATION_ABORTED = 3
- BrickRED.ERROR_CODE_INTERNAL_ERROR = 4
- BrickRED.ERROR_CODE_UNKNOWN_SESSION_ID = 5
- BrickRED.ERROR_CODE_NO_FREE_SESSION_ID = 6
- BrickRED.ERROR_CODE_UNKNOWN_OBJECT_ID = 7
- BrickRED.ERROR_CODE_NO_FREE_OBJECT_ID = 8
- BrickRED.ERROR_CODE_OBJECT_IS_LOCKED = 9
- BrickRED.ERROR_CODE_NO_MORE_DATA = 10
- BrickRED.ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
- BrickRED.ERROR_CODE_PROGRAM_IS_PURGED = 12
- BrickRED.ERROR_CODE_INVALID_PARAMETER = 128
- BrickRED.ERROR_CODE_NO_FREE_MEMORY = 129
- BrickRED.ERROR_CODE_NO_FREE_SPACE = 130
- BrickRED.ERROR_CODE_ACCESS_DENIED = 121
- BrickRED.ERROR_CODE_ALREADY_EXISTS = 132
- BrickRED.ERROR_CODE_DOES_NOT_EXIST = 133
- BrickRED.ERROR_CODE_INTERRUPTED = 134
- BrickRED.ERROR_CODE_IS_DIRECTORY = 135
- BrickRED.ERROR_CODE_NOT_A_DIRECTORY = 136
- BrickRED.ERROR_CODE_WOULD_BLOCK = 137
- BrickRED.ERROR_CODE_OVERFLOW = 138
- BrickRED.ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
- BrickRED.ERROR_CODE_OUT_OF_RANGE = 140
- BrickRED.ERROR_CODE_NAME_TOO_LONG = 141
- BrickRED.ERROR_CODE_INVALID_SEEK = 142
- BrickRED.ERROR_CODE_NOT_SUPPORTED = 143
- BrickRED.ERROR_CODE_TOO_MANY_OPEN_FILES = 144
-
BrickRED.create_directory(name_string_id, flags, permissions, uid, gid)
Parameters: |
- name_string_id -- int
- flags -- int
- permissions -- int
- uid -- int
- gid -- int
|
Return type: | int
|
FIXME: name has to be absolute
The following constants are available for this function:
- BrickRED.DIRECTORY_FLAG_RECURSIVE = 1
- BrickRED.DIRECTORY_FLAG_EXCLUSIVE = 2
- BrickRED.FILE_PERMISSION_USER_ALL = 448
- BrickRED.FILE_PERMISSION_USER_READ = 256
- BrickRED.FILE_PERMISSION_USER_WRITE = 128
- BrickRED.FILE_PERMISSION_USER_EXECUTE = 64
- BrickRED.FILE_PERMISSION_GROUP_ALL = 56
- BrickRED.FILE_PERMISSION_GROUP_READ = 32
- BrickRED.FILE_PERMISSION_GROUP_WRITE = 16
- BrickRED.FILE_PERMISSION_GROUP_EXECUTE = 8
- BrickRED.FILE_PERMISSION_OTHERS_ALL = 7
- BrickRED.FILE_PERMISSION_OTHERS_READ = 4
- BrickRED.FILE_PERMISSION_OTHERS_WRITE = 2
- BrickRED.FILE_PERMISSION_OTHERS_EXECUTE = 1
- BrickRED.ERROR_CODE_SUCCESS = 0
- BrickRED.ERROR_CODE_UNKNOWN_ERROR = 1
- BrickRED.ERROR_CODE_INVALID_OPERATION = 2
- BrickRED.ERROR_CODE_OPERATION_ABORTED = 3
- BrickRED.ERROR_CODE_INTERNAL_ERROR = 4
- BrickRED.ERROR_CODE_UNKNOWN_SESSION_ID = 5
- BrickRED.ERROR_CODE_NO_FREE_SESSION_ID = 6
- BrickRED.ERROR_CODE_UNKNOWN_OBJECT_ID = 7
- BrickRED.ERROR_CODE_NO_FREE_OBJECT_ID = 8
- BrickRED.ERROR_CODE_OBJECT_IS_LOCKED = 9
- BrickRED.ERROR_CODE_NO_MORE_DATA = 10
- BrickRED.ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
- BrickRED.ERROR_CODE_PROGRAM_IS_PURGED = 12
- BrickRED.ERROR_CODE_INVALID_PARAMETER = 128
- BrickRED.ERROR_CODE_NO_FREE_MEMORY = 129
- BrickRED.ERROR_CODE_NO_FREE_SPACE = 130
- BrickRED.ERROR_CODE_ACCESS_DENIED = 121
- BrickRED.ERROR_CODE_ALREADY_EXISTS = 132
- BrickRED.ERROR_CODE_DOES_NOT_EXIST = 133
- BrickRED.ERROR_CODE_INTERRUPTED = 134
- BrickRED.ERROR_CODE_IS_DIRECTORY = 135
- BrickRED.ERROR_CODE_NOT_A_DIRECTORY = 136
- BrickRED.ERROR_CODE_WOULD_BLOCK = 137
- BrickRED.ERROR_CODE_OVERFLOW = 138
- BrickRED.ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
- BrickRED.ERROR_CODE_OUT_OF_RANGE = 140
- BrickRED.ERROR_CODE_NAME_TOO_LONG = 141
- BrickRED.ERROR_CODE_INVALID_SEEK = 142
- BrickRED.ERROR_CODE_NOT_SUPPORTED = 143
- BrickRED.ERROR_CODE_TOO_MANY_OPEN_FILES = 144
-
BrickRED.get_processes(session_id)
Parameters: | session_id -- int |
Return type: | (int, int) |
The following constants are available for this function:
- BrickRED.ERROR_CODE_SUCCESS = 0
- BrickRED.ERROR_CODE_UNKNOWN_ERROR = 1
- BrickRED.ERROR_CODE_INVALID_OPERATION = 2
- BrickRED.ERROR_CODE_OPERATION_ABORTED = 3
- BrickRED.ERROR_CODE_INTERNAL_ERROR = 4
- BrickRED.ERROR_CODE_UNKNOWN_SESSION_ID = 5
- BrickRED.ERROR_CODE_NO_FREE_SESSION_ID = 6
- BrickRED.ERROR_CODE_UNKNOWN_OBJECT_ID = 7
- BrickRED.ERROR_CODE_NO_FREE_OBJECT_ID = 8
- BrickRED.ERROR_CODE_OBJECT_IS_LOCKED = 9
- BrickRED.ERROR_CODE_NO_MORE_DATA = 10
- BrickRED.ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
- BrickRED.ERROR_CODE_PROGRAM_IS_PURGED = 12
- BrickRED.ERROR_CODE_INVALID_PARAMETER = 128
- BrickRED.ERROR_CODE_NO_FREE_MEMORY = 129
- BrickRED.ERROR_CODE_NO_FREE_SPACE = 130
- BrickRED.ERROR_CODE_ACCESS_DENIED = 121
- BrickRED.ERROR_CODE_ALREADY_EXISTS = 132
- BrickRED.ERROR_CODE_DOES_NOT_EXIST = 133
- BrickRED.ERROR_CODE_INTERRUPTED = 134
- BrickRED.ERROR_CODE_IS_DIRECTORY = 135
- BrickRED.ERROR_CODE_NOT_A_DIRECTORY = 136
- BrickRED.ERROR_CODE_WOULD_BLOCK = 137
- BrickRED.ERROR_CODE_OVERFLOW = 138
- BrickRED.ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
- BrickRED.ERROR_CODE_OUT_OF_RANGE = 140
- BrickRED.ERROR_CODE_NAME_TOO_LONG = 141
- BrickRED.ERROR_CODE_INVALID_SEEK = 142
- BrickRED.ERROR_CODE_NOT_SUPPORTED = 143
- BrickRED.ERROR_CODE_TOO_MANY_OPEN_FILES = 144
The returned namedtuple has the variables error_code and processes_list_id.
-
BrickRED.spawn_process(executable_string_id, arguments_list_id, environment_list_id, working_directory_string_id, uid, gid, stdin_file_id, stdout_file_id, stderr_file_id, session_id)
Parameters: |
- 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
|
Return type: | (int, int)
|
The following constants are available for this function:
- BrickRED.ERROR_CODE_SUCCESS = 0
- BrickRED.ERROR_CODE_UNKNOWN_ERROR = 1
- BrickRED.ERROR_CODE_INVALID_OPERATION = 2
- BrickRED.ERROR_CODE_OPERATION_ABORTED = 3
- BrickRED.ERROR_CODE_INTERNAL_ERROR = 4
- BrickRED.ERROR_CODE_UNKNOWN_SESSION_ID = 5
- BrickRED.ERROR_CODE_NO_FREE_SESSION_ID = 6
- BrickRED.ERROR_CODE_UNKNOWN_OBJECT_ID = 7
- BrickRED.ERROR_CODE_NO_FREE_OBJECT_ID = 8
- BrickRED.ERROR_CODE_OBJECT_IS_LOCKED = 9
- BrickRED.ERROR_CODE_NO_MORE_DATA = 10
- BrickRED.ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
- BrickRED.ERROR_CODE_PROGRAM_IS_PURGED = 12
- BrickRED.ERROR_CODE_INVALID_PARAMETER = 128
- BrickRED.ERROR_CODE_NO_FREE_MEMORY = 129
- BrickRED.ERROR_CODE_NO_FREE_SPACE = 130
- BrickRED.ERROR_CODE_ACCESS_DENIED = 121
- BrickRED.ERROR_CODE_ALREADY_EXISTS = 132
- BrickRED.ERROR_CODE_DOES_NOT_EXIST = 133
- BrickRED.ERROR_CODE_INTERRUPTED = 134
- BrickRED.ERROR_CODE_IS_DIRECTORY = 135
- BrickRED.ERROR_CODE_NOT_A_DIRECTORY = 136
- BrickRED.ERROR_CODE_WOULD_BLOCK = 137
- BrickRED.ERROR_CODE_OVERFLOW = 138
- BrickRED.ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
- BrickRED.ERROR_CODE_OUT_OF_RANGE = 140
- BrickRED.ERROR_CODE_NAME_TOO_LONG = 141
- BrickRED.ERROR_CODE_INVALID_SEEK = 142
- BrickRED.ERROR_CODE_NOT_SUPPORTED = 143
- BrickRED.ERROR_CODE_TOO_MANY_OPEN_FILES = 144
The returned namedtuple has the variables error_code and process_id.
-
BrickRED.kill_process(process_id, signal)
Parameters: |
- process_id -- int
- signal -- int
|
Return type: | int
|
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 constants are available for this function:
- BrickRED.PROCESS_SIGNAL_INTERRUPT = 2
- BrickRED.PROCESS_SIGNAL_QUIT = 3
- BrickRED.PROCESS_SIGNAL_ABORT = 6
- BrickRED.PROCESS_SIGNAL_KILL = 9
- BrickRED.PROCESS_SIGNAL_USER1 = 10
- BrickRED.PROCESS_SIGNAL_USER2 = 12
- BrickRED.PROCESS_SIGNAL_TERMINATE = 15
- BrickRED.PROCESS_SIGNAL_CONTINUE = 18
- BrickRED.PROCESS_SIGNAL_STOP = 19
- BrickRED.ERROR_CODE_SUCCESS = 0
- BrickRED.ERROR_CODE_UNKNOWN_ERROR = 1
- BrickRED.ERROR_CODE_INVALID_OPERATION = 2
- BrickRED.ERROR_CODE_OPERATION_ABORTED = 3
- BrickRED.ERROR_CODE_INTERNAL_ERROR = 4
- BrickRED.ERROR_CODE_UNKNOWN_SESSION_ID = 5
- BrickRED.ERROR_CODE_NO_FREE_SESSION_ID = 6
- BrickRED.ERROR_CODE_UNKNOWN_OBJECT_ID = 7
- BrickRED.ERROR_CODE_NO_FREE_OBJECT_ID = 8
- BrickRED.ERROR_CODE_OBJECT_IS_LOCKED = 9
- BrickRED.ERROR_CODE_NO_MORE_DATA = 10
- BrickRED.ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
- BrickRED.ERROR_CODE_PROGRAM_IS_PURGED = 12
- BrickRED.ERROR_CODE_INVALID_PARAMETER = 128
- BrickRED.ERROR_CODE_NO_FREE_MEMORY = 129
- BrickRED.ERROR_CODE_NO_FREE_SPACE = 130
- BrickRED.ERROR_CODE_ACCESS_DENIED = 121
- BrickRED.ERROR_CODE_ALREADY_EXISTS = 132
- BrickRED.ERROR_CODE_DOES_NOT_EXIST = 133
- BrickRED.ERROR_CODE_INTERRUPTED = 134
- BrickRED.ERROR_CODE_IS_DIRECTORY = 135
- BrickRED.ERROR_CODE_NOT_A_DIRECTORY = 136
- BrickRED.ERROR_CODE_WOULD_BLOCK = 137
- BrickRED.ERROR_CODE_OVERFLOW = 138
- BrickRED.ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
- BrickRED.ERROR_CODE_OUT_OF_RANGE = 140
- BrickRED.ERROR_CODE_NAME_TOO_LONG = 141
- BrickRED.ERROR_CODE_INVALID_SEEK = 142
- BrickRED.ERROR_CODE_NOT_SUPPORTED = 143
- BrickRED.ERROR_CODE_TOO_MANY_OPEN_FILES = 144
-
BrickRED.get_process_command(process_id, session_id)
Parameters: |
- process_id -- int
- session_id -- int
|
Return type: | (int, int, int, int, int)
|
Returns the executable, arguments, environment and working directory used to
spawn a process object, as passed to spawn_process(), and the resulting
error code.
The following constants are available for this function:
- BrickRED.ERROR_CODE_SUCCESS = 0
- BrickRED.ERROR_CODE_UNKNOWN_ERROR = 1
- BrickRED.ERROR_CODE_INVALID_OPERATION = 2
- BrickRED.ERROR_CODE_OPERATION_ABORTED = 3
- BrickRED.ERROR_CODE_INTERNAL_ERROR = 4
- BrickRED.ERROR_CODE_UNKNOWN_SESSION_ID = 5
- BrickRED.ERROR_CODE_NO_FREE_SESSION_ID = 6
- BrickRED.ERROR_CODE_UNKNOWN_OBJECT_ID = 7
- BrickRED.ERROR_CODE_NO_FREE_OBJECT_ID = 8
- BrickRED.ERROR_CODE_OBJECT_IS_LOCKED = 9
- BrickRED.ERROR_CODE_NO_MORE_DATA = 10
- BrickRED.ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
- BrickRED.ERROR_CODE_PROGRAM_IS_PURGED = 12
- BrickRED.ERROR_CODE_INVALID_PARAMETER = 128
- BrickRED.ERROR_CODE_NO_FREE_MEMORY = 129
- BrickRED.ERROR_CODE_NO_FREE_SPACE = 130
- BrickRED.ERROR_CODE_ACCESS_DENIED = 121
- BrickRED.ERROR_CODE_ALREADY_EXISTS = 132
- BrickRED.ERROR_CODE_DOES_NOT_EXIST = 133
- BrickRED.ERROR_CODE_INTERRUPTED = 134
- BrickRED.ERROR_CODE_IS_DIRECTORY = 135
- BrickRED.ERROR_CODE_NOT_A_DIRECTORY = 136
- BrickRED.ERROR_CODE_WOULD_BLOCK = 137
- BrickRED.ERROR_CODE_OVERFLOW = 138
- BrickRED.ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
- BrickRED.ERROR_CODE_OUT_OF_RANGE = 140
- BrickRED.ERROR_CODE_NAME_TOO_LONG = 141
- BrickRED.ERROR_CODE_INVALID_SEEK = 142
- BrickRED.ERROR_CODE_NOT_SUPPORTED = 143
- BrickRED.ERROR_CODE_TOO_MANY_OPEN_FILES = 144
The returned namedtuple has the variables error_code, executable_string_id, arguments_list_id, environment_list_id and working_directory_string_id.
-
BrickRED.get_process_identity(process_id)
Parameters: | process_id -- int |
Return type: | (int, int, int, int) |
Returns the process ID and the user and group ID used to spawn a process object,
as passed to spawn_process(), and the resulting error code.
The process ID is only valid if the state is Running or Stopped, see
get_process_state().
The following constants are available for this function:
- BrickRED.ERROR_CODE_SUCCESS = 0
- BrickRED.ERROR_CODE_UNKNOWN_ERROR = 1
- BrickRED.ERROR_CODE_INVALID_OPERATION = 2
- BrickRED.ERROR_CODE_OPERATION_ABORTED = 3
- BrickRED.ERROR_CODE_INTERNAL_ERROR = 4
- BrickRED.ERROR_CODE_UNKNOWN_SESSION_ID = 5
- BrickRED.ERROR_CODE_NO_FREE_SESSION_ID = 6
- BrickRED.ERROR_CODE_UNKNOWN_OBJECT_ID = 7
- BrickRED.ERROR_CODE_NO_FREE_OBJECT_ID = 8
- BrickRED.ERROR_CODE_OBJECT_IS_LOCKED = 9
- BrickRED.ERROR_CODE_NO_MORE_DATA = 10
- BrickRED.ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
- BrickRED.ERROR_CODE_PROGRAM_IS_PURGED = 12
- BrickRED.ERROR_CODE_INVALID_PARAMETER = 128
- BrickRED.ERROR_CODE_NO_FREE_MEMORY = 129
- BrickRED.ERROR_CODE_NO_FREE_SPACE = 130
- BrickRED.ERROR_CODE_ACCESS_DENIED = 121
- BrickRED.ERROR_CODE_ALREADY_EXISTS = 132
- BrickRED.ERROR_CODE_DOES_NOT_EXIST = 133
- BrickRED.ERROR_CODE_INTERRUPTED = 134
- BrickRED.ERROR_CODE_IS_DIRECTORY = 135
- BrickRED.ERROR_CODE_NOT_A_DIRECTORY = 136
- BrickRED.ERROR_CODE_WOULD_BLOCK = 137
- BrickRED.ERROR_CODE_OVERFLOW = 138
- BrickRED.ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
- BrickRED.ERROR_CODE_OUT_OF_RANGE = 140
- BrickRED.ERROR_CODE_NAME_TOO_LONG = 141
- BrickRED.ERROR_CODE_INVALID_SEEK = 142
- BrickRED.ERROR_CODE_NOT_SUPPORTED = 143
- BrickRED.ERROR_CODE_TOO_MANY_OPEN_FILES = 144
The returned namedtuple has the variables error_code, pid, uid and gid.
-
BrickRED.get_process_stdio(process_id, session_id)
Parameters: |
- process_id -- int
- session_id -- int
|
Return type: | (int, int, int, int)
|
Returns the stdin, stdout and stderr files used to spawn a process object, as
passed to spawn_process(), and the resulting error code.
The following constants are available for this function:
- BrickRED.ERROR_CODE_SUCCESS = 0
- BrickRED.ERROR_CODE_UNKNOWN_ERROR = 1
- BrickRED.ERROR_CODE_INVALID_OPERATION = 2
- BrickRED.ERROR_CODE_OPERATION_ABORTED = 3
- BrickRED.ERROR_CODE_INTERNAL_ERROR = 4
- BrickRED.ERROR_CODE_UNKNOWN_SESSION_ID = 5
- BrickRED.ERROR_CODE_NO_FREE_SESSION_ID = 6
- BrickRED.ERROR_CODE_UNKNOWN_OBJECT_ID = 7
- BrickRED.ERROR_CODE_NO_FREE_OBJECT_ID = 8
- BrickRED.ERROR_CODE_OBJECT_IS_LOCKED = 9
- BrickRED.ERROR_CODE_NO_MORE_DATA = 10
- BrickRED.ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
- BrickRED.ERROR_CODE_PROGRAM_IS_PURGED = 12
- BrickRED.ERROR_CODE_INVALID_PARAMETER = 128
- BrickRED.ERROR_CODE_NO_FREE_MEMORY = 129
- BrickRED.ERROR_CODE_NO_FREE_SPACE = 130
- BrickRED.ERROR_CODE_ACCESS_DENIED = 121
- BrickRED.ERROR_CODE_ALREADY_EXISTS = 132
- BrickRED.ERROR_CODE_DOES_NOT_EXIST = 133
- BrickRED.ERROR_CODE_INTERRUPTED = 134
- BrickRED.ERROR_CODE_IS_DIRECTORY = 135
- BrickRED.ERROR_CODE_NOT_A_DIRECTORY = 136
- BrickRED.ERROR_CODE_WOULD_BLOCK = 137
- BrickRED.ERROR_CODE_OVERFLOW = 138
- BrickRED.ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
- BrickRED.ERROR_CODE_OUT_OF_RANGE = 140
- BrickRED.ERROR_CODE_NAME_TOO_LONG = 141
- BrickRED.ERROR_CODE_INVALID_SEEK = 142
- BrickRED.ERROR_CODE_NOT_SUPPORTED = 143
- BrickRED.ERROR_CODE_TOO_MANY_OPEN_FILES = 144
The returned namedtuple has the variables error_code, stdin_file_id, stdout_file_id and stderr_file_id.
-
BrickRED.get_process_state(process_id)
Parameters: | process_id -- int |
Return type: | (int, int, int, 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 constants are available for this function:
- BrickRED.ERROR_CODE_SUCCESS = 0
- BrickRED.ERROR_CODE_UNKNOWN_ERROR = 1
- BrickRED.ERROR_CODE_INVALID_OPERATION = 2
- BrickRED.ERROR_CODE_OPERATION_ABORTED = 3
- BrickRED.ERROR_CODE_INTERNAL_ERROR = 4
- BrickRED.ERROR_CODE_UNKNOWN_SESSION_ID = 5
- BrickRED.ERROR_CODE_NO_FREE_SESSION_ID = 6
- BrickRED.ERROR_CODE_UNKNOWN_OBJECT_ID = 7
- BrickRED.ERROR_CODE_NO_FREE_OBJECT_ID = 8
- BrickRED.ERROR_CODE_OBJECT_IS_LOCKED = 9
- BrickRED.ERROR_CODE_NO_MORE_DATA = 10
- BrickRED.ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
- BrickRED.ERROR_CODE_PROGRAM_IS_PURGED = 12
- BrickRED.ERROR_CODE_INVALID_PARAMETER = 128
- BrickRED.ERROR_CODE_NO_FREE_MEMORY = 129
- BrickRED.ERROR_CODE_NO_FREE_SPACE = 130
- BrickRED.ERROR_CODE_ACCESS_DENIED = 121
- BrickRED.ERROR_CODE_ALREADY_EXISTS = 132
- BrickRED.ERROR_CODE_DOES_NOT_EXIST = 133
- BrickRED.ERROR_CODE_INTERRUPTED = 134
- BrickRED.ERROR_CODE_IS_DIRECTORY = 135
- BrickRED.ERROR_CODE_NOT_A_DIRECTORY = 136
- BrickRED.ERROR_CODE_WOULD_BLOCK = 137
- BrickRED.ERROR_CODE_OVERFLOW = 138
- BrickRED.ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
- BrickRED.ERROR_CODE_OUT_OF_RANGE = 140
- BrickRED.ERROR_CODE_NAME_TOO_LONG = 141
- BrickRED.ERROR_CODE_INVALID_SEEK = 142
- BrickRED.ERROR_CODE_NOT_SUPPORTED = 143
- BrickRED.ERROR_CODE_TOO_MANY_OPEN_FILES = 144
- BrickRED.PROCESS_STATE_UNKNOWN = 0
- BrickRED.PROCESS_STATE_RUNNING = 1
- BrickRED.PROCESS_STATE_ERROR = 2
- BrickRED.PROCESS_STATE_EXITED = 3
- BrickRED.PROCESS_STATE_KILLED = 4
- BrickRED.PROCESS_STATE_STOPPED = 5
The returned namedtuple has the variables error_code, state, timestamp and exit_code.
-
BrickRED.get_programs(session_id)
Parameters: | session_id -- int |
Return type: | (int, int) |
The following constants are available for this function:
- BrickRED.ERROR_CODE_SUCCESS = 0
- BrickRED.ERROR_CODE_UNKNOWN_ERROR = 1
- BrickRED.ERROR_CODE_INVALID_OPERATION = 2
- BrickRED.ERROR_CODE_OPERATION_ABORTED = 3
- BrickRED.ERROR_CODE_INTERNAL_ERROR = 4
- BrickRED.ERROR_CODE_UNKNOWN_SESSION_ID = 5
- BrickRED.ERROR_CODE_NO_FREE_SESSION_ID = 6
- BrickRED.ERROR_CODE_UNKNOWN_OBJECT_ID = 7
- BrickRED.ERROR_CODE_NO_FREE_OBJECT_ID = 8
- BrickRED.ERROR_CODE_OBJECT_IS_LOCKED = 9
- BrickRED.ERROR_CODE_NO_MORE_DATA = 10
- BrickRED.ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
- BrickRED.ERROR_CODE_PROGRAM_IS_PURGED = 12
- BrickRED.ERROR_CODE_INVALID_PARAMETER = 128
- BrickRED.ERROR_CODE_NO_FREE_MEMORY = 129
- BrickRED.ERROR_CODE_NO_FREE_SPACE = 130
- BrickRED.ERROR_CODE_ACCESS_DENIED = 121
- BrickRED.ERROR_CODE_ALREADY_EXISTS = 132
- BrickRED.ERROR_CODE_DOES_NOT_EXIST = 133
- BrickRED.ERROR_CODE_INTERRUPTED = 134
- BrickRED.ERROR_CODE_IS_DIRECTORY = 135
- BrickRED.ERROR_CODE_NOT_A_DIRECTORY = 136
- BrickRED.ERROR_CODE_WOULD_BLOCK = 137
- BrickRED.ERROR_CODE_OVERFLOW = 138
- BrickRED.ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
- BrickRED.ERROR_CODE_OUT_OF_RANGE = 140
- BrickRED.ERROR_CODE_NAME_TOO_LONG = 141
- BrickRED.ERROR_CODE_INVALID_SEEK = 142
- BrickRED.ERROR_CODE_NOT_SUPPORTED = 143
- BrickRED.ERROR_CODE_TOO_MANY_OPEN_FILES = 144
The returned namedtuple has the variables error_code and programs_list_id.
-
BrickRED.define_program(identifier_string_id, session_id)
Parameters: |
- identifier_string_id -- int
- session_id -- int
|
Return type: | (int, int)
|
The following constants are available for this function:
- BrickRED.ERROR_CODE_SUCCESS = 0
- BrickRED.ERROR_CODE_UNKNOWN_ERROR = 1
- BrickRED.ERROR_CODE_INVALID_OPERATION = 2
- BrickRED.ERROR_CODE_OPERATION_ABORTED = 3
- BrickRED.ERROR_CODE_INTERNAL_ERROR = 4
- BrickRED.ERROR_CODE_UNKNOWN_SESSION_ID = 5
- BrickRED.ERROR_CODE_NO_FREE_SESSION_ID = 6
- BrickRED.ERROR_CODE_UNKNOWN_OBJECT_ID = 7
- BrickRED.ERROR_CODE_NO_FREE_OBJECT_ID = 8
- BrickRED.ERROR_CODE_OBJECT_IS_LOCKED = 9
- BrickRED.ERROR_CODE_NO_MORE_DATA = 10
- BrickRED.ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
- BrickRED.ERROR_CODE_PROGRAM_IS_PURGED = 12
- BrickRED.ERROR_CODE_INVALID_PARAMETER = 128
- BrickRED.ERROR_CODE_NO_FREE_MEMORY = 129
- BrickRED.ERROR_CODE_NO_FREE_SPACE = 130
- BrickRED.ERROR_CODE_ACCESS_DENIED = 121
- BrickRED.ERROR_CODE_ALREADY_EXISTS = 132
- BrickRED.ERROR_CODE_DOES_NOT_EXIST = 133
- BrickRED.ERROR_CODE_INTERRUPTED = 134
- BrickRED.ERROR_CODE_IS_DIRECTORY = 135
- BrickRED.ERROR_CODE_NOT_A_DIRECTORY = 136
- BrickRED.ERROR_CODE_WOULD_BLOCK = 137
- BrickRED.ERROR_CODE_OVERFLOW = 138
- BrickRED.ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
- BrickRED.ERROR_CODE_OUT_OF_RANGE = 140
- BrickRED.ERROR_CODE_NAME_TOO_LONG = 141
- BrickRED.ERROR_CODE_INVALID_SEEK = 142
- BrickRED.ERROR_CODE_NOT_SUPPORTED = 143
- BrickRED.ERROR_CODE_TOO_MANY_OPEN_FILES = 144
The returned namedtuple has the variables error_code and program_id.
-
BrickRED.purge_program(program_id, cookie)
Parameters: |
- program_id -- int
- cookie -- int
|
Return type: | int
|
The following constants are available for this function:
- BrickRED.ERROR_CODE_SUCCESS = 0
- BrickRED.ERROR_CODE_UNKNOWN_ERROR = 1
- BrickRED.ERROR_CODE_INVALID_OPERATION = 2
- BrickRED.ERROR_CODE_OPERATION_ABORTED = 3
- BrickRED.ERROR_CODE_INTERNAL_ERROR = 4
- BrickRED.ERROR_CODE_UNKNOWN_SESSION_ID = 5
- BrickRED.ERROR_CODE_NO_FREE_SESSION_ID = 6
- BrickRED.ERROR_CODE_UNKNOWN_OBJECT_ID = 7
- BrickRED.ERROR_CODE_NO_FREE_OBJECT_ID = 8
- BrickRED.ERROR_CODE_OBJECT_IS_LOCKED = 9
- BrickRED.ERROR_CODE_NO_MORE_DATA = 10
- BrickRED.ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
- BrickRED.ERROR_CODE_PROGRAM_IS_PURGED = 12
- BrickRED.ERROR_CODE_INVALID_PARAMETER = 128
- BrickRED.ERROR_CODE_NO_FREE_MEMORY = 129
- BrickRED.ERROR_CODE_NO_FREE_SPACE = 130
- BrickRED.ERROR_CODE_ACCESS_DENIED = 121
- BrickRED.ERROR_CODE_ALREADY_EXISTS = 132
- BrickRED.ERROR_CODE_DOES_NOT_EXIST = 133
- BrickRED.ERROR_CODE_INTERRUPTED = 134
- BrickRED.ERROR_CODE_IS_DIRECTORY = 135
- BrickRED.ERROR_CODE_NOT_A_DIRECTORY = 136
- BrickRED.ERROR_CODE_WOULD_BLOCK = 137
- BrickRED.ERROR_CODE_OVERFLOW = 138
- BrickRED.ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
- BrickRED.ERROR_CODE_OUT_OF_RANGE = 140
- BrickRED.ERROR_CODE_NAME_TOO_LONG = 141
- BrickRED.ERROR_CODE_INVALID_SEEK = 142
- BrickRED.ERROR_CODE_NOT_SUPPORTED = 143
- BrickRED.ERROR_CODE_TOO_MANY_OPEN_FILES = 144
-
BrickRED.get_program_identifier(program_id, session_id)
Parameters: |
- program_id -- int
- session_id -- int
|
Return type: | (int, int)
|
The following constants are available for this function:
- BrickRED.ERROR_CODE_SUCCESS = 0
- BrickRED.ERROR_CODE_UNKNOWN_ERROR = 1
- BrickRED.ERROR_CODE_INVALID_OPERATION = 2
- BrickRED.ERROR_CODE_OPERATION_ABORTED = 3
- BrickRED.ERROR_CODE_INTERNAL_ERROR = 4
- BrickRED.ERROR_CODE_UNKNOWN_SESSION_ID = 5
- BrickRED.ERROR_CODE_NO_FREE_SESSION_ID = 6
- BrickRED.ERROR_CODE_UNKNOWN_OBJECT_ID = 7
- BrickRED.ERROR_CODE_NO_FREE_OBJECT_ID = 8
- BrickRED.ERROR_CODE_OBJECT_IS_LOCKED = 9
- BrickRED.ERROR_CODE_NO_MORE_DATA = 10
- BrickRED.ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
- BrickRED.ERROR_CODE_PROGRAM_IS_PURGED = 12
- BrickRED.ERROR_CODE_INVALID_PARAMETER = 128
- BrickRED.ERROR_CODE_NO_FREE_MEMORY = 129
- BrickRED.ERROR_CODE_NO_FREE_SPACE = 130
- BrickRED.ERROR_CODE_ACCESS_DENIED = 121
- BrickRED.ERROR_CODE_ALREADY_EXISTS = 132
- BrickRED.ERROR_CODE_DOES_NOT_EXIST = 133
- BrickRED.ERROR_CODE_INTERRUPTED = 134
- BrickRED.ERROR_CODE_IS_DIRECTORY = 135
- BrickRED.ERROR_CODE_NOT_A_DIRECTORY = 136
- BrickRED.ERROR_CODE_WOULD_BLOCK = 137
- BrickRED.ERROR_CODE_OVERFLOW = 138
- BrickRED.ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
- BrickRED.ERROR_CODE_OUT_OF_RANGE = 140
- BrickRED.ERROR_CODE_NAME_TOO_LONG = 141
- BrickRED.ERROR_CODE_INVALID_SEEK = 142
- BrickRED.ERROR_CODE_NOT_SUPPORTED = 143
- BrickRED.ERROR_CODE_TOO_MANY_OPEN_FILES = 144
The returned namedtuple has the variables error_code and identifier_string_id.
-
BrickRED.get_program_root_directory(program_id, session_id)
Parameters: |
- program_id -- int
- session_id -- int
|
Return type: | (int, int)
|
FIXME: root directory is absolute: <home>/programs/<identifier>
The following constants are available for this function:
- BrickRED.ERROR_CODE_SUCCESS = 0
- BrickRED.ERROR_CODE_UNKNOWN_ERROR = 1
- BrickRED.ERROR_CODE_INVALID_OPERATION = 2
- BrickRED.ERROR_CODE_OPERATION_ABORTED = 3
- BrickRED.ERROR_CODE_INTERNAL_ERROR = 4
- BrickRED.ERROR_CODE_UNKNOWN_SESSION_ID = 5
- BrickRED.ERROR_CODE_NO_FREE_SESSION_ID = 6
- BrickRED.ERROR_CODE_UNKNOWN_OBJECT_ID = 7
- BrickRED.ERROR_CODE_NO_FREE_OBJECT_ID = 8
- BrickRED.ERROR_CODE_OBJECT_IS_LOCKED = 9
- BrickRED.ERROR_CODE_NO_MORE_DATA = 10
- BrickRED.ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
- BrickRED.ERROR_CODE_PROGRAM_IS_PURGED = 12
- BrickRED.ERROR_CODE_INVALID_PARAMETER = 128
- BrickRED.ERROR_CODE_NO_FREE_MEMORY = 129
- BrickRED.ERROR_CODE_NO_FREE_SPACE = 130
- BrickRED.ERROR_CODE_ACCESS_DENIED = 121
- BrickRED.ERROR_CODE_ALREADY_EXISTS = 132
- BrickRED.ERROR_CODE_DOES_NOT_EXIST = 133
- BrickRED.ERROR_CODE_INTERRUPTED = 134
- BrickRED.ERROR_CODE_IS_DIRECTORY = 135
- BrickRED.ERROR_CODE_NOT_A_DIRECTORY = 136
- BrickRED.ERROR_CODE_WOULD_BLOCK = 137
- BrickRED.ERROR_CODE_OVERFLOW = 138
- BrickRED.ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
- BrickRED.ERROR_CODE_OUT_OF_RANGE = 140
- BrickRED.ERROR_CODE_NAME_TOO_LONG = 141
- BrickRED.ERROR_CODE_INVALID_SEEK = 142
- BrickRED.ERROR_CODE_NOT_SUPPORTED = 143
- BrickRED.ERROR_CODE_TOO_MANY_OPEN_FILES = 144
The returned namedtuple has the variables error_code and root_directory_string_id.
-
BrickRED.set_program_command(program_id, executable_string_id, arguments_list_id, environment_list_id, working_directory_string_id)
Parameters: |
- program_id -- int
- executable_string_id -- int
- arguments_list_id -- int
- environment_list_id -- int
- working_directory_string_id -- int
|
Return type: | int
|
FIXME: working directory is relative to <home>/programs/<identifier>/bin
The following constants are available for this function:
- BrickRED.ERROR_CODE_SUCCESS = 0
- BrickRED.ERROR_CODE_UNKNOWN_ERROR = 1
- BrickRED.ERROR_CODE_INVALID_OPERATION = 2
- BrickRED.ERROR_CODE_OPERATION_ABORTED = 3
- BrickRED.ERROR_CODE_INTERNAL_ERROR = 4
- BrickRED.ERROR_CODE_UNKNOWN_SESSION_ID = 5
- BrickRED.ERROR_CODE_NO_FREE_SESSION_ID = 6
- BrickRED.ERROR_CODE_UNKNOWN_OBJECT_ID = 7
- BrickRED.ERROR_CODE_NO_FREE_OBJECT_ID = 8
- BrickRED.ERROR_CODE_OBJECT_IS_LOCKED = 9
- BrickRED.ERROR_CODE_NO_MORE_DATA = 10
- BrickRED.ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
- BrickRED.ERROR_CODE_PROGRAM_IS_PURGED = 12
- BrickRED.ERROR_CODE_INVALID_PARAMETER = 128
- BrickRED.ERROR_CODE_NO_FREE_MEMORY = 129
- BrickRED.ERROR_CODE_NO_FREE_SPACE = 130
- BrickRED.ERROR_CODE_ACCESS_DENIED = 121
- BrickRED.ERROR_CODE_ALREADY_EXISTS = 132
- BrickRED.ERROR_CODE_DOES_NOT_EXIST = 133
- BrickRED.ERROR_CODE_INTERRUPTED = 134
- BrickRED.ERROR_CODE_IS_DIRECTORY = 135
- BrickRED.ERROR_CODE_NOT_A_DIRECTORY = 136
- BrickRED.ERROR_CODE_WOULD_BLOCK = 137
- BrickRED.ERROR_CODE_OVERFLOW = 138
- BrickRED.ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
- BrickRED.ERROR_CODE_OUT_OF_RANGE = 140
- BrickRED.ERROR_CODE_NAME_TOO_LONG = 141
- BrickRED.ERROR_CODE_INVALID_SEEK = 142
- BrickRED.ERROR_CODE_NOT_SUPPORTED = 143
- BrickRED.ERROR_CODE_TOO_MANY_OPEN_FILES = 144
-
BrickRED.get_program_command(program_id, session_id)
Parameters: |
- program_id -- int
- session_id -- int
|
Return type: | (int, int, int, int, int)
|
FIXME: working directory is relative to <home>/programs/<identifier>/bin
The following constants are available for this function:
- BrickRED.ERROR_CODE_SUCCESS = 0
- BrickRED.ERROR_CODE_UNKNOWN_ERROR = 1
- BrickRED.ERROR_CODE_INVALID_OPERATION = 2
- BrickRED.ERROR_CODE_OPERATION_ABORTED = 3
- BrickRED.ERROR_CODE_INTERNAL_ERROR = 4
- BrickRED.ERROR_CODE_UNKNOWN_SESSION_ID = 5
- BrickRED.ERROR_CODE_NO_FREE_SESSION_ID = 6
- BrickRED.ERROR_CODE_UNKNOWN_OBJECT_ID = 7
- BrickRED.ERROR_CODE_NO_FREE_OBJECT_ID = 8
- BrickRED.ERROR_CODE_OBJECT_IS_LOCKED = 9
- BrickRED.ERROR_CODE_NO_MORE_DATA = 10
- BrickRED.ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
- BrickRED.ERROR_CODE_PROGRAM_IS_PURGED = 12
- BrickRED.ERROR_CODE_INVALID_PARAMETER = 128
- BrickRED.ERROR_CODE_NO_FREE_MEMORY = 129
- BrickRED.ERROR_CODE_NO_FREE_SPACE = 130
- BrickRED.ERROR_CODE_ACCESS_DENIED = 121
- BrickRED.ERROR_CODE_ALREADY_EXISTS = 132
- BrickRED.ERROR_CODE_DOES_NOT_EXIST = 133
- BrickRED.ERROR_CODE_INTERRUPTED = 134
- BrickRED.ERROR_CODE_IS_DIRECTORY = 135
- BrickRED.ERROR_CODE_NOT_A_DIRECTORY = 136
- BrickRED.ERROR_CODE_WOULD_BLOCK = 137
- BrickRED.ERROR_CODE_OVERFLOW = 138
- BrickRED.ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
- BrickRED.ERROR_CODE_OUT_OF_RANGE = 140
- BrickRED.ERROR_CODE_NAME_TOO_LONG = 141
- BrickRED.ERROR_CODE_INVALID_SEEK = 142
- BrickRED.ERROR_CODE_NOT_SUPPORTED = 143
- BrickRED.ERROR_CODE_TOO_MANY_OPEN_FILES = 144
The returned namedtuple has the variables error_code, executable_string_id, arguments_list_id, environment_list_id and working_directory_string_id.
-
BrickRED.set_program_stdio_redirection(program_id, stdin_redirection, stdin_file_name_string_id, stdout_redirection, stdout_file_name_string_id, stderr_redirection, stderr_file_name_string_id)
Parameters: |
- program_id -- int
- stdin_redirection -- int
- stdin_file_name_string_id -- int
- stdout_redirection -- int
- stdout_file_name_string_id -- int
- stderr_redirection -- int
- stderr_file_name_string_id -- int
|
Return type: | int
|
FIXME: stdio file names are relative to <home>/programs/<identifier>/bin
The following constants are available for this function:
- BrickRED.PROGRAM_STDIO_REDIRECTION_DEV_NULL = 0
- BrickRED.PROGRAM_STDIO_REDIRECTION_PIPE = 1
- BrickRED.PROGRAM_STDIO_REDIRECTION_FILE = 2
- BrickRED.PROGRAM_STDIO_REDIRECTION_INDIVIDUAL_LOG = 3
- BrickRED.PROGRAM_STDIO_REDIRECTION_CONTINUOUS_LOG = 4
- BrickRED.PROGRAM_STDIO_REDIRECTION_STDOUT = 5
- BrickRED.ERROR_CODE_SUCCESS = 0
- BrickRED.ERROR_CODE_UNKNOWN_ERROR = 1
- BrickRED.ERROR_CODE_INVALID_OPERATION = 2
- BrickRED.ERROR_CODE_OPERATION_ABORTED = 3
- BrickRED.ERROR_CODE_INTERNAL_ERROR = 4
- BrickRED.ERROR_CODE_UNKNOWN_SESSION_ID = 5
- BrickRED.ERROR_CODE_NO_FREE_SESSION_ID = 6
- BrickRED.ERROR_CODE_UNKNOWN_OBJECT_ID = 7
- BrickRED.ERROR_CODE_NO_FREE_OBJECT_ID = 8
- BrickRED.ERROR_CODE_OBJECT_IS_LOCKED = 9
- BrickRED.ERROR_CODE_NO_MORE_DATA = 10
- BrickRED.ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
- BrickRED.ERROR_CODE_PROGRAM_IS_PURGED = 12
- BrickRED.ERROR_CODE_INVALID_PARAMETER = 128
- BrickRED.ERROR_CODE_NO_FREE_MEMORY = 129
- BrickRED.ERROR_CODE_NO_FREE_SPACE = 130
- BrickRED.ERROR_CODE_ACCESS_DENIED = 121
- BrickRED.ERROR_CODE_ALREADY_EXISTS = 132
- BrickRED.ERROR_CODE_DOES_NOT_EXIST = 133
- BrickRED.ERROR_CODE_INTERRUPTED = 134
- BrickRED.ERROR_CODE_IS_DIRECTORY = 135
- BrickRED.ERROR_CODE_NOT_A_DIRECTORY = 136
- BrickRED.ERROR_CODE_WOULD_BLOCK = 137
- BrickRED.ERROR_CODE_OVERFLOW = 138
- BrickRED.ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
- BrickRED.ERROR_CODE_OUT_OF_RANGE = 140
- BrickRED.ERROR_CODE_NAME_TOO_LONG = 141
- BrickRED.ERROR_CODE_INVALID_SEEK = 142
- BrickRED.ERROR_CODE_NOT_SUPPORTED = 143
- BrickRED.ERROR_CODE_TOO_MANY_OPEN_FILES = 144
-
BrickRED.get_program_stdio_redirection(program_id, session_id)
Parameters: |
- program_id -- int
- session_id -- int
|
Return type: | (int, int, int, int, int, int, int)
|
FIXME: stdio file names are relative to <home>/programs/<identifier>/bin
The following constants are available for this function:
- BrickRED.ERROR_CODE_SUCCESS = 0
- BrickRED.ERROR_CODE_UNKNOWN_ERROR = 1
- BrickRED.ERROR_CODE_INVALID_OPERATION = 2
- BrickRED.ERROR_CODE_OPERATION_ABORTED = 3
- BrickRED.ERROR_CODE_INTERNAL_ERROR = 4
- BrickRED.ERROR_CODE_UNKNOWN_SESSION_ID = 5
- BrickRED.ERROR_CODE_NO_FREE_SESSION_ID = 6
- BrickRED.ERROR_CODE_UNKNOWN_OBJECT_ID = 7
- BrickRED.ERROR_CODE_NO_FREE_OBJECT_ID = 8
- BrickRED.ERROR_CODE_OBJECT_IS_LOCKED = 9
- BrickRED.ERROR_CODE_NO_MORE_DATA = 10
- BrickRED.ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
- BrickRED.ERROR_CODE_PROGRAM_IS_PURGED = 12
- BrickRED.ERROR_CODE_INVALID_PARAMETER = 128
- BrickRED.ERROR_CODE_NO_FREE_MEMORY = 129
- BrickRED.ERROR_CODE_NO_FREE_SPACE = 130
- BrickRED.ERROR_CODE_ACCESS_DENIED = 121
- BrickRED.ERROR_CODE_ALREADY_EXISTS = 132
- BrickRED.ERROR_CODE_DOES_NOT_EXIST = 133
- BrickRED.ERROR_CODE_INTERRUPTED = 134
- BrickRED.ERROR_CODE_IS_DIRECTORY = 135
- BrickRED.ERROR_CODE_NOT_A_DIRECTORY = 136
- BrickRED.ERROR_CODE_WOULD_BLOCK = 137
- BrickRED.ERROR_CODE_OVERFLOW = 138
- BrickRED.ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
- BrickRED.ERROR_CODE_OUT_OF_RANGE = 140
- BrickRED.ERROR_CODE_NAME_TOO_LONG = 141
- BrickRED.ERROR_CODE_INVALID_SEEK = 142
- BrickRED.ERROR_CODE_NOT_SUPPORTED = 143
- BrickRED.ERROR_CODE_TOO_MANY_OPEN_FILES = 144
- BrickRED.PROGRAM_STDIO_REDIRECTION_DEV_NULL = 0
- BrickRED.PROGRAM_STDIO_REDIRECTION_PIPE = 1
- BrickRED.PROGRAM_STDIO_REDIRECTION_FILE = 2
- BrickRED.PROGRAM_STDIO_REDIRECTION_INDIVIDUAL_LOG = 3
- BrickRED.PROGRAM_STDIO_REDIRECTION_CONTINUOUS_LOG = 4
- BrickRED.PROGRAM_STDIO_REDIRECTION_STDOUT = 5
The returned namedtuple has the variables error_code, stdin_redirection, stdin_file_name_string_id, stdout_redirection, stdout_file_name_string_id, stderr_redirection and stderr_file_name_string_id.
-
BrickRED.set_program_schedule(program_id, start_mode, continue_after_error, start_interval, start_fields_string_id)
Parameters: |
- program_id -- int
- start_mode -- int
- continue_after_error -- bool
- start_interval -- int
- start_fields_string_id -- int
|
Return type: | int
|
The following constants are available for this function:
- BrickRED.PROGRAM_START_MODE_NEVER = 0
- BrickRED.PROGRAM_START_MODE_ALWAYS = 1
- BrickRED.PROGRAM_START_MODE_INTERVAL = 2
- BrickRED.PROGRAM_START_MODE_CRON = 3
- BrickRED.ERROR_CODE_SUCCESS = 0
- BrickRED.ERROR_CODE_UNKNOWN_ERROR = 1
- BrickRED.ERROR_CODE_INVALID_OPERATION = 2
- BrickRED.ERROR_CODE_OPERATION_ABORTED = 3
- BrickRED.ERROR_CODE_INTERNAL_ERROR = 4
- BrickRED.ERROR_CODE_UNKNOWN_SESSION_ID = 5
- BrickRED.ERROR_CODE_NO_FREE_SESSION_ID = 6
- BrickRED.ERROR_CODE_UNKNOWN_OBJECT_ID = 7
- BrickRED.ERROR_CODE_NO_FREE_OBJECT_ID = 8
- BrickRED.ERROR_CODE_OBJECT_IS_LOCKED = 9
- BrickRED.ERROR_CODE_NO_MORE_DATA = 10
- BrickRED.ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
- BrickRED.ERROR_CODE_PROGRAM_IS_PURGED = 12
- BrickRED.ERROR_CODE_INVALID_PARAMETER = 128
- BrickRED.ERROR_CODE_NO_FREE_MEMORY = 129
- BrickRED.ERROR_CODE_NO_FREE_SPACE = 130
- BrickRED.ERROR_CODE_ACCESS_DENIED = 121
- BrickRED.ERROR_CODE_ALREADY_EXISTS = 132
- BrickRED.ERROR_CODE_DOES_NOT_EXIST = 133
- BrickRED.ERROR_CODE_INTERRUPTED = 134
- BrickRED.ERROR_CODE_IS_DIRECTORY = 135
- BrickRED.ERROR_CODE_NOT_A_DIRECTORY = 136
- BrickRED.ERROR_CODE_WOULD_BLOCK = 137
- BrickRED.ERROR_CODE_OVERFLOW = 138
- BrickRED.ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
- BrickRED.ERROR_CODE_OUT_OF_RANGE = 140
- BrickRED.ERROR_CODE_NAME_TOO_LONG = 141
- BrickRED.ERROR_CODE_INVALID_SEEK = 142
- BrickRED.ERROR_CODE_NOT_SUPPORTED = 143
- BrickRED.ERROR_CODE_TOO_MANY_OPEN_FILES = 144
-
BrickRED.get_program_schedule(program_id, session_id)
Parameters: |
- program_id -- int
- session_id -- int
|
Return type: | (int, int, bool, int, int)
|
The following constants are available for this function:
- BrickRED.ERROR_CODE_SUCCESS = 0
- BrickRED.ERROR_CODE_UNKNOWN_ERROR = 1
- BrickRED.ERROR_CODE_INVALID_OPERATION = 2
- BrickRED.ERROR_CODE_OPERATION_ABORTED = 3
- BrickRED.ERROR_CODE_INTERNAL_ERROR = 4
- BrickRED.ERROR_CODE_UNKNOWN_SESSION_ID = 5
- BrickRED.ERROR_CODE_NO_FREE_SESSION_ID = 6
- BrickRED.ERROR_CODE_UNKNOWN_OBJECT_ID = 7
- BrickRED.ERROR_CODE_NO_FREE_OBJECT_ID = 8
- BrickRED.ERROR_CODE_OBJECT_IS_LOCKED = 9
- BrickRED.ERROR_CODE_NO_MORE_DATA = 10
- BrickRED.ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
- BrickRED.ERROR_CODE_PROGRAM_IS_PURGED = 12
- BrickRED.ERROR_CODE_INVALID_PARAMETER = 128
- BrickRED.ERROR_CODE_NO_FREE_MEMORY = 129
- BrickRED.ERROR_CODE_NO_FREE_SPACE = 130
- BrickRED.ERROR_CODE_ACCESS_DENIED = 121
- BrickRED.ERROR_CODE_ALREADY_EXISTS = 132
- BrickRED.ERROR_CODE_DOES_NOT_EXIST = 133
- BrickRED.ERROR_CODE_INTERRUPTED = 134
- BrickRED.ERROR_CODE_IS_DIRECTORY = 135
- BrickRED.ERROR_CODE_NOT_A_DIRECTORY = 136
- BrickRED.ERROR_CODE_WOULD_BLOCK = 137
- BrickRED.ERROR_CODE_OVERFLOW = 138
- BrickRED.ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
- BrickRED.ERROR_CODE_OUT_OF_RANGE = 140
- BrickRED.ERROR_CODE_NAME_TOO_LONG = 141
- BrickRED.ERROR_CODE_INVALID_SEEK = 142
- BrickRED.ERROR_CODE_NOT_SUPPORTED = 143
- BrickRED.ERROR_CODE_TOO_MANY_OPEN_FILES = 144
- BrickRED.PROGRAM_START_MODE_NEVER = 0
- BrickRED.PROGRAM_START_MODE_ALWAYS = 1
- BrickRED.PROGRAM_START_MODE_INTERVAL = 2
- BrickRED.PROGRAM_START_MODE_CRON = 3
The returned namedtuple has the variables error_code, start_mode, continue_after_error, start_interval and start_fields_string_id.
-
BrickRED.get_program_scheduler_state(program_id, session_id)
Parameters: |
- program_id -- int
- session_id -- int
|
Return type: | (int, int, int, int)
|
FIXME: message is currently valid in error-occurred state only
The following constants are available for this function:
- BrickRED.ERROR_CODE_SUCCESS = 0
- BrickRED.ERROR_CODE_UNKNOWN_ERROR = 1
- BrickRED.ERROR_CODE_INVALID_OPERATION = 2
- BrickRED.ERROR_CODE_OPERATION_ABORTED = 3
- BrickRED.ERROR_CODE_INTERNAL_ERROR = 4
- BrickRED.ERROR_CODE_UNKNOWN_SESSION_ID = 5
- BrickRED.ERROR_CODE_NO_FREE_SESSION_ID = 6
- BrickRED.ERROR_CODE_UNKNOWN_OBJECT_ID = 7
- BrickRED.ERROR_CODE_NO_FREE_OBJECT_ID = 8
- BrickRED.ERROR_CODE_OBJECT_IS_LOCKED = 9
- BrickRED.ERROR_CODE_NO_MORE_DATA = 10
- BrickRED.ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
- BrickRED.ERROR_CODE_PROGRAM_IS_PURGED = 12
- BrickRED.ERROR_CODE_INVALID_PARAMETER = 128
- BrickRED.ERROR_CODE_NO_FREE_MEMORY = 129
- BrickRED.ERROR_CODE_NO_FREE_SPACE = 130
- BrickRED.ERROR_CODE_ACCESS_DENIED = 121
- BrickRED.ERROR_CODE_ALREADY_EXISTS = 132
- BrickRED.ERROR_CODE_DOES_NOT_EXIST = 133
- BrickRED.ERROR_CODE_INTERRUPTED = 134
- BrickRED.ERROR_CODE_IS_DIRECTORY = 135
- BrickRED.ERROR_CODE_NOT_A_DIRECTORY = 136
- BrickRED.ERROR_CODE_WOULD_BLOCK = 137
- BrickRED.ERROR_CODE_OVERFLOW = 138
- BrickRED.ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
- BrickRED.ERROR_CODE_OUT_OF_RANGE = 140
- BrickRED.ERROR_CODE_NAME_TOO_LONG = 141
- BrickRED.ERROR_CODE_INVALID_SEEK = 142
- BrickRED.ERROR_CODE_NOT_SUPPORTED = 143
- BrickRED.ERROR_CODE_TOO_MANY_OPEN_FILES = 144
- BrickRED.PROGRAM_SCHEDULER_STATE_STOPPED = 0
- BrickRED.PROGRAM_SCHEDULER_STATE_RUNNING = 1
The returned namedtuple has the variables error_code, state, timestamp and message_string_id.
-
BrickRED.continue_program_schedule(program_id)
Parameters: | program_id -- int |
Return type: | int |
The following constants are available for this function:
- BrickRED.ERROR_CODE_SUCCESS = 0
- BrickRED.ERROR_CODE_UNKNOWN_ERROR = 1
- BrickRED.ERROR_CODE_INVALID_OPERATION = 2
- BrickRED.ERROR_CODE_OPERATION_ABORTED = 3
- BrickRED.ERROR_CODE_INTERNAL_ERROR = 4
- BrickRED.ERROR_CODE_UNKNOWN_SESSION_ID = 5
- BrickRED.ERROR_CODE_NO_FREE_SESSION_ID = 6
- BrickRED.ERROR_CODE_UNKNOWN_OBJECT_ID = 7
- BrickRED.ERROR_CODE_NO_FREE_OBJECT_ID = 8
- BrickRED.ERROR_CODE_OBJECT_IS_LOCKED = 9
- BrickRED.ERROR_CODE_NO_MORE_DATA = 10
- BrickRED.ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
- BrickRED.ERROR_CODE_PROGRAM_IS_PURGED = 12
- BrickRED.ERROR_CODE_INVALID_PARAMETER = 128
- BrickRED.ERROR_CODE_NO_FREE_MEMORY = 129
- BrickRED.ERROR_CODE_NO_FREE_SPACE = 130
- BrickRED.ERROR_CODE_ACCESS_DENIED = 121
- BrickRED.ERROR_CODE_ALREADY_EXISTS = 132
- BrickRED.ERROR_CODE_DOES_NOT_EXIST = 133
- BrickRED.ERROR_CODE_INTERRUPTED = 134
- BrickRED.ERROR_CODE_IS_DIRECTORY = 135
- BrickRED.ERROR_CODE_NOT_A_DIRECTORY = 136
- BrickRED.ERROR_CODE_WOULD_BLOCK = 137
- BrickRED.ERROR_CODE_OVERFLOW = 138
- BrickRED.ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
- BrickRED.ERROR_CODE_OUT_OF_RANGE = 140
- BrickRED.ERROR_CODE_NAME_TOO_LONG = 141
- BrickRED.ERROR_CODE_INVALID_SEEK = 142
- BrickRED.ERROR_CODE_NOT_SUPPORTED = 143
- BrickRED.ERROR_CODE_TOO_MANY_OPEN_FILES = 144
-
BrickRED.start_program(program_id)
Parameters: | program_id -- int |
Return type: | int |
The following constants are available for this function:
- BrickRED.ERROR_CODE_SUCCESS = 0
- BrickRED.ERROR_CODE_UNKNOWN_ERROR = 1
- BrickRED.ERROR_CODE_INVALID_OPERATION = 2
- BrickRED.ERROR_CODE_OPERATION_ABORTED = 3
- BrickRED.ERROR_CODE_INTERNAL_ERROR = 4
- BrickRED.ERROR_CODE_UNKNOWN_SESSION_ID = 5
- BrickRED.ERROR_CODE_NO_FREE_SESSION_ID = 6
- BrickRED.ERROR_CODE_UNKNOWN_OBJECT_ID = 7
- BrickRED.ERROR_CODE_NO_FREE_OBJECT_ID = 8
- BrickRED.ERROR_CODE_OBJECT_IS_LOCKED = 9
- BrickRED.ERROR_CODE_NO_MORE_DATA = 10
- BrickRED.ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
- BrickRED.ERROR_CODE_PROGRAM_IS_PURGED = 12
- BrickRED.ERROR_CODE_INVALID_PARAMETER = 128
- BrickRED.ERROR_CODE_NO_FREE_MEMORY = 129
- BrickRED.ERROR_CODE_NO_FREE_SPACE = 130
- BrickRED.ERROR_CODE_ACCESS_DENIED = 121
- BrickRED.ERROR_CODE_ALREADY_EXISTS = 132
- BrickRED.ERROR_CODE_DOES_NOT_EXIST = 133
- BrickRED.ERROR_CODE_INTERRUPTED = 134
- BrickRED.ERROR_CODE_IS_DIRECTORY = 135
- BrickRED.ERROR_CODE_NOT_A_DIRECTORY = 136
- BrickRED.ERROR_CODE_WOULD_BLOCK = 137
- BrickRED.ERROR_CODE_OVERFLOW = 138
- BrickRED.ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
- BrickRED.ERROR_CODE_OUT_OF_RANGE = 140
- BrickRED.ERROR_CODE_NAME_TOO_LONG = 141
- BrickRED.ERROR_CODE_INVALID_SEEK = 142
- BrickRED.ERROR_CODE_NOT_SUPPORTED = 143
- BrickRED.ERROR_CODE_TOO_MANY_OPEN_FILES = 144
-
BrickRED.get_last_spawned_program_process(program_id, session_id)
Parameters: |
- program_id -- int
- session_id -- int
|
Return type: | (int, int, int)
|
The following constants are available for this function:
- BrickRED.ERROR_CODE_SUCCESS = 0
- BrickRED.ERROR_CODE_UNKNOWN_ERROR = 1
- BrickRED.ERROR_CODE_INVALID_OPERATION = 2
- BrickRED.ERROR_CODE_OPERATION_ABORTED = 3
- BrickRED.ERROR_CODE_INTERNAL_ERROR = 4
- BrickRED.ERROR_CODE_UNKNOWN_SESSION_ID = 5
- BrickRED.ERROR_CODE_NO_FREE_SESSION_ID = 6
- BrickRED.ERROR_CODE_UNKNOWN_OBJECT_ID = 7
- BrickRED.ERROR_CODE_NO_FREE_OBJECT_ID = 8
- BrickRED.ERROR_CODE_OBJECT_IS_LOCKED = 9
- BrickRED.ERROR_CODE_NO_MORE_DATA = 10
- BrickRED.ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
- BrickRED.ERROR_CODE_PROGRAM_IS_PURGED = 12
- BrickRED.ERROR_CODE_INVALID_PARAMETER = 128
- BrickRED.ERROR_CODE_NO_FREE_MEMORY = 129
- BrickRED.ERROR_CODE_NO_FREE_SPACE = 130
- BrickRED.ERROR_CODE_ACCESS_DENIED = 121
- BrickRED.ERROR_CODE_ALREADY_EXISTS = 132
- BrickRED.ERROR_CODE_DOES_NOT_EXIST = 133
- BrickRED.ERROR_CODE_INTERRUPTED = 134
- BrickRED.ERROR_CODE_IS_DIRECTORY = 135
- BrickRED.ERROR_CODE_NOT_A_DIRECTORY = 136
- BrickRED.ERROR_CODE_WOULD_BLOCK = 137
- BrickRED.ERROR_CODE_OVERFLOW = 138
- BrickRED.ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
- BrickRED.ERROR_CODE_OUT_OF_RANGE = 140
- BrickRED.ERROR_CODE_NAME_TOO_LONG = 141
- BrickRED.ERROR_CODE_INVALID_SEEK = 142
- BrickRED.ERROR_CODE_NOT_SUPPORTED = 143
- BrickRED.ERROR_CODE_TOO_MANY_OPEN_FILES = 144
The returned namedtuple has the variables error_code, process_id and timestamp.
-
BrickRED.get_custom_program_option_names(program_id, session_id)
Parameters: |
- program_id -- int
- session_id -- int
|
Return type: | (int, int)
|
The following constants are available for this function:
- BrickRED.ERROR_CODE_SUCCESS = 0
- BrickRED.ERROR_CODE_UNKNOWN_ERROR = 1
- BrickRED.ERROR_CODE_INVALID_OPERATION = 2
- BrickRED.ERROR_CODE_OPERATION_ABORTED = 3
- BrickRED.ERROR_CODE_INTERNAL_ERROR = 4
- BrickRED.ERROR_CODE_UNKNOWN_SESSION_ID = 5
- BrickRED.ERROR_CODE_NO_FREE_SESSION_ID = 6
- BrickRED.ERROR_CODE_UNKNOWN_OBJECT_ID = 7
- BrickRED.ERROR_CODE_NO_FREE_OBJECT_ID = 8
- BrickRED.ERROR_CODE_OBJECT_IS_LOCKED = 9
- BrickRED.ERROR_CODE_NO_MORE_DATA = 10
- BrickRED.ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
- BrickRED.ERROR_CODE_PROGRAM_IS_PURGED = 12
- BrickRED.ERROR_CODE_INVALID_PARAMETER = 128
- BrickRED.ERROR_CODE_NO_FREE_MEMORY = 129
- BrickRED.ERROR_CODE_NO_FREE_SPACE = 130
- BrickRED.ERROR_CODE_ACCESS_DENIED = 121
- BrickRED.ERROR_CODE_ALREADY_EXISTS = 132
- BrickRED.ERROR_CODE_DOES_NOT_EXIST = 133
- BrickRED.ERROR_CODE_INTERRUPTED = 134
- BrickRED.ERROR_CODE_IS_DIRECTORY = 135
- BrickRED.ERROR_CODE_NOT_A_DIRECTORY = 136
- BrickRED.ERROR_CODE_WOULD_BLOCK = 137
- BrickRED.ERROR_CODE_OVERFLOW = 138
- BrickRED.ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
- BrickRED.ERROR_CODE_OUT_OF_RANGE = 140
- BrickRED.ERROR_CODE_NAME_TOO_LONG = 141
- BrickRED.ERROR_CODE_INVALID_SEEK = 142
- BrickRED.ERROR_CODE_NOT_SUPPORTED = 143
- BrickRED.ERROR_CODE_TOO_MANY_OPEN_FILES = 144
The returned namedtuple has the variables error_code and names_list_id.
-
BrickRED.set_custom_program_option_value(program_id, name_string_id, value_string_id)
Parameters: |
- program_id -- int
- name_string_id -- int
- value_string_id -- int
|
Return type: | int
|
The following constants are available for this function:
- BrickRED.ERROR_CODE_SUCCESS = 0
- BrickRED.ERROR_CODE_UNKNOWN_ERROR = 1
- BrickRED.ERROR_CODE_INVALID_OPERATION = 2
- BrickRED.ERROR_CODE_OPERATION_ABORTED = 3
- BrickRED.ERROR_CODE_INTERNAL_ERROR = 4
- BrickRED.ERROR_CODE_UNKNOWN_SESSION_ID = 5
- BrickRED.ERROR_CODE_NO_FREE_SESSION_ID = 6
- BrickRED.ERROR_CODE_UNKNOWN_OBJECT_ID = 7
- BrickRED.ERROR_CODE_NO_FREE_OBJECT_ID = 8
- BrickRED.ERROR_CODE_OBJECT_IS_LOCKED = 9
- BrickRED.ERROR_CODE_NO_MORE_DATA = 10
- BrickRED.ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
- BrickRED.ERROR_CODE_PROGRAM_IS_PURGED = 12
- BrickRED.ERROR_CODE_INVALID_PARAMETER = 128
- BrickRED.ERROR_CODE_NO_FREE_MEMORY = 129
- BrickRED.ERROR_CODE_NO_FREE_SPACE = 130
- BrickRED.ERROR_CODE_ACCESS_DENIED = 121
- BrickRED.ERROR_CODE_ALREADY_EXISTS = 132
- BrickRED.ERROR_CODE_DOES_NOT_EXIST = 133
- BrickRED.ERROR_CODE_INTERRUPTED = 134
- BrickRED.ERROR_CODE_IS_DIRECTORY = 135
- BrickRED.ERROR_CODE_NOT_A_DIRECTORY = 136
- BrickRED.ERROR_CODE_WOULD_BLOCK = 137
- BrickRED.ERROR_CODE_OVERFLOW = 138
- BrickRED.ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
- BrickRED.ERROR_CODE_OUT_OF_RANGE = 140
- BrickRED.ERROR_CODE_NAME_TOO_LONG = 141
- BrickRED.ERROR_CODE_INVALID_SEEK = 142
- BrickRED.ERROR_CODE_NOT_SUPPORTED = 143
- BrickRED.ERROR_CODE_TOO_MANY_OPEN_FILES = 144
-
BrickRED.get_custom_program_option_value(program_id, name_string_id, session_id)
Parameters: |
- program_id -- int
- name_string_id -- int
- session_id -- int
|
Return type: | (int, int)
|
The following constants are available for this function:
- BrickRED.ERROR_CODE_SUCCESS = 0
- BrickRED.ERROR_CODE_UNKNOWN_ERROR = 1
- BrickRED.ERROR_CODE_INVALID_OPERATION = 2
- BrickRED.ERROR_CODE_OPERATION_ABORTED = 3
- BrickRED.ERROR_CODE_INTERNAL_ERROR = 4
- BrickRED.ERROR_CODE_UNKNOWN_SESSION_ID = 5
- BrickRED.ERROR_CODE_NO_FREE_SESSION_ID = 6
- BrickRED.ERROR_CODE_UNKNOWN_OBJECT_ID = 7
- BrickRED.ERROR_CODE_NO_FREE_OBJECT_ID = 8
- BrickRED.ERROR_CODE_OBJECT_IS_LOCKED = 9
- BrickRED.ERROR_CODE_NO_MORE_DATA = 10
- BrickRED.ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
- BrickRED.ERROR_CODE_PROGRAM_IS_PURGED = 12
- BrickRED.ERROR_CODE_INVALID_PARAMETER = 128
- BrickRED.ERROR_CODE_NO_FREE_MEMORY = 129
- BrickRED.ERROR_CODE_NO_FREE_SPACE = 130
- BrickRED.ERROR_CODE_ACCESS_DENIED = 121
- BrickRED.ERROR_CODE_ALREADY_EXISTS = 132
- BrickRED.ERROR_CODE_DOES_NOT_EXIST = 133
- BrickRED.ERROR_CODE_INTERRUPTED = 134
- BrickRED.ERROR_CODE_IS_DIRECTORY = 135
- BrickRED.ERROR_CODE_NOT_A_DIRECTORY = 136
- BrickRED.ERROR_CODE_WOULD_BLOCK = 137
- BrickRED.ERROR_CODE_OVERFLOW = 138
- BrickRED.ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
- BrickRED.ERROR_CODE_OUT_OF_RANGE = 140
- BrickRED.ERROR_CODE_NAME_TOO_LONG = 141
- BrickRED.ERROR_CODE_INVALID_SEEK = 142
- BrickRED.ERROR_CODE_NOT_SUPPORTED = 143
- BrickRED.ERROR_CODE_TOO_MANY_OPEN_FILES = 144
The returned namedtuple has the variables error_code and value_string_id.
-
BrickRED.remove_custom_program_option(program_id, name_string_id)
Parameters: |
- program_id -- int
- name_string_id -- int
|
Return type: | int
|
The following constants are available for this function:
- BrickRED.ERROR_CODE_SUCCESS = 0
- BrickRED.ERROR_CODE_UNKNOWN_ERROR = 1
- BrickRED.ERROR_CODE_INVALID_OPERATION = 2
- BrickRED.ERROR_CODE_OPERATION_ABORTED = 3
- BrickRED.ERROR_CODE_INTERNAL_ERROR = 4
- BrickRED.ERROR_CODE_UNKNOWN_SESSION_ID = 5
- BrickRED.ERROR_CODE_NO_FREE_SESSION_ID = 6
- BrickRED.ERROR_CODE_UNKNOWN_OBJECT_ID = 7
- BrickRED.ERROR_CODE_NO_FREE_OBJECT_ID = 8
- BrickRED.ERROR_CODE_OBJECT_IS_LOCKED = 9
- BrickRED.ERROR_CODE_NO_MORE_DATA = 10
- BrickRED.ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
- BrickRED.ERROR_CODE_PROGRAM_IS_PURGED = 12
- BrickRED.ERROR_CODE_INVALID_PARAMETER = 128
- BrickRED.ERROR_CODE_NO_FREE_MEMORY = 129
- BrickRED.ERROR_CODE_NO_FREE_SPACE = 130
- BrickRED.ERROR_CODE_ACCESS_DENIED = 121
- BrickRED.ERROR_CODE_ALREADY_EXISTS = 132
- BrickRED.ERROR_CODE_DOES_NOT_EXIST = 133
- BrickRED.ERROR_CODE_INTERRUPTED = 134
- BrickRED.ERROR_CODE_IS_DIRECTORY = 135
- BrickRED.ERROR_CODE_NOT_A_DIRECTORY = 136
- BrickRED.ERROR_CODE_WOULD_BLOCK = 137
- BrickRED.ERROR_CODE_OVERFLOW = 138
- BrickRED.ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
- BrickRED.ERROR_CODE_OUT_OF_RANGE = 140
- BrickRED.ERROR_CODE_NAME_TOO_LONG = 141
- BrickRED.ERROR_CODE_INVALID_SEEK = 142
- BrickRED.ERROR_CODE_NOT_SUPPORTED = 143
- BrickRED.ERROR_CODE_TOO_MANY_OPEN_FILES = 144
-
BrickRED.get_api_version()
Return type: | [int, int, int] |
Returns the version of the API definition (major, minor, revision) implemented
by this API bindings. This is neither the release version of this API bindings
nor does it tell you anything about the represented Brick or Bricklet.
-
BrickRED.get_response_expected(function_id)
Parameters: | function_id -- int |
Return type: | bool |
Returns the response expected flag for the function specified by the function
ID parameter. It is true if the function is expected to send a response,
false otherwise.
For getter functions this is enabled by default and cannot be disabled,
because those functions will always send a response. For callback configuration
functions it is enabled by default too, but can be disabled by
set_response_expected(). For setter functions it is disabled by default
and can be enabled.
Enabling the response expected flag for a setter function allows to detect
timeouts and other error conditions calls of this setter as well. The
device will then send a response for this purpose. If this flag is disabled for
a setter function then no response is send and errors are silently ignored,
because they cannot be detected.
See set_response_expected() for the list of function ID constants
available for this function.
-
BrickRED.set_response_expected(function_id, response_expected)
Parameters: |
- function_id -- int
- response_expected -- bool
|
Return type: | None
|
Changes the response expected flag of the function specified by the
function ID parameter. This flag can only be changed for setter (default value:
false) and callback configuration functions (default value: true). For
getter functions it is always enabled.
Enabling the response expected flag for a setter function allows to detect
timeouts and other error conditions calls of this setter as well. The
device will then send a response for this purpose. If this flag is disabled for
a setter function then no response is send and errors are silently ignored,
because they cannot be detected.
The following function ID constants are available for this function:
- BrickRED.FUNCTION_EXPIRE_SESSION_UNCHECKED = 3
- BrickRED.FUNCTION_RELEASE_OBJECT_UNCHECKED = 6
- BrickRED.FUNCTION_READ_FILE_ASYNC = 21
- BrickRED.FUNCTION_WRITE_FILE_UNCHECKED = 24
- BrickRED.FUNCTION_WRITE_FILE_ASYNC = 25
-
BrickRED.set_response_expected_all(response_expected)
Parameters: | response_expected -- bool |
Return type: | None |
Changes the response expected flag for all setter and callback configuration
functions of this device at once.
-
BrickRED.get_identity()
Return type: | (str, str, chr, [int, int, int], [int, int, int], int) |
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.
There is also a constant for the device identifier of this Brick.
The returned namedtuple has the variables uid, connected_uid, position, hardware_version, firmware_version and device_identifier.
Callback Configuration Functions
-
BrickRED.register_callback(callback_id, function)
Parameters: |
- callback_id -- int
- function -- callable
|
Return type: | None
|
Registers the given function with the given callback_id.
The available callback IDs with corresponding function signatures are listed
below.
Callbacks
Callbacks can be registered to receive
time critical or recurring data from the device. The registration is done
with the register_callback() function of
the device object. The first parameter is the callback ID and the second
parameter the callback function:
def my_callback(param):
print(param)
red.register_callback(BrickRED.CALLBACK_EXAMPLE, my_callback)
The available constants with inherent number and type of parameters are
described below.
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.
-
BrickRED.CALLBACK_ASYNC_FILE_READ
Parameters: |
- file_id -- int
- error_code -- int
- buffer -- [int, int, ..57x.., int]
- length_read -- int
|
This callback reports the result of a call to the read_file_async()
function.
The following constants are available for this function:
- BrickRED.ERROR_CODE_SUCCESS = 0
- BrickRED.ERROR_CODE_UNKNOWN_ERROR = 1
- BrickRED.ERROR_CODE_INVALID_OPERATION = 2
- BrickRED.ERROR_CODE_OPERATION_ABORTED = 3
- BrickRED.ERROR_CODE_INTERNAL_ERROR = 4
- BrickRED.ERROR_CODE_UNKNOWN_SESSION_ID = 5
- BrickRED.ERROR_CODE_NO_FREE_SESSION_ID = 6
- BrickRED.ERROR_CODE_UNKNOWN_OBJECT_ID = 7
- BrickRED.ERROR_CODE_NO_FREE_OBJECT_ID = 8
- BrickRED.ERROR_CODE_OBJECT_IS_LOCKED = 9
- BrickRED.ERROR_CODE_NO_MORE_DATA = 10
- BrickRED.ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
- BrickRED.ERROR_CODE_PROGRAM_IS_PURGED = 12
- BrickRED.ERROR_CODE_INVALID_PARAMETER = 128
- BrickRED.ERROR_CODE_NO_FREE_MEMORY = 129
- BrickRED.ERROR_CODE_NO_FREE_SPACE = 130
- BrickRED.ERROR_CODE_ACCESS_DENIED = 121
- BrickRED.ERROR_CODE_ALREADY_EXISTS = 132
- BrickRED.ERROR_CODE_DOES_NOT_EXIST = 133
- BrickRED.ERROR_CODE_INTERRUPTED = 134
- BrickRED.ERROR_CODE_IS_DIRECTORY = 135
- BrickRED.ERROR_CODE_NOT_A_DIRECTORY = 136
- BrickRED.ERROR_CODE_WOULD_BLOCK = 137
- BrickRED.ERROR_CODE_OVERFLOW = 138
- BrickRED.ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
- BrickRED.ERROR_CODE_OUT_OF_RANGE = 140
- BrickRED.ERROR_CODE_NAME_TOO_LONG = 141
- BrickRED.ERROR_CODE_INVALID_SEEK = 142
- BrickRED.ERROR_CODE_NOT_SUPPORTED = 143
- BrickRED.ERROR_CODE_TOO_MANY_OPEN_FILES = 144
-
BrickRED.CALLBACK_ASYNC_FILE_WRITE
Parameters: |
- file_id -- int
- error_code -- int
- length_written -- int
|
This callback reports the result of a call to the write_file_async()
function.
The following constants are available for this function:
- BrickRED.ERROR_CODE_SUCCESS = 0
- BrickRED.ERROR_CODE_UNKNOWN_ERROR = 1
- BrickRED.ERROR_CODE_INVALID_OPERATION = 2
- BrickRED.ERROR_CODE_OPERATION_ABORTED = 3
- BrickRED.ERROR_CODE_INTERNAL_ERROR = 4
- BrickRED.ERROR_CODE_UNKNOWN_SESSION_ID = 5
- BrickRED.ERROR_CODE_NO_FREE_SESSION_ID = 6
- BrickRED.ERROR_CODE_UNKNOWN_OBJECT_ID = 7
- BrickRED.ERROR_CODE_NO_FREE_OBJECT_ID = 8
- BrickRED.ERROR_CODE_OBJECT_IS_LOCKED = 9
- BrickRED.ERROR_CODE_NO_MORE_DATA = 10
- BrickRED.ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
- BrickRED.ERROR_CODE_PROGRAM_IS_PURGED = 12
- BrickRED.ERROR_CODE_INVALID_PARAMETER = 128
- BrickRED.ERROR_CODE_NO_FREE_MEMORY = 129
- BrickRED.ERROR_CODE_NO_FREE_SPACE = 130
- BrickRED.ERROR_CODE_ACCESS_DENIED = 121
- BrickRED.ERROR_CODE_ALREADY_EXISTS = 132
- BrickRED.ERROR_CODE_DOES_NOT_EXIST = 133
- BrickRED.ERROR_CODE_INTERRUPTED = 134
- BrickRED.ERROR_CODE_IS_DIRECTORY = 135
- BrickRED.ERROR_CODE_NOT_A_DIRECTORY = 136
- BrickRED.ERROR_CODE_WOULD_BLOCK = 137
- BrickRED.ERROR_CODE_OVERFLOW = 138
- BrickRED.ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
- BrickRED.ERROR_CODE_OUT_OF_RANGE = 140
- BrickRED.ERROR_CODE_NAME_TOO_LONG = 141
- BrickRED.ERROR_CODE_INVALID_SEEK = 142
- BrickRED.ERROR_CODE_NOT_SUPPORTED = 143
- BrickRED.ERROR_CODE_TOO_MANY_OPEN_FILES = 144
-
BrickRED.CALLBACK_FILE_EVENTS_OCCURRED
Parameters: |
- file_id -- int
- events -- int
|
The following constants are available for this function:
- BrickRED.FILE_EVENT_READABLE = 1
- BrickRED.FILE_EVENT_WRITABLE = 2
-
BrickRED.CALLBACK_PROCESS_STATE_CHANGED
Parameters: |
- process_id -- int
- state -- int
- timestamp -- int
- exit_code -- int
|
The following constants are available for this function:
- BrickRED.PROCESS_STATE_UNKNOWN = 0
- BrickRED.PROCESS_STATE_RUNNING = 1
- BrickRED.PROCESS_STATE_ERROR = 2
- BrickRED.PROCESS_STATE_EXITED = 3
- BrickRED.PROCESS_STATE_KILLED = 4
- BrickRED.PROCESS_STATE_STOPPED = 5
-
BrickRED.CALLBACK_PROGRAM_SCHEDULER_STATE_CHANGED
Parameters: | program_id -- int |
-
BrickRED.CALLBACK_PROGRAM_PROCESS_SPAWNED
Parameters: | program_id -- int |
Constants
-
BrickRED.DEVICE_IDENTIFIER
This constant is used to identify a RED Brick.
The get_identity() function and the
CALLBACK_ENUMERATE
callback of the IP Connection have a device_identifier parameter to specify
the Brick's or Bricklet's type.
-
BrickRED.DEVICE_DISPLAY_NAME
This constant represents the human readable name of a RED Brick.