Perl - RED Brick

Dies ist die Beschreibung der Perl 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 Perl API Bindings ist Teil deren allgemeine Beschreibung.

API

Allgemein kann jede Subroutine der Perl Bindings Fehler als Tinkerforge::Error Objekt mittels croak() melden. Das Objekt hat eine get_code() und eine get_message() Subroutine. Es sind verschiedene Fehlercodes definiert:

  • Error->ALREADY_CONNECTED = 11
  • Error->NOT_CONNECTED = 12
  • Error->CONNECT_FAILED = 13
  • Error->INVALID_FUNCTION_ID = 21
  • Error->TIMEOUT = 31
  • Error->INVALID_PARAMETER = 41
  • Error->FUNCTION_NOT_SUPPORTED = 42
  • Error->UNKNOWN_ERROR = 43
  • Error->STREAM_OUT_OF_SYNC = 51
  • Error->INVALID_UID = 61
  • Error->NON_ASCII_CHAR_IN_SECRET = 71
  • Error->WRONG_DEVICE_TYPE = 81
  • Error->DEVICE_REPLACED = 82

Alle folgend aufgelisteten Funktionen sind Thread-sicher.

Bemerkung

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

Fortgeschrittene Funktionen

BrickRED->create_session($lifetime)
Parameter:
  • $lifetime – Typ: int, Wertebereich: [0 bis 232 - 1]
Rückgabe-Array:
  • 0: $error_code – Typ: int, Wertebereich: Siehe Konstanten
  • 1: $session_id – Typ: int, Wertebereich: [0 bis 216 - 1]

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

Für $error_code:

  • 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($session_id)
Parameter:
  • $session_id – Typ: int, Wertebereich: [0 bis 216 - 1]
Rückgabe:
  • $error_code – Typ: int, Wertebereich: Siehe Konstanten

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

Für $error_code:

  • 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)
Parameter:
  • $session_id – Typ: int, Wertebereich: [0 bis 216 - 1]
Rückgabe:
  • undef
BrickRED->keep_session_alive($session_id, $lifetime)
Parameter:
  • $session_id – Typ: int, Wertebereich: [0 bis 216 - 1]
  • $lifetime – Typ: int, Wertebereich: [0 bis 232 - 1]
Rückgabe:
  • $error_code – Typ: int, Wertebereich: Siehe Konstanten

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

Für $error_code:

  • 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)
Parameter:
  • $object_id – Typ: int, Wertebereich: [0 bis 216 - 1]
  • $session_id – Typ: int, Wertebereich: [0 bis 216 - 1]
Rückgabe:
  • $error_code – Typ: int, Wertebereich: Siehe Konstanten

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

Für $error_code:

  • 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)
Parameter:
  • $object_id – Typ: int, Wertebereich: [0 bis 216 - 1]
  • $session_id – Typ: int, Wertebereich: [0 bis 216 - 1]
Rückgabe:
  • undef
BrickRED->allocate_string($length_to_reserve, $buffer, $session_id)
Parameter:
  • $length_to_reserve – Typ: int, Einheit: 1 B, Wertebereich: [0 bis 232 - 1]
  • $buffer – Typ: string, Länge: bis zu 58
  • $session_id – Typ: int, Wertebereich: [0 bis 216 - 1]
Rückgabe-Array:
  • 0: $error_code – Typ: int, Wertebereich: Siehe Konstanten
  • 1: $string_id – Typ: int, Wertebereich: [0 bis 216 - 1]

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

Für $error_code:

  • 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->truncate_string($string_id, $length)
Parameter:
  • $string_id – Typ: int, Wertebereich: [0 bis 216 - 1]
  • $length – Typ: int, Einheit: 1 B, Wertebereich: [0 bis 232 - 1]
Rückgabe:
  • $error_code – Typ: int, Wertebereich: Siehe Konstanten

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

Für $error_code:

  • 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)
Parameter:
  • $string_id – Typ: int, Wertebereich: [0 bis 216 - 1]
Rückgabe-Array:
  • 0: $error_code – Typ: int, Wertebereich: Siehe Konstanten
  • 1: $length – Typ: int, Einheit: 1 B, Wertebereich: [0 bis 232 - 1]

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

Für $error_code:

  • 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->set_string_chunk($string_id, $offset, $buffer)
Parameter:
  • $string_id – Typ: int, Wertebereich: [0 bis 216 - 1]
  • $offset – Typ: int, Einheit: 1 B, Wertebereich: [0 bis 232 - 1]
  • $buffer – Typ: string, Länge: bis zu 58
Rückgabe:
  • $error_code – Typ: int, Wertebereich: Siehe Konstanten

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

Für $error_code:

  • 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)
Parameter:
  • $string_id – Typ: int, Wertebereich: [0 bis 216 - 1]
  • $offset – Typ: int, Einheit: 1 B, Wertebereich: [0 bis 232 - 1]
Rückgabe-Array:
  • 0: $error_code – Typ: int, Wertebereich: Siehe Konstanten
  • 1: $buffer – Typ: string, Länge: bis zu 63

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

Für $error_code:

  • 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->allocate_list($length_to_reserve, $session_id)
Parameter:
  • $length_to_reserve – Typ: int, Wertebereich: [0 bis 216 - 1]
  • $session_id – Typ: int, Wertebereich: [0 bis 216 - 1]
Rückgabe-Array:
  • 0: $error_code – Typ: int, Wertebereich: Siehe Konstanten
  • 1: $list_id – Typ: int, Wertebereich: [0 bis 216 - 1]

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

Für $error_code:

  • 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_list_length($list_id)
Parameter:
  • $list_id – Typ: int, Wertebereich: [0 bis 216 - 1]
Rückgabe-Array:
  • 0: $error_code – Typ: int, Wertebereich: Siehe Konstanten
  • 1: $length – Typ: int, Wertebereich: [0 bis 216 - 1]

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

Für $error_code:

  • 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_list_item($list_id, $index, $session_id)
Parameter:
  • $list_id – Typ: int, Wertebereich: [0 bis 216 - 1]
  • $index – Typ: int, Wertebereich: [0 bis 216 - 1]
  • $session_id – Typ: int, Wertebereich: [0 bis 216 - 1]
Rückgabe-Array:
  • 0: $error_code – Typ: int, Wertebereich: Siehe Konstanten
  • 1: $item_object_id – Typ: int, Wertebereich: [0 bis 216 - 1]
  • 2: $type – Typ: int, Wertebereich: Siehe Konstanten

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

Für $error_code:

  • 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

Für $type:

  • 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
BrickRED->append_to_list($list_id, $item_object_id)
Parameter:
  • $list_id – Typ: int, Wertebereich: [0 bis 216 - 1]
  • $item_object_id – Typ: int, Wertebereich: [0 bis 216 - 1]
Rückgabe:
  • $error_code – Typ: int, Wertebereich: Siehe Konstanten

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

Für $error_code:

  • 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)
Parameter:
  • $list_id – Typ: int, Wertebereich: [0 bis 216 - 1]
  • $index – Typ: int, Wertebereich: [0 bis 216 - 1]
Rückgabe:
  • $error_code – Typ: int, Wertebereich: Siehe Konstanten

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

Für $error_code:

  • 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)
Parameter:
  • $name_string_id – Typ: int, Wertebereich: [0 bis 216 - 1]
  • $flags – Typ: int, Wertebereich: Siehe Konstanten
  • $permissions – Typ: int, Wertebereich: Siehe Konstanten
  • $uid – Typ: int, Wertebereich: [0 bis 232 - 1]
  • $gid – Typ: int, Wertebereich: [0 bis 232 - 1]
  • $session_id – Typ: int, Wertebereich: [0 bis 216 - 1]
Rückgabe-Array:
  • 0: $error_code – Typ: int, Wertebereich: Siehe Konstanten
  • 1: $file_id – Typ: int, Wertebereich: [0 bis 216 - 1]

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

Für $flags:

  • 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

Für $permissions:

  • 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

Für $error_code:

  • 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_pipe($flags, $length, $session_id)
Parameter:
  • $flags – Typ: int, Wertebereich: Siehe Konstanten
  • $length – Typ: int, Einheit: 1 B, Wertebereich: [0 bis 264 - 1]
  • $session_id – Typ: int, Wertebereich: [0 bis 216 - 1]
Rückgabe-Array:
  • 0: $error_code – Typ: int, Wertebereich: Siehe Konstanten
  • 1: $file_id – Typ: int, Wertebereich: [0 bis 216 - 1]

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

Für $flags:

  • BrickRED->PIPE_FLAG_NON_BLOCKING_READ = 1
  • BrickRED->PIPE_FLAG_NON_BLOCKING_WRITE = 2

Für $error_code:

  • 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_info($file_id, $session_id)
Parameter:
  • $file_id – Typ: int, Wertebereich: [0 bis 216 - 1]
  • $session_id – Typ: int, Wertebereich: [0 bis 216 - 1]
Rückgabe-Array:
  • 0: $error_code – Typ: int, Wertebereich: Siehe Konstanten
  • 1: $type – Typ: int, Wertebereich: Siehe Konstanten
  • 2: $name_string_id – Typ: int, Wertebereich: [0 bis 216 - 1]
  • 3: $flags – Typ: int, Wertebereich: Siehe Konstanten
  • 4: $permissions – Typ: int, Wertebereich: Siehe Konstanten
  • 5: $uid – Typ: int, Wertebereich: [0 bis 232 - 1]
  • 6: $gid – Typ: int, Wertebereich: [0 bis 232 - 1]
  • 7: $length – Typ: int, Einheit: 1 B, Wertebereich: [0 bis 264 - 1]
  • 8: $access_timestamp – Typ: int, Wertebereich: [0 bis 264 - 1]
  • 9: $modification_timestamp – Typ: int, Wertebereich: [0 bis 264 - 1]
  • 10: $status_change_timestamp – Typ: int, Wertebereich: [0 bis 264 - 1]

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

Für $error_code:

  • 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

Für $type:

  • 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

Für $flags:

  • 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

Für $permissions:

  • 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->read_file($file_id, $length_to_read)
Parameter:
  • $file_id – Typ: int, Wertebereich: [0 bis 216 - 1]
  • $length_to_read – Typ: int, Einheit: 1 B, Wertebereich: [0 bis 255]
Rückgabe-Array:
  • 0: $error_code – Typ: int, Wertebereich: Siehe Konstanten
  • 1: @buffer – Typ: [int, ...], Länge: 62, Wertebereich: [0 bis 255]
  • 2: $length_read – Typ: int, Einheit: 1 B, Wertebereich: [0 bis 255]

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

Für $error_code:

  • 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->read_file_async($file_id, $length_to_read)
Parameter:
  • $file_id – Typ: int, Wertebereich: [0 bis 216 - 1]
  • $length_to_read – Typ: int, Einheit: 1 B, Wertebereich: [0 bis 264 - 1]
Rückgabe:
  • undef
BrickRED->abort_async_file_read($file_id)
Parameter:
  • $file_id – Typ: int, Wertebereich: [0 bis 216 - 1]
Rückgabe:
  • $error_code – Typ: int, Wertebereich: Siehe Konstanten

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

Für $error_code:

  • 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)
Parameter:
  • $file_id – Typ: int, Wertebereich: [0 bis 216 - 1]
  • @buffer – Typ: [int, ...], Länge: 61, Wertebereich: [0 bis 255]
  • $length_to_write – Typ: int, Einheit: 1 B, Wertebereich: [0 bis 255]
Rückgabe-Array:
  • 0: $error_code – Typ: int, Wertebereich: Siehe Konstanten
  • 1: $length_written – Typ: int, Einheit: 1 B, Wertebereich: [0 bis 255]

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

Für $error_code:

  • 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_unchecked($file_id, @buffer, $length_to_write)
Parameter:
  • $file_id – Typ: int, Wertebereich: [0 bis 216 - 1]
  • @buffer – Typ: [int, ...], Länge: 61, Wertebereich: [0 bis 255]
  • $length_to_write – Typ: int, Einheit: 1 B, Wertebereich: [0 bis 255]
Rückgabe:
  • undef
BrickRED->write_file_async($file_id, @buffer, $length_to_write)
Parameter:
  • $file_id – Typ: int, Wertebereich: [0 bis 216 - 1]
  • @buffer – Typ: [int, ...], Länge: 61, Wertebereich: [0 bis 255]
  • $length_to_write – Typ: int, Einheit: 1 B, Wertebereich: [0 bis 255]
Rückgabe:
  • undef
BrickRED->set_file_position($file_id, $offset, $origin)
Parameter:
  • $file_id – Typ: int, Wertebereich: [0 bis 216 - 1]
  • $offset – Typ: int, Einheit: 1 B, Wertebereich: [-263 bis 263 - 1]
  • $origin – Typ: int, Wertebereich: Siehe Konstanten
Rückgabe-Array:
  • 0: $error_code – Typ: int, Wertebereich: Siehe Konstanten
  • 1: $position – Typ: int, Einheit: 1 B, Wertebereich: [0 bis 264 - 1]

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

Für $origin:

  • BrickRED->FILE_ORIGIN_BEGINNING = 0
  • BrickRED->FILE_ORIGIN_CURRENT = 1
  • BrickRED->FILE_ORIGIN_END = 2

Für $error_code:

  • 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_position($file_id)
Parameter:
  • $file_id – Typ: int, Wertebereich: [0 bis 216 - 1]
Rückgabe-Array:
  • 0: $error_code – Typ: int, Wertebereich: Siehe Konstanten
  • 1: $position – Typ: int, Einheit: 1 B, Wertebereich: [0 bis 264 - 1]

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

Für $error_code:

  • 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->set_file_events($file_id, $events)
Parameter:
  • $file_id – Typ: int, Wertebereich: [0 bis 216 - 1]
  • $events – Typ: int, Wertebereich: Siehe Konstanten
Rückgabe:
  • $error_code – Typ: int, Wertebereich: Siehe Konstanten

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

Für $events:

  • BrickRED->FILE_EVENT_READABLE = 1
  • BrickRED->FILE_EVENT_WRITABLE = 2

Für $error_code:

  • 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)
Parameter:
  • $file_id – Typ: int, Wertebereich: [0 bis 216 - 1]
Rückgabe-Array:
  • 0: $error_code – Typ: int, Wertebereich: Siehe Konstanten
  • 1: $events – Typ: int, Wertebereich: Siehe Konstanten

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

Für $error_code:

  • 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

Für $events:

  • BrickRED->FILE_EVENT_READABLE = 1
  • BrickRED->FILE_EVENT_WRITABLE = 2
BrickRED->open_directory($name_string_id, $session_id)
Parameter:
  • $name_string_id – Typ: int, Wertebereich: [0 bis 216 - 1]
  • $session_id – Typ: int, Wertebereich: [0 bis 216 - 1]
Rückgabe-Array:
  • 0: $error_code – Typ: int, Wertebereich: Siehe Konstanten
  • 1: $directory_id – Typ: int, Wertebereich: [0 bis 216 - 1]

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

Für $error_code:

  • 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_directory_name($directory_id, $session_id)
Parameter:
  • $directory_id – Typ: int, Wertebereich: [0 bis 216 - 1]
  • $session_id – Typ: int, Wertebereich: [0 bis 216 - 1]
Rückgabe-Array:
  • 0: $error_code – Typ: int, Wertebereich: Siehe Konstanten
  • 1: $name_string_id – Typ: int, Wertebereich: [0 bis 216 - 1]

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

Für $error_code:

  • 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_next_directory_entry($directory_id, $session_id)
Parameter:
  • $directory_id – Typ: int, Wertebereich: [0 bis 216 - 1]
  • $session_id – Typ: int, Wertebereich: [0 bis 216 - 1]
Rückgabe-Array:
  • 0: $error_code – Typ: int, Wertebereich: Siehe Konstanten
  • 1: $name_string_id – Typ: int, Wertebereich: [0 bis 216 - 1]
  • 2: $type – Typ: int, Wertebereich: Siehe Konstanten

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

Für $error_code:

  • 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

Für $type:

  • 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
BrickRED->rewind_directory($directory_id)
Parameter:
  • $directory_id – Typ: int, Wertebereich: [0 bis 216 - 1]
Rückgabe:
  • $error_code – Typ: int, Wertebereich: Siehe Konstanten

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

Für $error_code:

  • 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)
Parameter:
  • $name_string_id – Typ: int, Wertebereich: [0 bis 216 - 1]
  • $flags – Typ: int, Wertebereich: Siehe Konstanten
  • $permissions – Typ: int, Wertebereich: Siehe Konstanten
  • $uid – Typ: int, Wertebereich: [0 bis 232 - 1]
  • $gid – Typ: int, Wertebereich: [0 bis 232 - 1]
Rückgabe:
  • $error_code – Typ: int, Wertebereich: Siehe Konstanten

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

Für $flags:

  • BrickRED->DIRECTORY_FLAG_RECURSIVE = 1
  • BrickRED->DIRECTORY_FLAG_EXCLUSIVE = 2

Für $permissions:

  • 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

Für $error_code:

  • 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)
Parameter:
  • $session_id – Typ: int, Wertebereich: [0 bis 216 - 1]
Rückgabe-Array:
  • 0: $error_code – Typ: int, Wertebereich: Siehe Konstanten
  • 1: $processes_list_id – Typ: int, Wertebereich: [0 bis 216 - 1]

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

Für $error_code:

  • 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->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)
Parameter:
  • $executable_string_id – Typ: int, Wertebereich: [0 bis 216 - 1]
  • $arguments_list_id – Typ: int, Wertebereich: [0 bis 216 - 1]
  • $environment_list_id – Typ: int, Wertebereich: [0 bis 216 - 1]
  • $working_directory_string_id – Typ: int, Wertebereich: [0 bis 216 - 1]
  • $uid – Typ: int, Wertebereich: [0 bis 232 - 1]
  • $gid – Typ: int, Wertebereich: [0 bis 232 - 1]
  • $stdin_file_id – Typ: int, Wertebereich: [0 bis 216 - 1]
  • $stdout_file_id – Typ: int, Wertebereich: [0 bis 216 - 1]
  • $stderr_file_id – Typ: int, Wertebereich: [0 bis 216 - 1]
  • $session_id – Typ: int, Wertebereich: [0 bis 216 - 1]
Rückgabe-Array:
  • 0: $error_code – Typ: int, Wertebereich: Siehe Konstanten
  • 1: $process_id – Typ: int, Wertebereich: [0 bis 216 - 1]

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

Für $error_code:

  • 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->kill_process($process_id, $signal)
Parameter:
  • $process_id – Typ: int, Wertebereich: [0 bis 216 - 1]
  • $signal – Typ: int, Wertebereich: Siehe Konstanten
Rückgabe:
  • $error_code – Typ: int, Wertebereich: Siehe Konstanten

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

Für $signal:

  • 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

Für $error_code:

  • 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)
Parameter:
  • $process_id – Typ: int, Wertebereich: [0 bis 216 - 1]
  • $session_id – Typ: int, Wertebereich: [0 bis 216 - 1]
Rückgabe-Array:
  • 0: $error_code – Typ: int, Wertebereich: Siehe Konstanten
  • 1: $executable_string_id – Typ: int, Wertebereich: [0 bis 216 - 1]
  • 2: $arguments_list_id – Typ: int, Wertebereich: [0 bis 216 - 1]
  • 3: $environment_list_id – Typ: int, Wertebereich: [0 bis 216 - 1]
  • 4: $working_directory_string_id – Typ: int, Wertebereich: [0 bis 216 - 1]

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

Für $error_code:

  • 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_identity($process_id)
Parameter:
  • $process_id – Typ: int, Wertebereich: [0 bis 216 - 1]
Rückgabe-Array:
  • 0: $error_code – Typ: int, Wertebereich: Siehe Konstanten
  • 1: $pid – Typ: int, Wertebereich: [0 bis 232 - 1]
  • 2: $uid – Typ: int, Wertebereich: [0 bis 232 - 1]
  • 3: $gid – Typ: int, Wertebereich: [0 bis 232 - 1]

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

Für $error_code:

  • 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_stdio($process_id, $session_id)
Parameter:
  • $process_id – Typ: int, Wertebereich: [0 bis 216 - 1]
  • $session_id – Typ: int, Wertebereich: [0 bis 216 - 1]
Rückgabe-Array:
  • 0: $error_code – Typ: int, Wertebereich: Siehe Konstanten
  • 1: $stdin_file_id – Typ: int, Wertebereich: [0 bis 216 - 1]
  • 2: $stdout_file_id – Typ: int, Wertebereich: [0 bis 216 - 1]
  • 3: $stderr_file_id – Typ: int, Wertebereich: [0 bis 216 - 1]

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

Für $error_code:

  • 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_state($process_id)
Parameter:
  • $process_id – Typ: int, Wertebereich: [0 bis 216 - 1]
Rückgabe-Array:
  • 0: $error_code – Typ: int, Wertebereich: Siehe Konstanten
  • 1: $state – Typ: int, Wertebereich: Siehe Konstanten
  • 2: $timestamp – Typ: int, Wertebereich: [0 bis 264 - 1]
  • 3: $exit_code – Typ: int, Wertebereich: [0 bis 255]

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

Für $error_code:

  • 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

Für $state:

  • 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->get_programs($session_id)
Parameter:
  • $session_id – Typ: int, Wertebereich: [0 bis 216 - 1]
Rückgabe-Array:
  • 0: $error_code – Typ: int, Wertebereich: Siehe Konstanten
  • 1: $programs_list_id – Typ: int, Wertebereich: [0 bis 216 - 1]

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

Für $error_code:

  • 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->define_program($identifier_string_id, $session_id)
Parameter:
  • $identifier_string_id – Typ: int, Wertebereich: [0 bis 216 - 1]
  • $session_id – Typ: int, Wertebereich: [0 bis 216 - 1]
Rückgabe-Array:
  • 0: $error_code – Typ: int, Wertebereich: Siehe Konstanten
  • 1: $program_id – Typ: int, Wertebereich: [0 bis 216 - 1]

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

Für $error_code:

  • 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->purge_program($program_id, $cookie)
Parameter:
  • $program_id – Typ: int, Wertebereich: [0 bis 216 - 1]
  • $cookie – Typ: int, Wertebereich: [0 bis 232 - 1]
Rückgabe:
  • $error_code – Typ: int, Wertebereich: Siehe Konstanten

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

Für $error_code:

  • 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)
Parameter:
  • $program_id – Typ: int, Wertebereich: [0 bis 216 - 1]
  • $session_id – Typ: int, Wertebereich: [0 bis 216 - 1]
Rückgabe-Array:
  • 0: $error_code – Typ: int, Wertebereich: Siehe Konstanten
  • 1: $identifier_string_id – Typ: int, Wertebereich: [0 bis 216 - 1]

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

Für $error_code:

  • 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_root_directory($program_id, $session_id)
Parameter:
  • $program_id – Typ: int, Wertebereich: [0 bis 216 - 1]
  • $session_id – Typ: int, Wertebereich: [0 bis 216 - 1]
Rückgabe-Array:
  • 0: $error_code – Typ: int, Wertebereich: Siehe Konstanten
  • 1: $root_directory_string_id – Typ: int, Wertebereich: [0 bis 216 - 1]

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

Für $error_code:

  • 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->set_program_command($program_id, $executable_string_id, $arguments_list_id, $environment_list_id, $working_directory_string_id)
Parameter:
  • $program_id – Typ: int, Wertebereich: [0 bis 216 - 1]
  • $executable_string_id – Typ: int, Wertebereich: [0 bis 216 - 1]
  • $arguments_list_id – Typ: int, Wertebereich: [0 bis 216 - 1]
  • $environment_list_id – Typ: int, Wertebereich: [0 bis 216 - 1]
  • $working_directory_string_id – Typ: int, Wertebereich: [0 bis 216 - 1]
Rückgabe:
  • $error_code – Typ: int, Wertebereich: Siehe Konstanten

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

Für $error_code:

  • 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)
Parameter:
  • $program_id – Typ: int, Wertebereich: [0 bis 216 - 1]
  • $session_id – Typ: int, Wertebereich: [0 bis 216 - 1]
Rückgabe-Array:
  • 0: $error_code – Typ: int, Wertebereich: Siehe Konstanten
  • 1: $executable_string_id – Typ: int, Wertebereich: [0 bis 216 - 1]
  • 2: $arguments_list_id – Typ: int, Wertebereich: [0 bis 216 - 1]
  • 3: $environment_list_id – Typ: int, Wertebereich: [0 bis 216 - 1]
  • 4: $working_directory_string_id – Typ: int, Wertebereich: [0 bis 216 - 1]

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

Für $error_code:

  • 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->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)
Parameter:
  • $program_id – Typ: int, Wertebereich: [0 bis 216 - 1]
  • $stdin_redirection – Typ: int, Wertebereich: Siehe Konstanten
  • $stdin_file_name_string_id – Typ: int, Wertebereich: [0 bis 216 - 1]
  • $stdout_redirection – Typ: int, Wertebereich: Siehe Konstanten
  • $stdout_file_name_string_id – Typ: int, Wertebereich: [0 bis 216 - 1]
  • $stderr_redirection – Typ: int, Wertebereich: Siehe Konstanten
  • $stderr_file_name_string_id – Typ: int, Wertebereich: [0 bis 216 - 1]
Rückgabe:
  • $error_code – Typ: int, Wertebereich: Siehe Konstanten

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

Für $stdin_redirection:

  • 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

Für $stdout_redirection:

  • 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

Für $stderr_redirection:

  • 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

Für $error_code:

  • 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)
Parameter:
  • $program_id – Typ: int, Wertebereich: [0 bis 216 - 1]
  • $session_id – Typ: int, Wertebereich: [0 bis 216 - 1]
Rückgabe-Array:
  • 0: $error_code – Typ: int, Wertebereich: Siehe Konstanten
  • 1: $stdin_redirection – Typ: int, Wertebereich: Siehe Konstanten
  • 2: $stdin_file_name_string_id – Typ: int, Wertebereich: [0 bis 216 - 1]
  • 3: $stdout_redirection – Typ: int, Wertebereich: Siehe Konstanten
  • 4: $stdout_file_name_string_id – Typ: int, Wertebereich: [0 bis 216 - 1]
  • 5: $stderr_redirection – Typ: int, Wertebereich: Siehe Konstanten
  • 6: $stderr_file_name_string_id – Typ: int, Wertebereich: [0 bis 216 - 1]

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

Für $error_code:

  • 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

Für $stdin_redirection:

  • 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

Für $stdout_redirection:

  • 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

Für $stderr_redirection:

  • 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->set_program_schedule($program_id, $start_mode, $continue_after_error, $start_interval, $start_fields_string_id)
Parameter:
  • $program_id – Typ: int, Wertebereich: [0 bis 216 - 1]
  • $start_mode – Typ: int, Wertebereich: Siehe Konstanten
  • $continue_after_error – Typ: bool
  • $start_interval – Typ: int, Wertebereich: [0 bis 232 - 1]
  • $start_fields_string_id – Typ: int, Wertebereich: [0 bis 216 - 1]
Rückgabe:
  • $error_code – Typ: int, Wertebereich: Siehe Konstanten

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

Für $start_mode:

  • BrickRED->PROGRAM_START_MODE_NEVER = 0
  • BrickRED->PROGRAM_START_MODE_ALWAYS = 1
  • BrickRED->PROGRAM_START_MODE_INTERVAL = 2
  • BrickRED->PROGRAM_START_MODE_CRON = 3

Für $error_code:

  • 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)
Parameter:
  • $program_id – Typ: int, Wertebereich: [0 bis 216 - 1]
  • $session_id – Typ: int, Wertebereich: [0 bis 216 - 1]
Rückgabe-Array:
  • 0: $error_code – Typ: int, Wertebereich: Siehe Konstanten
  • 1: $start_mode – Typ: int, Wertebereich: Siehe Konstanten
  • 2: $continue_after_error – Typ: bool
  • 3: $start_interval – Typ: int, Wertebereich: [0 bis 232 - 1]
  • 4: $start_fields_string_id – Typ: int, Wertebereich: [0 bis 216 - 1]

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

Für $error_code:

  • 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

Für $start_mode:

  • 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->get_program_scheduler_state($program_id, $session_id)
Parameter:
  • $program_id – Typ: int, Wertebereich: [0 bis 216 - 1]
  • $session_id – Typ: int, Wertebereich: [0 bis 216 - 1]
Rückgabe-Array:
  • 0: $error_code – Typ: int, Wertebereich: Siehe Konstanten
  • 1: $state – Typ: int, Wertebereich: Siehe Konstanten
  • 2: $timestamp – Typ: int, Wertebereich: [0 bis 264 - 1]
  • 3: $message_string_id – Typ: int, Wertebereich: [0 bis 216 - 1]

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

Für $error_code:

  • 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

Für $state:

  • BrickRED->PROGRAM_SCHEDULER_STATE_STOPPED = 0
  • BrickRED->PROGRAM_SCHEDULER_STATE_RUNNING = 1
BrickRED->continue_program_schedule($program_id)
Parameter:
  • $program_id – Typ: int, Wertebereich: [0 bis 216 - 1]
Rückgabe:
  • $error_code – Typ: int, Wertebereich: Siehe Konstanten

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

Für $error_code:

  • 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)
Parameter:
  • $program_id – Typ: int, Wertebereich: [0 bis 216 - 1]
Rückgabe:
  • $error_code – Typ: int, Wertebereich: Siehe Konstanten

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

Für $error_code:

  • 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)
Parameter:
  • $program_id – Typ: int, Wertebereich: [0 bis 216 - 1]
  • $session_id – Typ: int, Wertebereich: [0 bis 216 - 1]
Rückgabe-Array:
  • 0: $error_code – Typ: int, Wertebereich: Siehe Konstanten
  • 1: $process_id – Typ: int, Wertebereich: [0 bis 216 - 1]
  • 2: $timestamp – Typ: int, Wertebereich: [0 bis 264 - 1]

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

Für $error_code:

  • 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_names($program_id, $session_id)
Parameter:
  • $program_id – Typ: int, Wertebereich: [0 bis 216 - 1]
  • $session_id – Typ: int, Wertebereich: [0 bis 216 - 1]
Rückgabe-Array:
  • 0: $error_code – Typ: int, Wertebereich: Siehe Konstanten
  • 1: $names_list_id – Typ: int, Wertebereich: [0 bis 216 - 1]

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

Für $error_code:

  • 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->set_custom_program_option_value($program_id, $name_string_id, $value_string_id)
Parameter:
  • $program_id – Typ: int, Wertebereich: [0 bis 216 - 1]
  • $name_string_id – Typ: int, Wertebereich: [0 bis 216 - 1]
  • $value_string_id – Typ: int, Wertebereich: [0 bis 216 - 1]
Rückgabe:
  • $error_code – Typ: int, Wertebereich: Siehe Konstanten

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

Für $error_code:

  • 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)
Parameter:
  • $program_id – Typ: int, Wertebereich: [0 bis 216 - 1]
  • $name_string_id – Typ: int, Wertebereich: [0 bis 216 - 1]
  • $session_id – Typ: int, Wertebereich: [0 bis 216 - 1]
Rückgabe-Array:
  • 0: $error_code – Typ: int, Wertebereich: Siehe Konstanten
  • 1: $value_string_id – Typ: int, Wertebereich: [0 bis 216 - 1]

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

Für $error_code:

  • 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_custom_program_option($program_id, $name_string_id)
Parameter:
  • $program_id – Typ: int, Wertebereich: [0 bis 216 - 1]
  • $name_string_id – Typ: int, Wertebereich: [0 bis 216 - 1]
Rückgabe:
  • $error_code – Typ: int, Wertebereich: Siehe Konstanten

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

Für $error_code:

  • 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_identity()
Rückgabe-Array:
  • 0: $uid – Typ: string, Länge: bis zu 8
  • 1: $connected_uid – Typ: string, Länge: bis zu 8
  • 2: $position – Typ: char, Wertebereich: ['0' bis '8']
  • 3: @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]
  • 4: @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]
  • 5: $device_identifier – Typ: int, Wertebereich: [0 bis 216 - 1]

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. Es gibt auch eine Konstante für den Device Identifier dieses Bricks.

Konfigurationsfunktionen für Callbacks

BrickRED->register_callback($callback_id, $function)
Parameter:
  • $callback_id – Typ: int
  • $function – Typ: string
Rückgabe:
  • undef

Registriert den $function Namen für die gegebene $callback_id.

Die verfügbaren Callback IDs mit den zugehörigen Funktionssignaturen sind unten zu finden.

Callbacks

Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung kann mit der Funktion register_callback() des Geräte Objektes durchgeführt werden. Der erste Parameter ist die Callback ID und der zweite Parameter ist der Name der Callback-Funktion:

sub my_callback
{
    print "@_[0]";
}

$red->register_callback(BrickRED->CALLBACK_EXAMPLE, 'my_callback')

Die Callback Funktion wird dann von einem internen Thread der IP Connection aufgerufen werden. Im Gegensatz zu vielen anderen Programmiersprachen werden Variablen nicht automatisch zwischen Threads geteilt. Wenn eine Variable gleichzeitig in einer Callback Funktion und dem Rest des Programms genutzt werden soll, dann muss diese als :shared markiert werden. Siehe dazu auch die Dokumentation des threads::shared Perl Moduls für weitere Details.

Die verfügbaren IDs mit der dazugehörigen Parameteranzahl und -typen werden weiter unten beschrieben.

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.

BrickRED->CALLBACK_ASYNC_FILE_READ
Callback-Parameter:
  • $file_id – Typ: int, Wertebereich: [0 bis 216 - 1]
  • $error_code – Typ: int, Wertebereich: Siehe Konstanten
  • @buffer – Typ: [int, ...], Länge: 60, Wertebereich: [0 bis 255]
  • $length_read – Typ: int, Einheit: 1 B, Wertebereich: [0 bis 255]

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

Für $error_code:

  • 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
Callback-Parameter:
  • $file_id – Typ: int, Wertebereich: [0 bis 216 - 1]
  • $error_code – Typ: int, Wertebereich: Siehe Konstanten
  • $length_written – Typ: int, Einheit: 1 B, Wertebereich: [0 bis 255]

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

Für $error_code:

  • 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
Callback-Parameter:
  • $file_id – Typ: int, Wertebereich: [0 bis 216 - 1]
  • $events – Typ: int, Wertebereich: Siehe Konstanten

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

Für $events:

  • BrickRED->FILE_EVENT_READABLE = 1
  • BrickRED->FILE_EVENT_WRITABLE = 2
BrickRED->CALLBACK_PROCESS_STATE_CHANGED
Callback-Parameter:
  • $process_id – Typ: int, Wertebereich: [0 bis 216 - 1]
  • $state – Typ: int, Wertebereich: Siehe Konstanten
  • $timestamp – Typ: int, Wertebereich: [0 bis 264 - 1]
  • $exit_code – Typ: int, Wertebereich: [0 bis 255]

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

Für $state:

  • 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
Callback-Parameter:
  • $program_id – Typ: int, Wertebereich: [0 bis 216 - 1]
BrickRED->CALLBACK_PROGRAM_PROCESS_SPAWNED
Callback-Parameter:
  • $program_id – Typ: int, Wertebereich: [0 bis 216 - 1]

Virtuelle Funktionen

Virtuelle Funktionen kommunizieren nicht mit dem Gerät selbst, sie arbeiten nur auf dem API Bindings Objekt. Dadurch können sie auch aufgerufen werden, ohne das das dazugehörige IP Connection Objekt verbunden ist.

BrickRED->get_api_version()
Rückgabe-Array:
  • 0: @api_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]

Gibt die Version der API Definition zurück, die diese API Bindings implementieren. Dies ist weder die Release-Version dieser API Bindings noch gibt es in irgendeiner Weise Auskunft über den oder das repräsentierte(n) Brick oder Bricklet.

BrickRED->get_response_expected($function_id)
Parameter:
  • $function_id – Typ: int, Wertebereich: Siehe Konstanten
Rückgabe:
  • $response_expected – Typ: bool

Gibt das Response-Expected-Flag für die Funktion mit der angegebenen Funktions IDs zurück. Es ist true falls für die Funktion beim Aufruf eine Antwort erwartet wird, false andernfalls.

Für Getter-Funktionen ist diese Flag immer gesetzt und kann nicht entfernt werden, da diese Funktionen immer eine Antwort senden. Für Konfigurationsfunktionen für Callbacks ist es standardmäßig gesetzt, kann aber entfernt werden mittels set_response_expected(). Für Setter-Funktionen ist es standardmäßig nicht gesetzt, kann aber gesetzt werden.

Wenn das Response-Expected-Flag für eine Setter-Funktion gesetzt ist, können Timeouts und andere Fehlerfälle auch für Aufrufe dieser Setter-Funktion detektiert werden. Das Gerät sendet dann eine Antwort extra für diesen Zweck. Wenn das Flag für eine Setter-Funktion nicht gesetzt ist, dann wird keine Antwort vom Gerät gesendet und Fehler werden stillschweigend ignoriert, da sie nicht detektiert werden können.

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

Für $function_id:

  • 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($function_id, $response_expected)
Parameter:
  • $function_id – Typ: int, Wertebereich: Siehe Konstanten
  • $response_expected – Typ: bool
Rückgabe:
  • undef

Ändert das Response-Expected-Flag für die Funktion mit der angegebenen Funktion IDs. Diese Flag kann nur für Setter-Funktionen (Standardwert: false) und Konfigurationsfunktionen für Callbacks (Standardwert: true) geändert werden. Für Getter-Funktionen ist das Flag immer gesetzt.

Wenn das Response-Expected-Flag für eine Setter-Funktion gesetzt ist, können Timeouts und andere Fehlerfälle auch für Aufrufe dieser Setter-Funktion detektiert werden. Das Gerät sendet dann eine Antwort extra für diesen Zweck. Wenn das Flag für eine Setter-Funktion nicht gesetzt ist, dann wird keine Antwort vom Gerät gesendet und Fehler werden stillschweigend ignoriert, da sie nicht detektiert werden können.

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

Für $function_id:

  • 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)
Parameter:
  • $response_expected – Typ: bool
Rückgabe:
  • undef

Ändert das Response-Expected-Flag für alle Setter-Funktionen und Konfigurationsfunktionen für Callbacks diese Gerätes.

Konstanten

BrickRED->DEVICE_IDENTIFIER

Diese Konstante wird verwendet um einen RED Brick zu identifizieren.

Die get_identity() Funktion und der IPConnection->CALLBACK_ENUMERATE Callback der IP Connection haben ein device_identifier Parameter um den Typ des Bricks oder Bricklets anzugeben.

BrickRED->DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines RED Brick dar.