MQTT - RED Brick¶

Dies ist die Beschreibung der MQTT API Bindings für den RED Brick. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des RED Brick sind in dessen Hardware Beschreibung zusammengefasst.

Eine Installationanleitung für die MQTT API Bindings ist Teil deren allgemeine Beschreibung.

API¶

Alle veröffentlichten Payloads an die und von den MQTT-Bindings sind im JSON Format.

Falls ein Fehler auftritt, veröffentlichen die Bindings ein JSON-Objekt, das die Fehlermeldung als _ERROR-Member enthält. Das Objekt wird auf dem zugehörigen Antwort-Topic veröffentlicht: .../response/... für .../request/... und .../callback/... für .../register/....

Bemerkung

Die API Dokumentation für den RED Brick ist noch nicht vollständig.

Fortgeschrittene Funktionen¶

request/red_brick/<UID>/create_session¶

Anfrage:	lifetime – Typ: int, Wertebereich: [0 bis 2³² - 1]
Antwort:	error_code – Typ: int, Wertebereich: Siehe Symbole session_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]

Die folgenden Symbole sind für diese Funktion verfügbar:

Für error_code:

"success" = 0
"unknown_error" = 1
"invalid_operation" = 2
"operation_aborted" = 3
"internal_error" = 4
"unknown_session_id" = 5
"no_free_session_id" = 6
"unknown_object_id" = 7
"no_free_object_id" = 8
"object_is_locked" = 9
"no_more_data" = 10
"wrong_list_item_type" = 11
"program_is_purged" = 12
"invalid_parameter" = 128
"no_free_memory" = 129
"no_free_space" = 130
"access_denied" = 121
"already_exists" = 132
"does_not_exist" = 133
"interrupted" = 134
"is_directory" = 135
"not_a_directory" = 136
"would_block" = 137
"overflow" = 138
"bad_file_descriptor" = 139
"out_of_range" = 140
"name_too_long" = 141
"invalid_seek" = 142
"not_supported" = 143
"too_many_open_files" = 144

request/red_brick/<UID>/expire_session¶

Anfrage:	session_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]
Antwort:	error_code – Typ: int, Wertebereich: Siehe Symbole

Die folgenden Symbole sind für diese Funktion verfügbar:

Für error_code:

"success" = 0
"unknown_error" = 1
"invalid_operation" = 2
"operation_aborted" = 3
"internal_error" = 4
"unknown_session_id" = 5
"no_free_session_id" = 6
"unknown_object_id" = 7
"no_free_object_id" = 8
"object_is_locked" = 9
"no_more_data" = 10
"wrong_list_item_type" = 11
"program_is_purged" = 12
"invalid_parameter" = 128
"no_free_memory" = 129
"no_free_space" = 130
"access_denied" = 121
"already_exists" = 132
"does_not_exist" = 133
"interrupted" = 134
"is_directory" = 135
"not_a_directory" = 136
"would_block" = 137
"overflow" = 138
"bad_file_descriptor" = 139
"out_of_range" = 140
"name_too_long" = 141
"invalid_seek" = 142
"not_supported" = 143
"too_many_open_files" = 144

request/red_brick/<UID>/expire_session_unchecked¶

Anfrage:	session_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]
Antwort:	keine Antwort

request/red_brick/<UID>/keep_session_alive¶

Anfrage:	session_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] lifetime – Typ: int, Wertebereich: [0 bis 2³² - 1]
Antwort:	error_code – Typ: int, Wertebereich: Siehe Symbole

Die folgenden Symbole sind für diese Funktion verfügbar:

Für error_code:

"success" = 0
"unknown_error" = 1
"invalid_operation" = 2
"operation_aborted" = 3
"internal_error" = 4
"unknown_session_id" = 5
"no_free_session_id" = 6
"unknown_object_id" = 7
"no_free_object_id" = 8
"object_is_locked" = 9
"no_more_data" = 10
"wrong_list_item_type" = 11
"program_is_purged" = 12
"invalid_parameter" = 128
"no_free_memory" = 129
"no_free_space" = 130
"access_denied" = 121
"already_exists" = 132
"does_not_exist" = 133
"interrupted" = 134
"is_directory" = 135
"not_a_directory" = 136
"would_block" = 137
"overflow" = 138
"bad_file_descriptor" = 139
"out_of_range" = 140
"name_too_long" = 141
"invalid_seek" = 142
"not_supported" = 143
"too_many_open_files" = 144

request/red_brick/<UID>/release_object¶

Anfrage:	object_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] session_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]
Antwort:	error_code – Typ: int, Wertebereich: Siehe Symbole

Die folgenden Symbole sind für diese Funktion verfügbar:

Für error_code:

"success" = 0
"unknown_error" = 1
"invalid_operation" = 2
"operation_aborted" = 3
"internal_error" = 4
"unknown_session_id" = 5
"no_free_session_id" = 6
"unknown_object_id" = 7
"no_free_object_id" = 8
"object_is_locked" = 9
"no_more_data" = 10
"wrong_list_item_type" = 11
"program_is_purged" = 12
"invalid_parameter" = 128
"no_free_memory" = 129
"no_free_space" = 130
"access_denied" = 121
"already_exists" = 132
"does_not_exist" = 133
"interrupted" = 134
"is_directory" = 135
"not_a_directory" = 136
"would_block" = 137
"overflow" = 138
"bad_file_descriptor" = 139
"out_of_range" = 140
"name_too_long" = 141
"invalid_seek" = 142
"not_supported" = 143
"too_many_open_files" = 144

request/red_brick/<UID>/release_object_unchecked¶

Anfrage:	object_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] session_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]
Antwort:	keine Antwort

request/red_brick/<UID>/allocate_string¶

Anfrage:	length_to_reserve – Typ: int, Einheit: 1 B, Wertebereich: [0 bis 2³² - 1] buffer – Typ: string, Länge: bis zu 58 session_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]
Antwort:	error_code – Typ: int, Wertebereich: Siehe Symbole string_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]

Die folgenden Symbole sind für diese Funktion verfügbar:

Für error_code:

"success" = 0
"unknown_error" = 1
"invalid_operation" = 2
"operation_aborted" = 3
"internal_error" = 4
"unknown_session_id" = 5
"no_free_session_id" = 6
"unknown_object_id" = 7
"no_free_object_id" = 8
"object_is_locked" = 9
"no_more_data" = 10
"wrong_list_item_type" = 11
"program_is_purged" = 12
"invalid_parameter" = 128
"no_free_memory" = 129
"no_free_space" = 130
"access_denied" = 121
"already_exists" = 132
"does_not_exist" = 133
"interrupted" = 134
"is_directory" = 135
"not_a_directory" = 136
"would_block" = 137
"overflow" = 138
"bad_file_descriptor" = 139
"out_of_range" = 140
"name_too_long" = 141
"invalid_seek" = 142
"not_supported" = 143
"too_many_open_files" = 144

request/red_brick/<UID>/truncate_string¶

Anfrage:	string_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] length – Typ: int, Einheit: 1 B, Wertebereich: [0 bis 2³² - 1]
Antwort:	error_code – Typ: int, Wertebereich: Siehe Symbole

Die folgenden Symbole sind für diese Funktion verfügbar:

Für error_code:

"success" = 0
"unknown_error" = 1
"invalid_operation" = 2
"operation_aborted" = 3
"internal_error" = 4
"unknown_session_id" = 5
"no_free_session_id" = 6
"unknown_object_id" = 7
"no_free_object_id" = 8
"object_is_locked" = 9
"no_more_data" = 10
"wrong_list_item_type" = 11
"program_is_purged" = 12
"invalid_parameter" = 128
"no_free_memory" = 129
"no_free_space" = 130
"access_denied" = 121
"already_exists" = 132
"does_not_exist" = 133
"interrupted" = 134
"is_directory" = 135
"not_a_directory" = 136
"would_block" = 137
"overflow" = 138
"bad_file_descriptor" = 139
"out_of_range" = 140
"name_too_long" = 141
"invalid_seek" = 142
"not_supported" = 143
"too_many_open_files" = 144

request/red_brick/<UID>/get_string_length¶

Anfrage:	string_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]
Antwort:	error_code – Typ: int, Wertebereich: Siehe Symbole length – Typ: int, Einheit: 1 B, Wertebereich: [0 bis 2³² - 1]

Die folgenden Symbole sind für diese Funktion verfügbar:

Für error_code:

"success" = 0
"unknown_error" = 1
"invalid_operation" = 2
"operation_aborted" = 3
"internal_error" = 4
"unknown_session_id" = 5
"no_free_session_id" = 6
"unknown_object_id" = 7
"no_free_object_id" = 8
"object_is_locked" = 9
"no_more_data" = 10
"wrong_list_item_type" = 11
"program_is_purged" = 12
"invalid_parameter" = 128
"no_free_memory" = 129
"no_free_space" = 130
"access_denied" = 121
"already_exists" = 132
"does_not_exist" = 133
"interrupted" = 134
"is_directory" = 135
"not_a_directory" = 136
"would_block" = 137
"overflow" = 138
"bad_file_descriptor" = 139
"out_of_range" = 140
"name_too_long" = 141
"invalid_seek" = 142
"not_supported" = 143
"too_many_open_files" = 144

request/red_brick/<UID>/set_string_chunk¶

Anfrage:	string_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] offset – Typ: int, Einheit: 1 B, Wertebereich: [0 bis 2³² - 1] buffer – Typ: string, Länge: bis zu 58
Antwort:	error_code – Typ: int, Wertebereich: Siehe Symbole

Die folgenden Symbole sind für diese Funktion verfügbar:

Für error_code:

"success" = 0
"unknown_error" = 1
"invalid_operation" = 2
"operation_aborted" = 3
"internal_error" = 4
"unknown_session_id" = 5
"no_free_session_id" = 6
"unknown_object_id" = 7
"no_free_object_id" = 8
"object_is_locked" = 9
"no_more_data" = 10
"wrong_list_item_type" = 11
"program_is_purged" = 12
"invalid_parameter" = 128
"no_free_memory" = 129
"no_free_space" = 130
"access_denied" = 121
"already_exists" = 132
"does_not_exist" = 133
"interrupted" = 134
"is_directory" = 135
"not_a_directory" = 136
"would_block" = 137
"overflow" = 138
"bad_file_descriptor" = 139
"out_of_range" = 140
"name_too_long" = 141
"invalid_seek" = 142
"not_supported" = 143
"too_many_open_files" = 144

request/red_brick/<UID>/get_string_chunk¶

Anfrage:	string_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] offset – Typ: int, Einheit: 1 B, Wertebereich: [0 bis 2³² - 1]
Antwort:	error_code – Typ: int, Wertebereich: Siehe Symbole buffer – Typ: string, Länge: bis zu 63

Die folgenden Symbole sind für diese Funktion verfügbar:

Für error_code:

"success" = 0
"unknown_error" = 1
"invalid_operation" = 2
"operation_aborted" = 3
"internal_error" = 4
"unknown_session_id" = 5
"no_free_session_id" = 6
"unknown_object_id" = 7
"no_free_object_id" = 8
"object_is_locked" = 9
"no_more_data" = 10
"wrong_list_item_type" = 11
"program_is_purged" = 12
"invalid_parameter" = 128
"no_free_memory" = 129
"no_free_space" = 130
"access_denied" = 121
"already_exists" = 132
"does_not_exist" = 133
"interrupted" = 134
"is_directory" = 135
"not_a_directory" = 136
"would_block" = 137
"overflow" = 138
"bad_file_descriptor" = 139
"out_of_range" = 140
"name_too_long" = 141
"invalid_seek" = 142
"not_supported" = 143
"too_many_open_files" = 144

request/red_brick/<UID>/allocate_list¶

Anfrage:	length_to_reserve – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] session_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]
Antwort:	error_code – Typ: int, Wertebereich: Siehe Symbole list_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]

Die folgenden Symbole sind für diese Funktion verfügbar:

Für error_code:

"success" = 0
"unknown_error" = 1
"invalid_operation" = 2
"operation_aborted" = 3
"internal_error" = 4
"unknown_session_id" = 5
"no_free_session_id" = 6
"unknown_object_id" = 7
"no_free_object_id" = 8
"object_is_locked" = 9
"no_more_data" = 10
"wrong_list_item_type" = 11
"program_is_purged" = 12
"invalid_parameter" = 128
"no_free_memory" = 129
"no_free_space" = 130
"access_denied" = 121
"already_exists" = 132
"does_not_exist" = 133
"interrupted" = 134
"is_directory" = 135
"not_a_directory" = 136
"would_block" = 137
"overflow" = 138
"bad_file_descriptor" = 139
"out_of_range" = 140
"name_too_long" = 141
"invalid_seek" = 142
"not_supported" = 143
"too_many_open_files" = 144

request/red_brick/<UID>/get_list_length¶

Anfrage:	list_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]
Antwort:	error_code – Typ: int, Wertebereich: Siehe Symbole length – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]

Die folgenden Symbole sind für diese Funktion verfügbar:

Für error_code:

"success" = 0
"unknown_error" = 1
"invalid_operation" = 2
"operation_aborted" = 3
"internal_error" = 4
"unknown_session_id" = 5
"no_free_session_id" = 6
"unknown_object_id" = 7
"no_free_object_id" = 8
"object_is_locked" = 9
"no_more_data" = 10
"wrong_list_item_type" = 11
"program_is_purged" = 12
"invalid_parameter" = 128
"no_free_memory" = 129
"no_free_space" = 130
"access_denied" = 121
"already_exists" = 132
"does_not_exist" = 133
"interrupted" = 134
"is_directory" = 135
"not_a_directory" = 136
"would_block" = 137
"overflow" = 138
"bad_file_descriptor" = 139
"out_of_range" = 140
"name_too_long" = 141
"invalid_seek" = 142
"not_supported" = 143
"too_many_open_files" = 144

request/red_brick/<UID>/get_list_item¶

Anfrage:	list_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] index – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] session_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]
Antwort:	error_code – Typ: int, Wertebereich: Siehe Symbole item_object_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] type – Typ: int, Wertebereich: Siehe Symbole

Die folgenden Symbole sind für diese Funktion verfügbar:

Für error_code:

"success" = 0
"unknown_error" = 1
"invalid_operation" = 2
"operation_aborted" = 3
"internal_error" = 4
"unknown_session_id" = 5
"no_free_session_id" = 6
"unknown_object_id" = 7
"no_free_object_id" = 8
"object_is_locked" = 9
"no_more_data" = 10
"wrong_list_item_type" = 11
"program_is_purged" = 12
"invalid_parameter" = 128
"no_free_memory" = 129
"no_free_space" = 130
"access_denied" = 121
"already_exists" = 132
"does_not_exist" = 133
"interrupted" = 134
"is_directory" = 135
"not_a_directory" = 136
"would_block" = 137
"overflow" = 138
"bad_file_descriptor" = 139
"out_of_range" = 140
"name_too_long" = 141
"invalid_seek" = 142
"not_supported" = 143
"too_many_open_files" = 144

Für type:

"string" = 0
"list" = 1
"file" = 2
"directory" = 3
"process" = 4
"program" = 5

request/red_brick/<UID>/append_to_list¶

Anfrage:	list_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] item_object_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]
Antwort:	error_code – Typ: int, Wertebereich: Siehe Symbole

Die folgenden Symbole sind für diese Funktion verfügbar:

Für error_code:

"success" = 0
"unknown_error" = 1
"invalid_operation" = 2
"operation_aborted" = 3
"internal_error" = 4
"unknown_session_id" = 5
"no_free_session_id" = 6
"unknown_object_id" = 7
"no_free_object_id" = 8
"object_is_locked" = 9
"no_more_data" = 10
"wrong_list_item_type" = 11
"program_is_purged" = 12
"invalid_parameter" = 128
"no_free_memory" = 129
"no_free_space" = 130
"access_denied" = 121
"already_exists" = 132
"does_not_exist" = 133
"interrupted" = 134
"is_directory" = 135
"not_a_directory" = 136
"would_block" = 137
"overflow" = 138
"bad_file_descriptor" = 139
"out_of_range" = 140
"name_too_long" = 141
"invalid_seek" = 142
"not_supported" = 143
"too_many_open_files" = 144

request/red_brick/<UID>/remove_from_list¶

Anfrage:	list_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] index – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]
Antwort:	error_code – Typ: int, Wertebereich: Siehe Symbole

Die folgenden Symbole sind für diese Funktion verfügbar:

Für error_code:

"success" = 0
"unknown_error" = 1
"invalid_operation" = 2
"operation_aborted" = 3
"internal_error" = 4
"unknown_session_id" = 5
"no_free_session_id" = 6
"unknown_object_id" = 7
"no_free_object_id" = 8
"object_is_locked" = 9
"no_more_data" = 10
"wrong_list_item_type" = 11
"program_is_purged" = 12
"invalid_parameter" = 128
"no_free_memory" = 129
"no_free_space" = 130
"access_denied" = 121
"already_exists" = 132
"does_not_exist" = 133
"interrupted" = 134
"is_directory" = 135
"not_a_directory" = 136
"would_block" = 137
"overflow" = 138
"bad_file_descriptor" = 139
"out_of_range" = 140
"name_too_long" = 141
"invalid_seek" = 142
"not_supported" = 143
"too_many_open_files" = 144

request/red_brick/<UID>/open_file¶

Anfrage:	name_string_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] flags – Typ: int, Wertebereich: Siehe Symbole permissions – Typ: int, Wertebereich: Siehe Symbole uid – Typ: int, Wertebereich: [0 bis 2³² - 1] gid – Typ: int, Wertebereich: [0 bis 2³² - 1] session_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]
Antwort:	error_code – Typ: int, Wertebereich: Siehe Symbole file_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]

Die folgenden Symbole sind für diese Funktion verfügbar:

Für flags:

"read_only" = 1
"write_only" = 2
"read_write" = 4
"append" = 8
"create" = 16
"exclusive" = 32
"non_blocking" = 64
"truncate" = 128
"temporary" = 256
"replace" = 512

Für permissions:

"user_all" = 448
"user_read" = 256
"user_write" = 128
"user_execute" = 64
"group_all" = 56
"group_read" = 32
"group_write" = 16
"group_execute" = 8
"others_all" = 7
"others_read" = 4
"others_write" = 2
"others_execute" = 1

Für error_code:

"success" = 0
"unknown_error" = 1
"invalid_operation" = 2
"operation_aborted" = 3
"internal_error" = 4
"unknown_session_id" = 5
"no_free_session_id" = 6
"unknown_object_id" = 7
"no_free_object_id" = 8
"object_is_locked" = 9
"no_more_data" = 10
"wrong_list_item_type" = 11
"program_is_purged" = 12
"invalid_parameter" = 128
"no_free_memory" = 129
"no_free_space" = 130
"access_denied" = 121
"already_exists" = 132
"does_not_exist" = 133
"interrupted" = 134
"is_directory" = 135
"not_a_directory" = 136
"would_block" = 137
"overflow" = 138
"bad_file_descriptor" = 139
"out_of_range" = 140
"name_too_long" = 141
"invalid_seek" = 142
"not_supported" = 143
"too_many_open_files" = 144

request/red_brick/<UID>/create_pipe¶

Anfrage:	flags – Typ: int, Wertebereich: Siehe Symbole length – Typ: int, Einheit: 1 B, Wertebereich: [0 bis 2⁶⁴ - 1] session_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]
Antwort:	error_code – Typ: int, Wertebereich: Siehe Symbole file_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]

Die folgenden Symbole sind für diese Funktion verfügbar:

Für flags:

"non_blocking_read" = 1
"non_blocking_write" = 2

Für error_code:

"success" = 0
"unknown_error" = 1
"invalid_operation" = 2
"operation_aborted" = 3
"internal_error" = 4
"unknown_session_id" = 5
"no_free_session_id" = 6
"unknown_object_id" = 7
"no_free_object_id" = 8
"object_is_locked" = 9
"no_more_data" = 10
"wrong_list_item_type" = 11
"program_is_purged" = 12
"invalid_parameter" = 128
"no_free_memory" = 129
"no_free_space" = 130
"access_denied" = 121
"already_exists" = 132
"does_not_exist" = 133
"interrupted" = 134
"is_directory" = 135
"not_a_directory" = 136
"would_block" = 137
"overflow" = 138
"bad_file_descriptor" = 139
"out_of_range" = 140
"name_too_long" = 141
"invalid_seek" = 142
"not_supported" = 143
"too_many_open_files" = 144

request/red_brick/<UID>/get_file_info¶

Anfrage:

Anfrage:	file_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] session_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]
Antwort:	error_code – Typ: int, Wertebereich: Siehe Symbole type – Typ: int, Wertebereich: Siehe Symbole name_string_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] flags – Typ: int, Wertebereich: Siehe Symbole permissions – Typ: int, Wertebereich: Siehe Symbole uid – Typ: int, Wertebereich: [0 bis 2³² - 1] gid – Typ: int, Wertebereich: [0 bis 2³² - 1] length – Typ: int, Einheit: 1 B, Wertebereich: [0 bis 2⁶⁴ - 1] access_timestamp – Typ: int, Wertebereich: [0 bis 2⁶⁴ - 1] modification_timestamp – Typ: int, Wertebereich: [0 bis 2⁶⁴ - 1] status_change_timestamp – Typ: int, Wertebereich: [0 bis 2⁶⁴ - 1]

file_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]
session_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]

Antwort:

error_code – Typ: int, Wertebereich: Siehe Symbole
type – Typ: int, Wertebereich: Siehe Symbole
name_string_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]
flags – Typ: int, Wertebereich: Siehe Symbole
permissions – Typ: int, Wertebereich: Siehe Symbole
uid – Typ: int, Wertebereich: [0 bis 2³² - 1]
gid – Typ: int, Wertebereich: [0 bis 2³² - 1]
length – Typ: int, Einheit: 1 B, Wertebereich: [0 bis 2⁶⁴ - 1]
access_timestamp – Typ: int, Wertebereich: [0 bis 2⁶⁴ - 1]
modification_timestamp – Typ: int, Wertebereich: [0 bis 2⁶⁴ - 1]
status_change_timestamp – Typ: int, Wertebereich: [0 bis 2⁶⁴ - 1]

Die folgenden Symbole sind für diese Funktion verfügbar:

Für error_code:

"success" = 0
"unknown_error" = 1
"invalid_operation" = 2
"operation_aborted" = 3
"internal_error" = 4
"unknown_session_id" = 5
"no_free_session_id" = 6
"unknown_object_id" = 7
"no_free_object_id" = 8
"object_is_locked" = 9
"no_more_data" = 10
"wrong_list_item_type" = 11
"program_is_purged" = 12
"invalid_parameter" = 128
"no_free_memory" = 129
"no_free_space" = 130
"access_denied" = 121
"already_exists" = 132
"does_not_exist" = 133
"interrupted" = 134
"is_directory" = 135
"not_a_directory" = 136
"would_block" = 137
"overflow" = 138
"bad_file_descriptor" = 139
"out_of_range" = 140
"name_too_long" = 141
"invalid_seek" = 142
"not_supported" = 143
"too_many_open_files" = 144

Für type:

"unknown" = 0
"regular" = 1
"directory" = 2
"character" = 3
"block" = 4
"fifo" = 5
"symlink" = 6
"socket" = 7
"pipe" = 8

Für flags:

"read_only" = 1
"write_only" = 2
"read_write" = 4
"append" = 8
"create" = 16
"exclusive" = 32
"non_blocking" = 64
"truncate" = 128
"temporary" = 256
"replace" = 512

Für permissions:

"user_all" = 448
"user_read" = 256
"user_write" = 128
"user_execute" = 64
"group_all" = 56
"group_read" = 32
"group_write" = 16
"group_execute" = 8
"others_all" = 7
"others_read" = 4
"others_write" = 2
"others_execute" = 1

request/red_brick/<UID>/read_file¶

Anfrage:	file_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] length_to_read – Typ: int, Einheit: 1 B, Wertebereich: [0 bis 255]
Antwort:	error_code – Typ: int, Wertebereich: Siehe Symbole buffer – Typ: [int, ...], Länge: 62, Wertebereich: [0 bis 255] length_read – Typ: int, Einheit: 1 B, Wertebereich: [0 bis 255]

Die folgenden Symbole sind für diese Funktion verfügbar:

Für error_code:

"success" = 0
"unknown_error" = 1
"invalid_operation" = 2
"operation_aborted" = 3
"internal_error" = 4
"unknown_session_id" = 5
"no_free_session_id" = 6
"unknown_object_id" = 7
"no_free_object_id" = 8
"object_is_locked" = 9
"no_more_data" = 10
"wrong_list_item_type" = 11
"program_is_purged" = 12
"invalid_parameter" = 128
"no_free_memory" = 129
"no_free_space" = 130
"access_denied" = 121
"already_exists" = 132
"does_not_exist" = 133
"interrupted" = 134
"is_directory" = 135
"not_a_directory" = 136
"would_block" = 137
"overflow" = 138
"bad_file_descriptor" = 139
"out_of_range" = 140
"name_too_long" = 141
"invalid_seek" = 142
"not_supported" = 143
"too_many_open_files" = 144

request/red_brick/<UID>/read_file_async¶

Anfrage:	file_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] length_to_read – Typ: int, Einheit: 1 B, Wertebereich: [0 bis 2⁶⁴ - 1]
Antwort:	keine Antwort

request/red_brick/<UID>/abort_async_file_read¶

Anfrage:	file_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]
Antwort:	error_code – Typ: int, Wertebereich: Siehe Symbole

Die folgenden Symbole sind für diese Funktion verfügbar:

Für error_code:

"success" = 0
"unknown_error" = 1
"invalid_operation" = 2
"operation_aborted" = 3
"internal_error" = 4
"unknown_session_id" = 5
"no_free_session_id" = 6
"unknown_object_id" = 7
"no_free_object_id" = 8
"object_is_locked" = 9
"no_more_data" = 10
"wrong_list_item_type" = 11
"program_is_purged" = 12
"invalid_parameter" = 128
"no_free_memory" = 129
"no_free_space" = 130
"access_denied" = 121
"already_exists" = 132
"does_not_exist" = 133
"interrupted" = 134
"is_directory" = 135
"not_a_directory" = 136
"would_block" = 137
"overflow" = 138
"bad_file_descriptor" = 139
"out_of_range" = 140
"name_too_long" = 141
"invalid_seek" = 142
"not_supported" = 143
"too_many_open_files" = 144

request/red_brick/<UID>/write_file¶

Anfrage:	file_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] buffer – Typ: [int, ...], Länge: 61, Wertebereich: [0 bis 255] length_to_write – Typ: int, Einheit: 1 B, Wertebereich: [0 bis 255]
Antwort:	error_code – Typ: int, Wertebereich: Siehe Symbole length_written – Typ: int, Einheit: 1 B, Wertebereich: [0 bis 255]

Die folgenden Symbole sind für diese Funktion verfügbar:

Für error_code:

"success" = 0
"unknown_error" = 1
"invalid_operation" = 2
"operation_aborted" = 3
"internal_error" = 4
"unknown_session_id" = 5
"no_free_session_id" = 6
"unknown_object_id" = 7
"no_free_object_id" = 8
"object_is_locked" = 9
"no_more_data" = 10
"wrong_list_item_type" = 11
"program_is_purged" = 12
"invalid_parameter" = 128
"no_free_memory" = 129
"no_free_space" = 130
"access_denied" = 121
"already_exists" = 132
"does_not_exist" = 133
"interrupted" = 134
"is_directory" = 135
"not_a_directory" = 136
"would_block" = 137
"overflow" = 138
"bad_file_descriptor" = 139
"out_of_range" = 140
"name_too_long" = 141
"invalid_seek" = 142
"not_supported" = 143
"too_many_open_files" = 144

request/red_brick/<UID>/write_file_unchecked¶

Anfrage:	file_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] buffer – Typ: [int, ...], Länge: 61, Wertebereich: [0 bis 255] length_to_write – Typ: int, Einheit: 1 B, Wertebereich: [0 bis 255]
Antwort:	keine Antwort

request/red_brick/<UID>/write_file_async¶

Anfrage:	file_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] buffer – Typ: [int, ...], Länge: 61, Wertebereich: [0 bis 255] length_to_write – Typ: int, Einheit: 1 B, Wertebereich: [0 bis 255]
Antwort:	keine Antwort

request/red_brick/<UID>/set_file_position¶

Anfrage:	file_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] offset – Typ: int, Einheit: 1 B, Wertebereich: [-2⁶³ bis 2⁶³ - 1] origin – Typ: int, Wertebereich: Siehe Symbole
Antwort:	error_code – Typ: int, Wertebereich: Siehe Symbole position – Typ: int, Einheit: 1 B, Wertebereich: [0 bis 2⁶⁴ - 1]

Die folgenden Symbole sind für diese Funktion verfügbar:

Für origin:

"beginning" = 0
"current" = 1
"end" = 2

Für error_code:

"success" = 0
"unknown_error" = 1
"invalid_operation" = 2
"operation_aborted" = 3
"internal_error" = 4
"unknown_session_id" = 5
"no_free_session_id" = 6
"unknown_object_id" = 7
"no_free_object_id" = 8
"object_is_locked" = 9
"no_more_data" = 10
"wrong_list_item_type" = 11
"program_is_purged" = 12
"invalid_parameter" = 128
"no_free_memory" = 129
"no_free_space" = 130
"access_denied" = 121
"already_exists" = 132
"does_not_exist" = 133
"interrupted" = 134
"is_directory" = 135
"not_a_directory" = 136
"would_block" = 137
"overflow" = 138
"bad_file_descriptor" = 139
"out_of_range" = 140
"name_too_long" = 141
"invalid_seek" = 142
"not_supported" = 143
"too_many_open_files" = 144

request/red_brick/<UID>/get_file_position¶

Anfrage:	file_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]
Antwort:	error_code – Typ: int, Wertebereich: Siehe Symbole position – Typ: int, Einheit: 1 B, Wertebereich: [0 bis 2⁶⁴ - 1]

Die folgenden Symbole sind für diese Funktion verfügbar:

Für error_code:

"success" = 0
"unknown_error" = 1
"invalid_operation" = 2
"operation_aborted" = 3
"internal_error" = 4
"unknown_session_id" = 5
"no_free_session_id" = 6
"unknown_object_id" = 7
"no_free_object_id" = 8
"object_is_locked" = 9
"no_more_data" = 10
"wrong_list_item_type" = 11
"program_is_purged" = 12
"invalid_parameter" = 128
"no_free_memory" = 129
"no_free_space" = 130
"access_denied" = 121
"already_exists" = 132
"does_not_exist" = 133
"interrupted" = 134
"is_directory" = 135
"not_a_directory" = 136
"would_block" = 137
"overflow" = 138
"bad_file_descriptor" = 139
"out_of_range" = 140
"name_too_long" = 141
"invalid_seek" = 142
"not_supported" = 143
"too_many_open_files" = 144

request/red_brick/<UID>/set_file_events¶

Anfrage:	file_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] events – Typ: int, Wertebereich: Siehe Symbole
Antwort:	error_code – Typ: int, Wertebereich: Siehe Symbole

Die folgenden Symbole sind für diese Funktion verfügbar:

Für events:

"readable" = 1
"writable" = 2

Für error_code:

"success" = 0
"unknown_error" = 1
"invalid_operation" = 2
"operation_aborted" = 3
"internal_error" = 4
"unknown_session_id" = 5
"no_free_session_id" = 6
"unknown_object_id" = 7
"no_free_object_id" = 8
"object_is_locked" = 9
"no_more_data" = 10
"wrong_list_item_type" = 11
"program_is_purged" = 12
"invalid_parameter" = 128
"no_free_memory" = 129
"no_free_space" = 130
"access_denied" = 121
"already_exists" = 132
"does_not_exist" = 133
"interrupted" = 134
"is_directory" = 135
"not_a_directory" = 136
"would_block" = 137
"overflow" = 138
"bad_file_descriptor" = 139
"out_of_range" = 140
"name_too_long" = 141
"invalid_seek" = 142
"not_supported" = 143
"too_many_open_files" = 144

request/red_brick/<UID>/get_file_events¶

Anfrage:	file_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]
Antwort:	error_code – Typ: int, Wertebereich: Siehe Symbole events – Typ: int, Wertebereich: Siehe Symbole

Die folgenden Symbole sind für diese Funktion verfügbar:

Für error_code:

"success" = 0
"unknown_error" = 1
"invalid_operation" = 2
"operation_aborted" = 3
"internal_error" = 4
"unknown_session_id" = 5
"no_free_session_id" = 6
"unknown_object_id" = 7
"no_free_object_id" = 8
"object_is_locked" = 9
"no_more_data" = 10
"wrong_list_item_type" = 11
"program_is_purged" = 12
"invalid_parameter" = 128
"no_free_memory" = 129
"no_free_space" = 130
"access_denied" = 121
"already_exists" = 132
"does_not_exist" = 133
"interrupted" = 134
"is_directory" = 135
"not_a_directory" = 136
"would_block" = 137
"overflow" = 138
"bad_file_descriptor" = 139
"out_of_range" = 140
"name_too_long" = 141
"invalid_seek" = 142
"not_supported" = 143
"too_many_open_files" = 144

Für events:

"readable" = 1
"writable" = 2

request/red_brick/<UID>/open_directory¶

Anfrage:	name_string_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] session_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]
Antwort:	error_code – Typ: int, Wertebereich: Siehe Symbole directory_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]

Die folgenden Symbole sind für diese Funktion verfügbar:

Für error_code:

"success" = 0
"unknown_error" = 1
"invalid_operation" = 2
"operation_aborted" = 3
"internal_error" = 4
"unknown_session_id" = 5
"no_free_session_id" = 6
"unknown_object_id" = 7
"no_free_object_id" = 8
"object_is_locked" = 9
"no_more_data" = 10
"wrong_list_item_type" = 11
"program_is_purged" = 12
"invalid_parameter" = 128
"no_free_memory" = 129
"no_free_space" = 130
"access_denied" = 121
"already_exists" = 132
"does_not_exist" = 133
"interrupted" = 134
"is_directory" = 135
"not_a_directory" = 136
"would_block" = 137
"overflow" = 138
"bad_file_descriptor" = 139
"out_of_range" = 140
"name_too_long" = 141
"invalid_seek" = 142
"not_supported" = 143
"too_many_open_files" = 144

request/red_brick/<UID>/get_directory_name¶

Anfrage:	directory_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] session_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]
Antwort:	error_code – Typ: int, Wertebereich: Siehe Symbole name_string_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]

Die folgenden Symbole sind für diese Funktion verfügbar:

Für error_code:

"success" = 0
"unknown_error" = 1
"invalid_operation" = 2
"operation_aborted" = 3
"internal_error" = 4
"unknown_session_id" = 5
"no_free_session_id" = 6
"unknown_object_id" = 7
"no_free_object_id" = 8
"object_is_locked" = 9
"no_more_data" = 10
"wrong_list_item_type" = 11
"program_is_purged" = 12
"invalid_parameter" = 128
"no_free_memory" = 129
"no_free_space" = 130
"access_denied" = 121
"already_exists" = 132
"does_not_exist" = 133
"interrupted" = 134
"is_directory" = 135
"not_a_directory" = 136
"would_block" = 137
"overflow" = 138
"bad_file_descriptor" = 139
"out_of_range" = 140
"name_too_long" = 141
"invalid_seek" = 142
"not_supported" = 143
"too_many_open_files" = 144

request/red_brick/<UID>/get_next_directory_entry¶

Anfrage:	directory_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] session_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]
Antwort:	error_code – Typ: int, Wertebereich: Siehe Symbole name_string_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] type – Typ: int, Wertebereich: Siehe Symbole

Die folgenden Symbole sind für diese Funktion verfügbar:

Für error_code:

"success" = 0
"unknown_error" = 1
"invalid_operation" = 2
"operation_aborted" = 3
"internal_error" = 4
"unknown_session_id" = 5
"no_free_session_id" = 6
"unknown_object_id" = 7
"no_free_object_id" = 8
"object_is_locked" = 9
"no_more_data" = 10
"wrong_list_item_type" = 11
"program_is_purged" = 12
"invalid_parameter" = 128
"no_free_memory" = 129
"no_free_space" = 130
"access_denied" = 121
"already_exists" = 132
"does_not_exist" = 133
"interrupted" = 134
"is_directory" = 135
"not_a_directory" = 136
"would_block" = 137
"overflow" = 138
"bad_file_descriptor" = 139
"out_of_range" = 140
"name_too_long" = 141
"invalid_seek" = 142
"not_supported" = 143
"too_many_open_files" = 144

Für type:

"unknown" = 0
"regular" = 1
"directory" = 2
"character" = 3
"block" = 4
"fifo" = 5
"symlink" = 6
"socket" = 7

request/red_brick/<UID>/rewind_directory¶

Anfrage:	directory_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]
Antwort:	error_code – Typ: int, Wertebereich: Siehe Symbole

Die folgenden Symbole sind für diese Funktion verfügbar:

Für error_code:

"success" = 0
"unknown_error" = 1
"invalid_operation" = 2
"operation_aborted" = 3
"internal_error" = 4
"unknown_session_id" = 5
"no_free_session_id" = 6
"unknown_object_id" = 7
"no_free_object_id" = 8
"object_is_locked" = 9
"no_more_data" = 10
"wrong_list_item_type" = 11
"program_is_purged" = 12
"invalid_parameter" = 128
"no_free_memory" = 129
"no_free_space" = 130
"access_denied" = 121
"already_exists" = 132
"does_not_exist" = 133
"interrupted" = 134
"is_directory" = 135
"not_a_directory" = 136
"would_block" = 137
"overflow" = 138
"bad_file_descriptor" = 139
"out_of_range" = 140
"name_too_long" = 141
"invalid_seek" = 142
"not_supported" = 143
"too_many_open_files" = 144

request/red_brick/<UID>/create_directory¶

Anfrage:	name_string_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] flags – Typ: int, Wertebereich: Siehe Symbole permissions – Typ: int, Wertebereich: Siehe Symbole uid – Typ: int, Wertebereich: [0 bis 2³² - 1] gid – Typ: int, Wertebereich: [0 bis 2³² - 1]
Antwort:	error_code – Typ: int, Wertebereich: Siehe Symbole

Die folgenden Symbole sind für diese Funktion verfügbar:

Für flags:

"recursive" = 1
"exclusive" = 2

Für permissions:

"user_all" = 448
"user_read" = 256
"user_write" = 128
"user_execute" = 64
"group_all" = 56
"group_read" = 32
"group_write" = 16
"group_execute" = 8
"others_all" = 7
"others_read" = 4
"others_write" = 2
"others_execute" = 1

Für error_code:

"success" = 0
"unknown_error" = 1
"invalid_operation" = 2
"operation_aborted" = 3
"internal_error" = 4
"unknown_session_id" = 5
"no_free_session_id" = 6
"unknown_object_id" = 7
"no_free_object_id" = 8
"object_is_locked" = 9
"no_more_data" = 10
"wrong_list_item_type" = 11
"program_is_purged" = 12
"invalid_parameter" = 128
"no_free_memory" = 129
"no_free_space" = 130
"access_denied" = 121
"already_exists" = 132
"does_not_exist" = 133
"interrupted" = 134
"is_directory" = 135
"not_a_directory" = 136
"would_block" = 137
"overflow" = 138
"bad_file_descriptor" = 139
"out_of_range" = 140
"name_too_long" = 141
"invalid_seek" = 142
"not_supported" = 143
"too_many_open_files" = 144

request/red_brick/<UID>/get_processes¶

Anfrage:	session_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]
Antwort:	error_code – Typ: int, Wertebereich: Siehe Symbole processes_list_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]

Die folgenden Symbole sind für diese Funktion verfügbar:

Für error_code:

"success" = 0
"unknown_error" = 1
"invalid_operation" = 2
"operation_aborted" = 3
"internal_error" = 4
"unknown_session_id" = 5
"no_free_session_id" = 6
"unknown_object_id" = 7
"no_free_object_id" = 8
"object_is_locked" = 9
"no_more_data" = 10
"wrong_list_item_type" = 11
"program_is_purged" = 12
"invalid_parameter" = 128
"no_free_memory" = 129
"no_free_space" = 130
"access_denied" = 121
"already_exists" = 132
"does_not_exist" = 133
"interrupted" = 134
"is_directory" = 135
"not_a_directory" = 136
"would_block" = 137
"overflow" = 138
"bad_file_descriptor" = 139
"out_of_range" = 140
"name_too_long" = 141
"invalid_seek" = 142
"not_supported" = 143
"too_many_open_files" = 144

request/red_brick/<UID>/spawn_process¶

Anfrage:

Anfrage:	executable_string_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] arguments_list_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] environment_list_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] working_directory_string_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] uid – Typ: int, Wertebereich: [0 bis 2³² - 1] gid – Typ: int, Wertebereich: [0 bis 2³² - 1] stdin_file_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] stdout_file_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] stderr_file_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] session_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]
Antwort:	error_code – Typ: int, Wertebereich: Siehe Symbole process_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]

executable_string_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]
arguments_list_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]
environment_list_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]
working_directory_string_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]
uid – Typ: int, Wertebereich: [0 bis 2³² - 1]
gid – Typ: int, Wertebereich: [0 bis 2³² - 1]
stdin_file_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]
stdout_file_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]
stderr_file_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]
session_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]

Antwort:

error_code – Typ: int, Wertebereich: Siehe Symbole
process_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]

Die folgenden Symbole sind für diese Funktion verfügbar:

Für error_code:

"success" = 0
"unknown_error" = 1
"invalid_operation" = 2
"operation_aborted" = 3
"internal_error" = 4
"unknown_session_id" = 5
"no_free_session_id" = 6
"unknown_object_id" = 7
"no_free_object_id" = 8
"object_is_locked" = 9
"no_more_data" = 10
"wrong_list_item_type" = 11
"program_is_purged" = 12
"invalid_parameter" = 128
"no_free_memory" = 129
"no_free_space" = 130
"access_denied" = 121
"already_exists" = 132
"does_not_exist" = 133
"interrupted" = 134
"is_directory" = 135
"not_a_directory" = 136
"would_block" = 137
"overflow" = 138
"bad_file_descriptor" = 139
"out_of_range" = 140
"name_too_long" = 141
"invalid_seek" = 142
"not_supported" = 143
"too_many_open_files" = 144

request/red_brick/<UID>/kill_process¶

Anfrage:	process_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] signal – Typ: int, Wertebereich: Siehe Symbole
Antwort:	error_code – Typ: int, Wertebereich: Siehe Symbole

Die folgenden Symbole sind für diese Funktion verfügbar:

Für signal:

"interrupt" = 2
"quit" = 3
"abort" = 6
"kill" = 9
"user1" = 10
"user2" = 12
"terminate" = 15
"continue" = 18
"stop" = 19

Für error_code:

"success" = 0
"unknown_error" = 1
"invalid_operation" = 2
"operation_aborted" = 3
"internal_error" = 4
"unknown_session_id" = 5
"no_free_session_id" = 6
"unknown_object_id" = 7
"no_free_object_id" = 8
"object_is_locked" = 9
"no_more_data" = 10
"wrong_list_item_type" = 11
"program_is_purged" = 12
"invalid_parameter" = 128
"no_free_memory" = 129
"no_free_space" = 130
"access_denied" = 121
"already_exists" = 132
"does_not_exist" = 133
"interrupted" = 134
"is_directory" = 135
"not_a_directory" = 136
"would_block" = 137
"overflow" = 138
"bad_file_descriptor" = 139
"out_of_range" = 140
"name_too_long" = 141
"invalid_seek" = 142
"not_supported" = 143
"too_many_open_files" = 144

request/red_brick/<UID>/get_process_command¶

Anfrage:	process_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] session_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]
Antwort:	error_code – Typ: int, Wertebereich: Siehe Symbole executable_string_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] arguments_list_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] environment_list_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] working_directory_string_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]

Die folgenden Symbole sind für diese Funktion verfügbar:

Für error_code:

"success" = 0
"unknown_error" = 1
"invalid_operation" = 2
"operation_aborted" = 3
"internal_error" = 4
"unknown_session_id" = 5
"no_free_session_id" = 6
"unknown_object_id" = 7
"no_free_object_id" = 8
"object_is_locked" = 9
"no_more_data" = 10
"wrong_list_item_type" = 11
"program_is_purged" = 12
"invalid_parameter" = 128
"no_free_memory" = 129
"no_free_space" = 130
"access_denied" = 121
"already_exists" = 132
"does_not_exist" = 133
"interrupted" = 134
"is_directory" = 135
"not_a_directory" = 136
"would_block" = 137
"overflow" = 138
"bad_file_descriptor" = 139
"out_of_range" = 140
"name_too_long" = 141
"invalid_seek" = 142
"not_supported" = 143
"too_many_open_files" = 144

request/red_brick/<UID>/get_process_identity¶

Anfrage:	process_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]
Antwort:	error_code – Typ: int, Wertebereich: Siehe Symbole pid – Typ: int, Wertebereich: [0 bis 2³² - 1] uid – Typ: int, Wertebereich: [0 bis 2³² - 1] gid – Typ: int, Wertebereich: [0 bis 2³² - 1]

Die folgenden Symbole sind für diese Funktion verfügbar:

Für error_code:

"success" = 0
"unknown_error" = 1
"invalid_operation" = 2
"operation_aborted" = 3
"internal_error" = 4
"unknown_session_id" = 5
"no_free_session_id" = 6
"unknown_object_id" = 7
"no_free_object_id" = 8
"object_is_locked" = 9
"no_more_data" = 10
"wrong_list_item_type" = 11
"program_is_purged" = 12
"invalid_parameter" = 128
"no_free_memory" = 129
"no_free_space" = 130
"access_denied" = 121
"already_exists" = 132
"does_not_exist" = 133
"interrupted" = 134
"is_directory" = 135
"not_a_directory" = 136
"would_block" = 137
"overflow" = 138
"bad_file_descriptor" = 139
"out_of_range" = 140
"name_too_long" = 141
"invalid_seek" = 142
"not_supported" = 143
"too_many_open_files" = 144

request/red_brick/<UID>/get_process_stdio¶

Anfrage:	process_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] session_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]
Antwort:	error_code – Typ: int, Wertebereich: Siehe Symbole stdin_file_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] stdout_file_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] stderr_file_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]

Die folgenden Symbole sind für diese Funktion verfügbar:

Für error_code:

"success" = 0
"unknown_error" = 1
"invalid_operation" = 2
"operation_aborted" = 3
"internal_error" = 4
"unknown_session_id" = 5
"no_free_session_id" = 6
"unknown_object_id" = 7
"no_free_object_id" = 8
"object_is_locked" = 9
"no_more_data" = 10
"wrong_list_item_type" = 11
"program_is_purged" = 12
"invalid_parameter" = 128
"no_free_memory" = 129
"no_free_space" = 130
"access_denied" = 121
"already_exists" = 132
"does_not_exist" = 133
"interrupted" = 134
"is_directory" = 135
"not_a_directory" = 136
"would_block" = 137
"overflow" = 138
"bad_file_descriptor" = 139
"out_of_range" = 140
"name_too_long" = 141
"invalid_seek" = 142
"not_supported" = 143
"too_many_open_files" = 144

request/red_brick/<UID>/get_process_state¶

Anfrage:	process_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]
Antwort:	error_code – Typ: int, Wertebereich: Siehe Symbole state – Typ: int, Wertebereich: Siehe Symbole timestamp – Typ: int, Wertebereich: [0 bis 2⁶⁴ - 1] exit_code – Typ: int, Wertebereich: [0 bis 255]

Die folgenden Symbole sind für diese Funktion verfügbar:

Für error_code:

"success" = 0
"unknown_error" = 1
"invalid_operation" = 2
"operation_aborted" = 3
"internal_error" = 4
"unknown_session_id" = 5
"no_free_session_id" = 6
"unknown_object_id" = 7
"no_free_object_id" = 8
"object_is_locked" = 9
"no_more_data" = 10
"wrong_list_item_type" = 11
"program_is_purged" = 12
"invalid_parameter" = 128
"no_free_memory" = 129
"no_free_space" = 130
"access_denied" = 121
"already_exists" = 132
"does_not_exist" = 133
"interrupted" = 134
"is_directory" = 135
"not_a_directory" = 136
"would_block" = 137
"overflow" = 138
"bad_file_descriptor" = 139
"out_of_range" = 140
"name_too_long" = 141
"invalid_seek" = 142
"not_supported" = 143
"too_many_open_files" = 144

Für state:

"unknown" = 0
"running" = 1
"error" = 2
"exited" = 3
"killed" = 4
"stopped" = 5

request/red_brick/<UID>/get_programs¶

Anfrage:	session_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]
Antwort:	error_code – Typ: int, Wertebereich: Siehe Symbole programs_list_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]

Die folgenden Symbole sind für diese Funktion verfügbar:

Für error_code:

"success" = 0
"unknown_error" = 1
"invalid_operation" = 2
"operation_aborted" = 3
"internal_error" = 4
"unknown_session_id" = 5
"no_free_session_id" = 6
"unknown_object_id" = 7
"no_free_object_id" = 8
"object_is_locked" = 9
"no_more_data" = 10
"wrong_list_item_type" = 11
"program_is_purged" = 12
"invalid_parameter" = 128
"no_free_memory" = 129
"no_free_space" = 130
"access_denied" = 121
"already_exists" = 132
"does_not_exist" = 133
"interrupted" = 134
"is_directory" = 135
"not_a_directory" = 136
"would_block" = 137
"overflow" = 138
"bad_file_descriptor" = 139
"out_of_range" = 140
"name_too_long" = 141
"invalid_seek" = 142
"not_supported" = 143
"too_many_open_files" = 144

request/red_brick/<UID>/define_program¶

Anfrage:	identifier_string_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] session_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]
Antwort:	error_code – Typ: int, Wertebereich: Siehe Symbole program_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]

Die folgenden Symbole sind für diese Funktion verfügbar:

Für error_code:

"success" = 0
"unknown_error" = 1
"invalid_operation" = 2
"operation_aborted" = 3
"internal_error" = 4
"unknown_session_id" = 5
"no_free_session_id" = 6
"unknown_object_id" = 7
"no_free_object_id" = 8
"object_is_locked" = 9
"no_more_data" = 10
"wrong_list_item_type" = 11
"program_is_purged" = 12
"invalid_parameter" = 128
"no_free_memory" = 129
"no_free_space" = 130
"access_denied" = 121
"already_exists" = 132
"does_not_exist" = 133
"interrupted" = 134
"is_directory" = 135
"not_a_directory" = 136
"would_block" = 137
"overflow" = 138
"bad_file_descriptor" = 139
"out_of_range" = 140
"name_too_long" = 141
"invalid_seek" = 142
"not_supported" = 143
"too_many_open_files" = 144

request/red_brick/<UID>/purge_program¶

Anfrage:	program_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] cookie – Typ: int, Wertebereich: [0 bis 2³² - 1]
Antwort:	error_code – Typ: int, Wertebereich: Siehe Symbole

Die folgenden Symbole sind für diese Funktion verfügbar:

Für error_code:

"success" = 0
"unknown_error" = 1
"invalid_operation" = 2
"operation_aborted" = 3
"internal_error" = 4
"unknown_session_id" = 5
"no_free_session_id" = 6
"unknown_object_id" = 7
"no_free_object_id" = 8
"object_is_locked" = 9
"no_more_data" = 10
"wrong_list_item_type" = 11
"program_is_purged" = 12
"invalid_parameter" = 128
"no_free_memory" = 129
"no_free_space" = 130
"access_denied" = 121
"already_exists" = 132
"does_not_exist" = 133
"interrupted" = 134
"is_directory" = 135
"not_a_directory" = 136
"would_block" = 137
"overflow" = 138
"bad_file_descriptor" = 139
"out_of_range" = 140
"name_too_long" = 141
"invalid_seek" = 142
"not_supported" = 143
"too_many_open_files" = 144

request/red_brick/<UID>/get_program_identifier¶

Anfrage:	program_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] session_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]
Antwort:	error_code – Typ: int, Wertebereich: Siehe Symbole identifier_string_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]

Die folgenden Symbole sind für diese Funktion verfügbar:

Für error_code:

"success" = 0
"unknown_error" = 1
"invalid_operation" = 2
"operation_aborted" = 3
"internal_error" = 4
"unknown_session_id" = 5
"no_free_session_id" = 6
"unknown_object_id" = 7
"no_free_object_id" = 8
"object_is_locked" = 9
"no_more_data" = 10
"wrong_list_item_type" = 11
"program_is_purged" = 12
"invalid_parameter" = 128
"no_free_memory" = 129
"no_free_space" = 130
"access_denied" = 121
"already_exists" = 132
"does_not_exist" = 133
"interrupted" = 134
"is_directory" = 135
"not_a_directory" = 136
"would_block" = 137
"overflow" = 138
"bad_file_descriptor" = 139
"out_of_range" = 140
"name_too_long" = 141
"invalid_seek" = 142
"not_supported" = 143
"too_many_open_files" = 144

request/red_brick/<UID>/get_program_root_directory¶

Anfrage:	program_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] session_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]
Antwort:	error_code – Typ: int, Wertebereich: Siehe Symbole root_directory_string_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]

Die folgenden Symbole sind für diese Funktion verfügbar:

Für error_code:

"success" = 0
"unknown_error" = 1
"invalid_operation" = 2
"operation_aborted" = 3
"internal_error" = 4
"unknown_session_id" = 5
"no_free_session_id" = 6
"unknown_object_id" = 7
"no_free_object_id" = 8
"object_is_locked" = 9
"no_more_data" = 10
"wrong_list_item_type" = 11
"program_is_purged" = 12
"invalid_parameter" = 128
"no_free_memory" = 129
"no_free_space" = 130
"access_denied" = 121
"already_exists" = 132
"does_not_exist" = 133
"interrupted" = 134
"is_directory" = 135
"not_a_directory" = 136
"would_block" = 137
"overflow" = 138
"bad_file_descriptor" = 139
"out_of_range" = 140
"name_too_long" = 141
"invalid_seek" = 142
"not_supported" = 143
"too_many_open_files" = 144

request/red_brick/<UID>/set_program_command¶

Anfrage:	program_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] executable_string_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] arguments_list_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] environment_list_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] working_directory_string_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]
Antwort:	error_code – Typ: int, Wertebereich: Siehe Symbole

Die folgenden Symbole sind für diese Funktion verfügbar:

Für error_code:

"success" = 0
"unknown_error" = 1
"invalid_operation" = 2
"operation_aborted" = 3
"internal_error" = 4
"unknown_session_id" = 5
"no_free_session_id" = 6
"unknown_object_id" = 7
"no_free_object_id" = 8
"object_is_locked" = 9
"no_more_data" = 10
"wrong_list_item_type" = 11
"program_is_purged" = 12
"invalid_parameter" = 128
"no_free_memory" = 129
"no_free_space" = 130
"access_denied" = 121
"already_exists" = 132
"does_not_exist" = 133
"interrupted" = 134
"is_directory" = 135
"not_a_directory" = 136
"would_block" = 137
"overflow" = 138
"bad_file_descriptor" = 139
"out_of_range" = 140
"name_too_long" = 141
"invalid_seek" = 142
"not_supported" = 143
"too_many_open_files" = 144

request/red_brick/<UID>/get_program_command¶

Anfrage:	program_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] session_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]
Antwort:	error_code – Typ: int, Wertebereich: Siehe Symbole executable_string_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] arguments_list_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] environment_list_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] working_directory_string_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]

Die folgenden Symbole sind für diese Funktion verfügbar:

Für error_code:

"success" = 0
"unknown_error" = 1
"invalid_operation" = 2
"operation_aborted" = 3
"internal_error" = 4
"unknown_session_id" = 5
"no_free_session_id" = 6
"unknown_object_id" = 7
"no_free_object_id" = 8
"object_is_locked" = 9
"no_more_data" = 10
"wrong_list_item_type" = 11
"program_is_purged" = 12
"invalid_parameter" = 128
"no_free_memory" = 129
"no_free_space" = 130
"access_denied" = 121
"already_exists" = 132
"does_not_exist" = 133
"interrupted" = 134
"is_directory" = 135
"not_a_directory" = 136
"would_block" = 137
"overflow" = 138
"bad_file_descriptor" = 139
"out_of_range" = 140
"name_too_long" = 141
"invalid_seek" = 142
"not_supported" = 143
"too_many_open_files" = 144

request/red_brick/<UID>/set_program_stdio_redirection¶

Anfrage:

Anfrage:	program_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] stdin_redirection – Typ: int, Wertebereich: Siehe Symbole stdin_file_name_string_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] stdout_redirection – Typ: int, Wertebereich: Siehe Symbole stdout_file_name_string_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] stderr_redirection – Typ: int, Wertebereich: Siehe Symbole stderr_file_name_string_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]
Antwort:	error_code – Typ: int, Wertebereich: Siehe Symbole

program_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]
stdin_redirection – Typ: int, Wertebereich: Siehe Symbole
stdin_file_name_string_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]
stdout_redirection – Typ: int, Wertebereich: Siehe Symbole
stdout_file_name_string_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]
stderr_redirection – Typ: int, Wertebereich: Siehe Symbole
stderr_file_name_string_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]

Antwort:

error_code – Typ: int, Wertebereich: Siehe Symbole

Die folgenden Symbole sind für diese Funktion verfügbar:

Für stdin_redirection:

"dev_null" = 0
"pipe" = 1
"file" = 2
"individual_log" = 3
"continuous_log" = 4
"stdout" = 5

Für stdout_redirection:

"dev_null" = 0
"pipe" = 1
"file" = 2
"individual_log" = 3
"continuous_log" = 4
"stdout" = 5

Für stderr_redirection:

"dev_null" = 0
"pipe" = 1
"file" = 2
"individual_log" = 3
"continuous_log" = 4
"stdout" = 5

Für error_code:

"success" = 0
"unknown_error" = 1
"invalid_operation" = 2
"operation_aborted" = 3
"internal_error" = 4
"unknown_session_id" = 5
"no_free_session_id" = 6
"unknown_object_id" = 7
"no_free_object_id" = 8
"object_is_locked" = 9
"no_more_data" = 10
"wrong_list_item_type" = 11
"program_is_purged" = 12
"invalid_parameter" = 128
"no_free_memory" = 129
"no_free_space" = 130
"access_denied" = 121
"already_exists" = 132
"does_not_exist" = 133
"interrupted" = 134
"is_directory" = 135
"not_a_directory" = 136
"would_block" = 137
"overflow" = 138
"bad_file_descriptor" = 139
"out_of_range" = 140
"name_too_long" = 141
"invalid_seek" = 142
"not_supported" = 143
"too_many_open_files" = 144

request/red_brick/<UID>/get_program_stdio_redirection¶

Anfrage:

program_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]
session_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]

Antwort:

error_code – Typ: int, Wertebereich: Siehe Symbole
stdin_redirection – Typ: int, Wertebereich: Siehe Symbole
stdin_file_name_string_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]
stdout_redirection – Typ: int, Wertebereich: Siehe Symbole
stdout_file_name_string_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]
stderr_redirection – Typ: int, Wertebereich: Siehe Symbole
stderr_file_name_string_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]

Die folgenden Symbole sind für diese Funktion verfügbar:

Für error_code:

"success" = 0
"unknown_error" = 1
"invalid_operation" = 2
"operation_aborted" = 3
"internal_error" = 4
"unknown_session_id" = 5
"no_free_session_id" = 6
"unknown_object_id" = 7
"no_free_object_id" = 8
"object_is_locked" = 9
"no_more_data" = 10
"wrong_list_item_type" = 11
"program_is_purged" = 12
"invalid_parameter" = 128
"no_free_memory" = 129
"no_free_space" = 130
"access_denied" = 121
"already_exists" = 132
"does_not_exist" = 133
"interrupted" = 134
"is_directory" = 135
"not_a_directory" = 136
"would_block" = 137
"overflow" = 138
"bad_file_descriptor" = 139
"out_of_range" = 140
"name_too_long" = 141
"invalid_seek" = 142
"not_supported" = 143
"too_many_open_files" = 144

Für stdin_redirection:

"dev_null" = 0
"pipe" = 1
"file" = 2
"individual_log" = 3
"continuous_log" = 4
"stdout" = 5

Für stdout_redirection:

"dev_null" = 0
"pipe" = 1
"file" = 2
"individual_log" = 3
"continuous_log" = 4
"stdout" = 5

Für stderr_redirection:

"dev_null" = 0
"pipe" = 1
"file" = 2
"individual_log" = 3
"continuous_log" = 4
"stdout" = 5

request/red_brick/<UID>/set_program_schedule¶

Anfrage:	program_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] start_mode – Typ: int, Wertebereich: Siehe Symbole continue_after_error – Typ: bool start_interval – Typ: int, Wertebereich: [0 bis 2³² - 1] start_fields_string_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]
Antwort:	error_code – Typ: int, Wertebereich: Siehe Symbole

Die folgenden Symbole sind für diese Funktion verfügbar:

Für start_mode:

"never" = 0
"always" = 1
"interval" = 2
"cron" = 3

Für error_code:

"success" = 0
"unknown_error" = 1
"invalid_operation" = 2
"operation_aborted" = 3
"internal_error" = 4
"unknown_session_id" = 5
"no_free_session_id" = 6
"unknown_object_id" = 7
"no_free_object_id" = 8
"object_is_locked" = 9
"no_more_data" = 10
"wrong_list_item_type" = 11
"program_is_purged" = 12
"invalid_parameter" = 128
"no_free_memory" = 129
"no_free_space" = 130
"access_denied" = 121
"already_exists" = 132
"does_not_exist" = 133
"interrupted" = 134
"is_directory" = 135
"not_a_directory" = 136
"would_block" = 137
"overflow" = 138
"bad_file_descriptor" = 139
"out_of_range" = 140
"name_too_long" = 141
"invalid_seek" = 142
"not_supported" = 143
"too_many_open_files" = 144

request/red_brick/<UID>/get_program_schedule¶

Anfrage:	program_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] session_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]
Antwort:	error_code – Typ: int, Wertebereich: Siehe Symbole start_mode – Typ: int, Wertebereich: Siehe Symbole continue_after_error – Typ: bool start_interval – Typ: int, Wertebereich: [0 bis 2³² - 1] start_fields_string_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]

Die folgenden Symbole sind für diese Funktion verfügbar:

Für error_code:

"success" = 0
"unknown_error" = 1
"invalid_operation" = 2
"operation_aborted" = 3
"internal_error" = 4
"unknown_session_id" = 5
"no_free_session_id" = 6
"unknown_object_id" = 7
"no_free_object_id" = 8
"object_is_locked" = 9
"no_more_data" = 10
"wrong_list_item_type" = 11
"program_is_purged" = 12
"invalid_parameter" = 128
"no_free_memory" = 129
"no_free_space" = 130
"access_denied" = 121
"already_exists" = 132
"does_not_exist" = 133
"interrupted" = 134
"is_directory" = 135
"not_a_directory" = 136
"would_block" = 137
"overflow" = 138
"bad_file_descriptor" = 139
"out_of_range" = 140
"name_too_long" = 141
"invalid_seek" = 142
"not_supported" = 143
"too_many_open_files" = 144

Für start_mode:

"never" = 0
"always" = 1
"interval" = 2
"cron" = 3

request/red_brick/<UID>/get_program_scheduler_state¶

Anfrage:	program_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] session_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]
Antwort:	error_code – Typ: int, Wertebereich: Siehe Symbole state – Typ: int, Wertebereich: Siehe Symbole timestamp – Typ: int, Wertebereich: [0 bis 2⁶⁴ - 1] message_string_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]

Die folgenden Symbole sind für diese Funktion verfügbar:

Für error_code:

"success" = 0
"unknown_error" = 1
"invalid_operation" = 2
"operation_aborted" = 3
"internal_error" = 4
"unknown_session_id" = 5
"no_free_session_id" = 6
"unknown_object_id" = 7
"no_free_object_id" = 8
"object_is_locked" = 9
"no_more_data" = 10
"wrong_list_item_type" = 11
"program_is_purged" = 12
"invalid_parameter" = 128
"no_free_memory" = 129
"no_free_space" = 130
"access_denied" = 121
"already_exists" = 132
"does_not_exist" = 133
"interrupted" = 134
"is_directory" = 135
"not_a_directory" = 136
"would_block" = 137
"overflow" = 138
"bad_file_descriptor" = 139
"out_of_range" = 140
"name_too_long" = 141
"invalid_seek" = 142
"not_supported" = 143
"too_many_open_files" = 144

Für state:

"stopped" = 0
"running" = 1

request/red_brick/<UID>/continue_program_schedule¶

Anfrage:	program_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]
Antwort:	error_code – Typ: int, Wertebereich: Siehe Symbole

Die folgenden Symbole sind für diese Funktion verfügbar:

Für error_code:

"success" = 0
"unknown_error" = 1
"invalid_operation" = 2
"operation_aborted" = 3
"internal_error" = 4
"unknown_session_id" = 5
"no_free_session_id" = 6
"unknown_object_id" = 7
"no_free_object_id" = 8
"object_is_locked" = 9
"no_more_data" = 10
"wrong_list_item_type" = 11
"program_is_purged" = 12
"invalid_parameter" = 128
"no_free_memory" = 129
"no_free_space" = 130
"access_denied" = 121
"already_exists" = 132
"does_not_exist" = 133
"interrupted" = 134
"is_directory" = 135
"not_a_directory" = 136
"would_block" = 137
"overflow" = 138
"bad_file_descriptor" = 139
"out_of_range" = 140
"name_too_long" = 141
"invalid_seek" = 142
"not_supported" = 143
"too_many_open_files" = 144

request/red_brick/<UID>/start_program¶

Anfrage:	program_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]
Antwort:	error_code – Typ: int, Wertebereich: Siehe Symbole

Die folgenden Symbole sind für diese Funktion verfügbar:

Für error_code:

"success" = 0
"unknown_error" = 1
"invalid_operation" = 2
"operation_aborted" = 3
"internal_error" = 4
"unknown_session_id" = 5
"no_free_session_id" = 6
"unknown_object_id" = 7
"no_free_object_id" = 8
"object_is_locked" = 9
"no_more_data" = 10
"wrong_list_item_type" = 11
"program_is_purged" = 12
"invalid_parameter" = 128
"no_free_memory" = 129
"no_free_space" = 130
"access_denied" = 121
"already_exists" = 132
"does_not_exist" = 133
"interrupted" = 134
"is_directory" = 135
"not_a_directory" = 136
"would_block" = 137
"overflow" = 138
"bad_file_descriptor" = 139
"out_of_range" = 140
"name_too_long" = 141
"invalid_seek" = 142
"not_supported" = 143
"too_many_open_files" = 144

request/red_brick/<UID>/get_last_spawned_program_process¶

Anfrage:	program_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] session_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]
Antwort:	error_code – Typ: int, Wertebereich: Siehe Symbole process_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] timestamp – Typ: int, Wertebereich: [0 bis 2⁶⁴ - 1]

Die folgenden Symbole sind für diese Funktion verfügbar:

Für error_code:

"success" = 0
"unknown_error" = 1
"invalid_operation" = 2
"operation_aborted" = 3
"internal_error" = 4
"unknown_session_id" = 5
"no_free_session_id" = 6
"unknown_object_id" = 7
"no_free_object_id" = 8
"object_is_locked" = 9
"no_more_data" = 10
"wrong_list_item_type" = 11
"program_is_purged" = 12
"invalid_parameter" = 128
"no_free_memory" = 129
"no_free_space" = 130
"access_denied" = 121
"already_exists" = 132
"does_not_exist" = 133
"interrupted" = 134
"is_directory" = 135
"not_a_directory" = 136
"would_block" = 137
"overflow" = 138
"bad_file_descriptor" = 139
"out_of_range" = 140
"name_too_long" = 141
"invalid_seek" = 142
"not_supported" = 143
"too_many_open_files" = 144

request/red_brick/<UID>/get_custom_program_option_names¶

Anfrage:	program_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] session_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]
Antwort:	error_code – Typ: int, Wertebereich: Siehe Symbole names_list_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]

Die folgenden Symbole sind für diese Funktion verfügbar:

Für error_code:

"success" = 0
"unknown_error" = 1
"invalid_operation" = 2
"operation_aborted" = 3
"internal_error" = 4
"unknown_session_id" = 5
"no_free_session_id" = 6
"unknown_object_id" = 7
"no_free_object_id" = 8
"object_is_locked" = 9
"no_more_data" = 10
"wrong_list_item_type" = 11
"program_is_purged" = 12
"invalid_parameter" = 128
"no_free_memory" = 129
"no_free_space" = 130
"access_denied" = 121
"already_exists" = 132
"does_not_exist" = 133
"interrupted" = 134
"is_directory" = 135
"not_a_directory" = 136
"would_block" = 137
"overflow" = 138
"bad_file_descriptor" = 139
"out_of_range" = 140
"name_too_long" = 141
"invalid_seek" = 142
"not_supported" = 143
"too_many_open_files" = 144

request/red_brick/<UID>/set_custom_program_option_value¶

Anfrage:	program_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] name_string_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] value_string_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]
Antwort:	error_code – Typ: int, Wertebereich: Siehe Symbole

Die folgenden Symbole sind für diese Funktion verfügbar:

Für error_code:

"success" = 0
"unknown_error" = 1
"invalid_operation" = 2
"operation_aborted" = 3
"internal_error" = 4
"unknown_session_id" = 5
"no_free_session_id" = 6
"unknown_object_id" = 7
"no_free_object_id" = 8
"object_is_locked" = 9
"no_more_data" = 10
"wrong_list_item_type" = 11
"program_is_purged" = 12
"invalid_parameter" = 128
"no_free_memory" = 129
"no_free_space" = 130
"access_denied" = 121
"already_exists" = 132
"does_not_exist" = 133
"interrupted" = 134
"is_directory" = 135
"not_a_directory" = 136
"would_block" = 137
"overflow" = 138
"bad_file_descriptor" = 139
"out_of_range" = 140
"name_too_long" = 141
"invalid_seek" = 142
"not_supported" = 143
"too_many_open_files" = 144

request/red_brick/<UID>/get_custom_program_option_value¶

Anfrage:	program_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] name_string_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] session_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]
Antwort:	error_code – Typ: int, Wertebereich: Siehe Symbole value_string_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]

Die folgenden Symbole sind für diese Funktion verfügbar:

Für error_code:

"success" = 0
"unknown_error" = 1
"invalid_operation" = 2
"operation_aborted" = 3
"internal_error" = 4
"unknown_session_id" = 5
"no_free_session_id" = 6
"unknown_object_id" = 7
"no_free_object_id" = 8
"object_is_locked" = 9
"no_more_data" = 10
"wrong_list_item_type" = 11
"program_is_purged" = 12
"invalid_parameter" = 128
"no_free_memory" = 129
"no_free_space" = 130
"access_denied" = 121
"already_exists" = 132
"does_not_exist" = 133
"interrupted" = 134
"is_directory" = 135
"not_a_directory" = 136
"would_block" = 137
"overflow" = 138
"bad_file_descriptor" = 139
"out_of_range" = 140
"name_too_long" = 141
"invalid_seek" = 142
"not_supported" = 143
"too_many_open_files" = 144

request/red_brick/<UID>/remove_custom_program_option¶

Anfrage:	program_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] name_string_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]
Antwort:	error_code – Typ: int, Wertebereich: Siehe Symbole

Die folgenden Symbole sind für diese Funktion verfügbar:

Für error_code:

"success" = 0
"unknown_error" = 1
"invalid_operation" = 2
"operation_aborted" = 3
"internal_error" = 4
"unknown_session_id" = 5
"no_free_session_id" = 6
"unknown_object_id" = 7
"no_free_object_id" = 8
"object_is_locked" = 9
"no_more_data" = 10
"wrong_list_item_type" = 11
"program_is_purged" = 12
"invalid_parameter" = 128
"no_free_memory" = 129
"no_free_space" = 130
"access_denied" = 121
"already_exists" = 132
"does_not_exist" = 133
"interrupted" = 134
"is_directory" = 135
"not_a_directory" = 136
"would_block" = 137
"overflow" = 138
"bad_file_descriptor" = 139
"out_of_range" = 140
"name_too_long" = 141
"invalid_seek" = 142
"not_supported" = 143
"too_many_open_files" = 144

request/red_brick/<UID>/get_identity¶

Anfrage:

keine Nutzdaten

Antwort:

uid – Typ: string, Länge: bis zu 8
connected_uid – Typ: string, Länge: bis zu 8
position – Typ: char, Wertebereich: ["0" bis "8"]
hardware_version – Typ: [int, ...], Länge: 3

0: major – Typ: int, Wertebereich: [0 bis 255]
1: minor – Typ: int, Wertebereich: [0 bis 255]
2: revision – Typ: int, Wertebereich: [0 bis 255]

firmware_version – Typ: [int, ...], Länge: 3

0: major – Typ: int, Wertebereich: [0 bis 255]
1: minor – Typ: int, Wertebereich: [0 bis 255]
2: revision – Typ: int, Wertebereich: [0 bis 255]

device_identifier – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]
_display_name – Typ: string

Gibt die UID, die UID zu der der Brick verbunden ist, die Position, die Hard- und Firmware Version sowie den Device Identifier zurück.

Die Position ist die Position im Stack von '0' (unterster Brick) bis '8' (oberster Brick).

Eine Liste der Device Identifier Werte ist hier zu finden. Falls die symbolische Ausgabe nicht deaktiviert wurde, wird der Device Identifier auf den entsprechenden Namen im Format, welches die Topics verwenden, abgebildet.

Der Display Name enthält den Anzeigenamen des RED.

Callbacks¶

Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung kann mit dem entsprechenden .../register/...-Topic und einem optionalen Suffix durchgeführt werden. Mit diesem Suffix kann das Callback später deregistriert werden.

Bemerkung

Callbacks für wiederkehrende Ereignisse zu verwenden ist immer zu bevorzugen gegenüber der Verwendung von Abfragen. Es wird weniger USB-Bandbreite benutzt und die Latenz ist erheblich geringer, da es keine Paketumlaufzeit gibt.

register/red_brick/<UID>/async_file_read¶

Registrierungsanfrage:	register – Typ: bool
Callback-Antwort:	file_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] error_code – Typ: int, Wertebereich: Siehe Symbole buffer – Typ: [int, ...], Länge: 60, Wertebereich: [0 bis 255] length_read – Typ: int, Einheit: 1 B, Wertebereich: [0 bis 255]

Ein Callback für dieses Event kann durch Senden des Payloads "true" an das .../register/red_brick/<UID>/async_file_read[/<SUFFIX>]-Topic hinzugefügt werden. Ein hinzugefügtes Callback kann durch Senden des Payloads "false" an das selbe Topic wieder entfernt werden. Um mehrere (De-)Registrierungen zu unterstützen, z.B. um Nachrichten filtern zu können, kann ein optionaler Suffix verwendet werden.

Wenn das Callback ausgelöst wird, wird dessen Payload für jeden Suffix auf dem entsprechenden .../callback/red_brick/<UID>/async_file_read[/<SUFFIX>]-Topic veröffentlicht.

Die folgenden Symbole sind für diese Funktion verfügbar:

Für error_code:

"success" = 0
"unknown_error" = 1
"invalid_operation" = 2
"operation_aborted" = 3
"internal_error" = 4
"unknown_session_id" = 5
"no_free_session_id" = 6
"unknown_object_id" = 7
"no_free_object_id" = 8
"object_is_locked" = 9
"no_more_data" = 10
"wrong_list_item_type" = 11
"program_is_purged" = 12
"invalid_parameter" = 128
"no_free_memory" = 129
"no_free_space" = 130
"access_denied" = 121
"already_exists" = 132
"does_not_exist" = 133
"interrupted" = 134
"is_directory" = 135
"not_a_directory" = 136
"would_block" = 137
"overflow" = 138
"bad_file_descriptor" = 139
"out_of_range" = 140
"name_too_long" = 141
"invalid_seek" = 142
"not_supported" = 143
"too_many_open_files" = 144

register/red_brick/<UID>/async_file_write¶

Registrierungsanfrage:	register – Typ: bool
Callback-Antwort:	file_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] error_code – Typ: int, Wertebereich: Siehe Symbole length_written – Typ: int, Einheit: 1 B, Wertebereich: [0 bis 255]

Ein Callback für dieses Event kann durch Senden des Payloads "true" an das .../register/red_brick/<UID>/async_file_write[/<SUFFIX>]-Topic hinzugefügt werden. Ein hinzugefügtes Callback kann durch Senden des Payloads "false" an das selbe Topic wieder entfernt werden. Um mehrere (De-)Registrierungen zu unterstützen, z.B. um Nachrichten filtern zu können, kann ein optionaler Suffix verwendet werden.

Wenn das Callback ausgelöst wird, wird dessen Payload für jeden Suffix auf dem entsprechenden .../callback/red_brick/<UID>/async_file_write[/<SUFFIX>]-Topic veröffentlicht.

Die folgenden Symbole sind für diese Funktion verfügbar:

Für error_code:

"success" = 0
"unknown_error" = 1
"invalid_operation" = 2
"operation_aborted" = 3
"internal_error" = 4
"unknown_session_id" = 5
"no_free_session_id" = 6
"unknown_object_id" = 7
"no_free_object_id" = 8
"object_is_locked" = 9
"no_more_data" = 10
"wrong_list_item_type" = 11
"program_is_purged" = 12
"invalid_parameter" = 128
"no_free_memory" = 129
"no_free_space" = 130
"access_denied" = 121
"already_exists" = 132
"does_not_exist" = 133
"interrupted" = 134
"is_directory" = 135
"not_a_directory" = 136
"would_block" = 137
"overflow" = 138
"bad_file_descriptor" = 139
"out_of_range" = 140
"name_too_long" = 141
"invalid_seek" = 142
"not_supported" = 143
"too_many_open_files" = 144

register/red_brick/<UID>/file_events_occurred¶

Registrierungsanfrage:	register – Typ: bool
Callback-Antwort:	file_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] events – Typ: int, Wertebereich: Siehe Symbole

Ein Callback für dieses Event kann durch Senden des Payloads "true" an das .../register/red_brick/<UID>/file_events_occurred[/<SUFFIX>]-Topic hinzugefügt werden. Ein hinzugefügtes Callback kann durch Senden des Payloads "false" an das selbe Topic wieder entfernt werden. Um mehrere (De-)Registrierungen zu unterstützen, z.B. um Nachrichten filtern zu können, kann ein optionaler Suffix verwendet werden.

Wenn das Callback ausgelöst wird, wird dessen Payload für jeden Suffix auf dem entsprechenden .../callback/red_brick/<UID>/file_events_occurred[/<SUFFIX>]-Topic veröffentlicht.

Die folgenden Symbole sind für diese Funktion verfügbar:

Für events:

"readable" = 1
"writable" = 2

register/red_brick/<UID>/process_state_changed¶

Registrierungsanfrage:	register – Typ: bool
Callback-Antwort:	process_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] state – Typ: int, Wertebereich: Siehe Symbole timestamp – Typ: int, Wertebereich: [0 bis 2⁶⁴ - 1] exit_code – Typ: int, Wertebereich: [0 bis 255]

Ein Callback für dieses Event kann durch Senden des Payloads "true" an das .../register/red_brick/<UID>/process_state_changed[/<SUFFIX>]-Topic hinzugefügt werden. Ein hinzugefügtes Callback kann durch Senden des Payloads "false" an das selbe Topic wieder entfernt werden. Um mehrere (De-)Registrierungen zu unterstützen, z.B. um Nachrichten filtern zu können, kann ein optionaler Suffix verwendet werden.

Wenn das Callback ausgelöst wird, wird dessen Payload für jeden Suffix auf dem entsprechenden .../callback/red_brick/<UID>/process_state_changed[/<SUFFIX>]-Topic veröffentlicht.

Die folgenden Symbole sind für diese Funktion verfügbar:

Für state:

"unknown" = 0
"running" = 1
"error" = 2
"exited" = 3
"killed" = 4
"stopped" = 5

register/red_brick/<UID>/program_scheduler_state_changed¶

Registrierungsanfrage:	register – Typ: bool
Callback-Antwort:	program_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]

Ein Callback für dieses Event kann durch Senden des Payloads "true" an das .../register/red_brick/<UID>/program_scheduler_state_changed[/<SUFFIX>]-Topic hinzugefügt werden. Ein hinzugefügtes Callback kann durch Senden des Payloads "false" an das selbe Topic wieder entfernt werden. Um mehrere (De-)Registrierungen zu unterstützen, z.B. um Nachrichten filtern zu können, kann ein optionaler Suffix verwendet werden.

Wenn das Callback ausgelöst wird, wird dessen Payload für jeden Suffix auf dem entsprechenden .../callback/red_brick/<UID>/program_scheduler_state_changed[/<SUFFIX>]-Topic veröffentlicht.

register/red_brick/<UID>/program_process_spawned¶

Registrierungsanfrage:	register – Typ: bool
Callback-Antwort:	program_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]

Ein Callback für dieses Event kann durch Senden des Payloads "true" an das .../register/red_brick/<UID>/program_process_spawned[/<SUFFIX>]-Topic hinzugefügt werden. Ein hinzugefügtes Callback kann durch Senden des Payloads "false" an das selbe Topic wieder entfernt werden. Um mehrere (De-)Registrierungen zu unterstützen, z.B. um Nachrichten filtern zu können, kann ein optionaler Suffix verwendet werden.

Wenn das Callback ausgelöst wird, wird dessen Payload für jeden Suffix auf dem entsprechenden .../callback/red_brick/<UID>/program_process_spawned[/<SUFFIX>]-Topic veröffentlicht.