PHP - RED Brick¶

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

API¶

Funktion die mehrere Werte zurückgeben geben diese in einem assoziativen Array zurück.

Bemerkung

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

Fortgeschrittene Funktionen¶

array BrickRED::createSession(int $lifetime)¶

Parameter:	$lifetime – Typ: int, Wertebereich: [0 bis 2³² - 1]
Rückgabe-Array:	'error_code' – Typ: int, Wertebereich: Siehe Konstanten 'session_id' – Typ: int, Wertebereich: [0 bis 2¹⁶ - 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

int BrickRED::expireSession(int $session_id)¶

Parameter:	$session_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 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

void BrickRED::expireSessionUnchecked(int $session_id)¶

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

int BrickRED::keepSessionAlive(int $session_id, int $lifetime)¶

Parameter:	$session_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] $lifetime – Typ: int, Wertebereich: [0 bis 2³² - 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

int BrickRED::releaseObject(int $object_id, int $session_id)¶

Parameter:	$object_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] $session_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 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

void BrickRED::releaseObjectUnchecked(int $object_id, int $session_id)¶

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

array BrickRED::allocateString(int $length_to_reserve, string $buffer, int $session_id)¶

Parameter:	$length_to_reserve – Typ: int, Einheit: 1 B, Wertebereich: [0 bis 2³² - 1] $buffer – Typ: string, Länge: bis zu 58 $session_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]
Rückgabe-Array:	'error_code' – Typ: int, Wertebereich: Siehe Konstanten 'string_id' – Typ: int, Wertebereich: [0 bis 2¹⁶ - 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

int BrickRED::truncateString(int $string_id, int $length)¶

Parameter:	$string_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] $length – Typ: int, Einheit: 1 B, Wertebereich: [0 bis 2³² - 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

array BrickRED::getStringLength(int $string_id)¶

Parameter:	$string_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]
Rückgabe-Array:	'error_code' – Typ: int, Wertebereich: Siehe Konstanten 'length' – Typ: int, Einheit: 1 B, Wertebereich: [0 bis 2³² - 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

int BrickRED::setStringChunk(int $string_id, int $offset, string $buffer)¶

Parameter:	$string_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] $offset – Typ: int, Einheit: 1 B, Wertebereich: [0 bis 2³² - 1] $buffer – Typ: string, Länge: bis zu 58
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

array BrickRED::getStringChunk(int $string_id, int $offset)¶

Parameter:	$string_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] $offset – Typ: int, Einheit: 1 B, Wertebereich: [0 bis 2³² - 1]
Rückgabe-Array:	'error_code' – Typ: int, Wertebereich: Siehe Konstanten '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

array BrickRED::allocateList(int $length_to_reserve, int $session_id)¶

Parameter:	$length_to_reserve – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] $session_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]
Rückgabe-Array:	'error_code' – Typ: int, Wertebereich: Siehe Konstanten 'list_id' – Typ: int, Wertebereich: [0 bis 2¹⁶ - 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

array BrickRED::getListLength(int $list_id)¶

Parameter:	$list_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]
Rückgabe-Array:	'error_code' – Typ: int, Wertebereich: Siehe Konstanten 'length' – Typ: int, Wertebereich: [0 bis 2¹⁶ - 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

array BrickRED::getListItem(int $list_id, int $index, int $session_id)¶

Parameter:	$list_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] $index – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] $session_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]
Rückgabe-Array:	'error_code' – Typ: int, Wertebereich: Siehe Konstanten 'item_object_id' – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] '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

int BrickRED::appendToList(int $list_id, int $item_object_id)¶

Parameter:	$list_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] $item_object_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 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

int BrickRED::removeFromList(int $list_id, int $index)¶

Parameter:	$list_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] $index – Typ: int, Wertebereich: [0 bis 2¹⁶ - 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

array BrickRED::openFile(int $name_string_id, int $flags, int $permissions, int $uid, int $gid, int $session_id)¶

Parameter:	$name_string_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] $flags – Typ: int, Wertebereich: Siehe Konstanten $permissions – Typ: int, Wertebereich: Siehe Konstanten $uid – Typ: int, Wertebereich: [0 bis 2³² - 1] $gid – Typ: int, Wertebereich: [0 bis 2³² - 1] $session_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]
Rückgabe-Array:	'error_code' – Typ: int, Wertebereich: Siehe Konstanten 'file_id' – Typ: int, Wertebereich: [0 bis 2¹⁶ - 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

array BrickRED::createPipe(int $flags, int $length, int $session_id)¶

Parameter:	$flags – Typ: int, Wertebereich: Siehe Konstanten $length – Typ: int, Einheit: 1 B, Wertebereich: [0 bis 2⁶⁴ - 1] $session_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]
Rückgabe-Array:	'error_code' – Typ: int, Wertebereich: Siehe Konstanten 'file_id' – Typ: int, Wertebereich: [0 bis 2¹⁶ - 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

array BrickRED::getFileInfo(int $file_id, int $session_id)¶

Parameter:

Parameter:	$file_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] $session_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]
Rückgabe-Array:	'error_code' – Typ: int, Wertebereich: Siehe Konstanten 'type' – Typ: int, Wertebereich: Siehe Konstanten 'name_string_id' – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] 'flags' – Typ: int, Wertebereich: Siehe Konstanten 'permissions' – Typ: int, Wertebereich: Siehe Konstanten 'uid' – Typ: int, Wertebereich: [0 bis 2³² - 1] 'gid' – Typ: int, Wertebereich: [0 bis 2³² - 1] 'length' – Typ: int, Einheit: 1 B, Wertebereich: [0 bis 2⁶⁴ - 1] 'access_timestamp' – Typ: int, Wertebereich: [0 bis 2⁶⁴ - 1] 'modification_timestamp' – Typ: int, Wertebereich: [0 bis 2⁶⁴ - 1] 'status_change_timestamp' – Typ: int, Wertebereich: [0 bis 2⁶⁴ - 1]

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

Rückgabe-Array:

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

Die folgenden 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

array BrickRED::readFile(int $file_id, int $length_to_read)¶

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

void BrickRED::readFileAsync(int $file_id, int $length_to_read)¶

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

int BrickRED::abortAsyncFileRead(int $file_id)¶

Parameter:	$file_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 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

array BrickRED::writeFile(int $file_id, array $buffer, int $length_to_write)¶

Parameter:	$file_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] $buffer – Typ: array(int, ...), Länge: 61, Wertebereich: [0 bis 255] $length_to_write – Typ: int, Einheit: 1 B, Wertebereich: [0 bis 255]
Rückgabe-Array:	'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

void BrickRED::writeFileUnchecked(int $file_id, array $buffer, int $length_to_write)¶

Parameter:	$file_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] $buffer – Typ: array(int, ...), Länge: 61, Wertebereich: [0 bis 255] $length_to_write – Typ: int, Einheit: 1 B, Wertebereich: [0 bis 255]

void BrickRED::writeFileAsync(int $file_id, array $buffer, int $length_to_write)¶

Parameter:	$file_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] $buffer – Typ: array(int, ...), Länge: 61, Wertebereich: [0 bis 255] $length_to_write – Typ: int, Einheit: 1 B, Wertebereich: [0 bis 255]

array BrickRED::setFilePosition(int $file_id, int $offset, int $origin)¶

Parameter:	$file_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] $offset – Typ: int, Einheit: 1 B, Wertebereich: [-2⁶³ bis 2⁶³ - 1] $origin – Typ: int, Wertebereich: Siehe Konstanten
Rückgabe-Array:	'error_code' – Typ: int, Wertebereich: Siehe Konstanten 'position' – Typ: int, Einheit: 1 B, Wertebereich: [0 bis 2⁶⁴ - 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

array BrickRED::getFilePosition(int $file_id)¶

Parameter:	$file_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]
Rückgabe-Array:	'error_code' – Typ: int, Wertebereich: Siehe Konstanten 'position' – Typ: int, Einheit: 1 B, Wertebereich: [0 bis 2⁶⁴ - 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

int BrickRED::setFileEvents(int $file_id, int $events)¶

Parameter:	$file_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 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

array BrickRED::getFileEvents(int $file_id)¶

Parameter:	$file_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]
Rückgabe-Array:	'error_code' – Typ: int, Wertebereich: Siehe Konstanten '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

array BrickRED::openDirectory(int $name_string_id, int $session_id)¶

Parameter:	$name_string_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] $session_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]
Rückgabe-Array:	'error_code' – Typ: int, Wertebereich: Siehe Konstanten 'directory_id' – Typ: int, Wertebereich: [0 bis 2¹⁶ - 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

array BrickRED::getDirectoryName(int $directory_id, int $session_id)¶

Parameter:	$directory_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] $session_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]
Rückgabe-Array:	'error_code' – Typ: int, Wertebereich: Siehe Konstanten 'name_string_id' – Typ: int, Wertebereich: [0 bis 2¹⁶ - 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

array BrickRED::getNextDirectoryEntry(int $directory_id, int $session_id)¶

Parameter:	$directory_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] $session_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]
Rückgabe-Array:	'error_code' – Typ: int, Wertebereich: Siehe Konstanten 'name_string_id' – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] '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

int BrickRED::rewindDirectory(int $directory_id)¶

Parameter:	$directory_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 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

int BrickRED::createDirectory(int $name_string_id, int $flags, int $permissions, int $uid, int $gid)¶

Parameter:	$name_string_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] $flags – Typ: int, Wertebereich: Siehe Konstanten $permissions – Typ: int, Wertebereich: Siehe Konstanten $uid – Typ: int, Wertebereich: [0 bis 2³² - 1] $gid – Typ: int, Wertebereich: [0 bis 2³² - 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

array BrickRED::getProcesses(int $session_id)¶

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

array BrickRED::spawnProcess(int $executable_string_id, int $arguments_list_id, int $environment_list_id, int $working_directory_string_id, int $uid, int $gid, int $stdin_file_id, int $stdout_file_id, int $stderr_file_id, int $session_id)¶

Parameter:

Parameter:	$executable_string_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] $arguments_list_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] $environment_list_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] $working_directory_string_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] $uid – Typ: int, Wertebereich: [0 bis 2³² - 1] $gid – Typ: int, Wertebereich: [0 bis 2³² - 1] $stdin_file_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] $stdout_file_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] $stderr_file_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] $session_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]
Rückgabe-Array:	'error_code' – Typ: int, Wertebereich: Siehe Konstanten 'process_id' – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]

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

Rückgabe-Array:

'error_code' – Typ: int, Wertebereich: Siehe Konstanten
'process_id' – Typ: int, Wertebereich: [0 bis 2¹⁶ - 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

int BrickRED::killProcess(int $process_id, int $signal)¶

Parameter:	$process_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 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

array BrickRED::getProcessCommand(int $process_id, int $session_id)¶

Parameter:	$process_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] $session_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]
Rückgabe-Array:	'error_code' – Typ: int, Wertebereich: Siehe Konstanten 'executable_string_id' – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] 'arguments_list_id' – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] 'environment_list_id' – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] 'working_directory_string_id' – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]

Die folgenden 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

array BrickRED::getProcessIdentity(int $process_id)¶

Parameter:	$process_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]
Rückgabe-Array:	'error_code' – Typ: int, Wertebereich: Siehe Konstanten 'pid' – Typ: int, Wertebereich: [0 bis 2³² - 1] 'uid' – Typ: int, Wertebereich: [0 bis 2³² - 1] 'gid' – Typ: int, Wertebereich: [0 bis 2³² - 1]

Die folgenden 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

array BrickRED::getProcessStdio(int $process_id, int $session_id)¶

Parameter:	$process_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] $session_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]
Rückgabe-Array:	'error_code' – Typ: int, Wertebereich: Siehe Konstanten 'stdin_file_id' – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] 'stdout_file_id' – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] 'stderr_file_id' – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]

Die folgenden 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

array BrickRED::getProcessState(int $process_id)¶

Parameter:	$process_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]
Rückgabe-Array:	'error_code' – Typ: int, Wertebereich: Siehe Konstanten 'state' – Typ: int, Wertebereich: Siehe Konstanten 'timestamp' – Typ: int, Wertebereich: [0 bis 2⁶⁴ - 1] '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

array BrickRED::getPrograms(int $session_id)¶

Parameter:	$session_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]
Rückgabe-Array:	'error_code' – Typ: int, Wertebereich: Siehe Konstanten 'programs_list_id' – Typ: int, Wertebereich: [0 bis 2¹⁶ - 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

array BrickRED::defineProgram(int $identifier_string_id, int $session_id)¶

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

int BrickRED::purgeProgram(int $program_id, int $cookie)¶

Parameter:	$program_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] $cookie – Typ: int, Wertebereich: [0 bis 2³² - 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

array BrickRED::getProgramIdentifier(int $program_id, int $session_id)¶

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

array BrickRED::getProgramRootDirectory(int $program_id, int $session_id)¶

Parameter:	$program_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] $session_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]
Rückgabe-Array:	'error_code' – Typ: int, Wertebereich: Siehe Konstanten 'root_directory_string_id' – Typ: int, Wertebereich: [0 bis 2¹⁶ - 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

int BrickRED::setProgramCommand(int $program_id, int $executable_string_id, int $arguments_list_id, int $environment_list_id, int $working_directory_string_id)¶

Parameter:	$program_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] $executable_string_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] $arguments_list_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] $environment_list_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] $working_directory_string_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]
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

array BrickRED::getProgramCommand(int $program_id, int $session_id)¶

Parameter:	$program_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] $session_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]
Rückgabe-Array:	'error_code' – Typ: int, Wertebereich: Siehe Konstanten 'executable_string_id' – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] 'arguments_list_id' – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] 'environment_list_id' – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] 'working_directory_string_id' – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]

Die folgenden 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

int BrickRED::setProgramStdioRedirection(int $program_id, int $stdin_redirection, int $stdin_file_name_string_id, int $stdout_redirection, int $stdout_file_name_string_id, int $stderr_redirection, int $stderr_file_name_string_id)¶

Parameter:

Parameter:	$program_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] $stdin_redirection – Typ: int, Wertebereich: Siehe Konstanten $stdin_file_name_string_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] $stdout_redirection – Typ: int, Wertebereich: Siehe Konstanten $stdout_file_name_string_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] $stderr_redirection – Typ: int, Wertebereich: Siehe Konstanten $stderr_file_name_string_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]
Rückgabe:	$error_code – Typ: int, Wertebereich: Siehe Konstanten

$program_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]
$stdin_redirection – Typ: int, Wertebereich: Siehe Konstanten
$stdin_file_name_string_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]
$stdout_redirection – Typ: int, Wertebereich: Siehe Konstanten
$stdout_file_name_string_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]
$stderr_redirection – Typ: int, Wertebereich: Siehe Konstanten
$stderr_file_name_string_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 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

array BrickRED::getProgramStdioRedirection(int $program_id, int $session_id)¶

Parameter:

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

Rückgabe-Array:

'error_code' – Typ: int, Wertebereich: Siehe Konstanten
'stdin_redirection' – Typ: int, Wertebereich: Siehe Konstanten
'stdin_file_name_string_id' – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]
'stdout_redirection' – Typ: int, Wertebereich: Siehe Konstanten
'stdout_file_name_string_id' – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]
'stderr_redirection' – Typ: int, Wertebereich: Siehe Konstanten
'stderr_file_name_string_id' – Typ: int, Wertebereich: [0 bis 2¹⁶ - 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

int BrickRED::setProgramSchedule(int $program_id, int $start_mode, bool $continue_after_error, int $start_interval, int $start_fields_string_id)¶

Parameter:	$program_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] $start_mode – Typ: int, Wertebereich: Siehe Konstanten $continue_after_error – Typ: bool $start_interval – Typ: int, Wertebereich: [0 bis 2³² - 1] $start_fields_string_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]
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

array BrickRED::getProgramSchedule(int $program_id, int $session_id)¶

Parameter:	$program_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] $session_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]
Rückgabe-Array:	'error_code' – Typ: int, Wertebereich: Siehe Konstanten 'start_mode' – Typ: int, Wertebereich: Siehe Konstanten 'continue_after_error' – Typ: bool 'start_interval' – Typ: int, Wertebereich: [0 bis 2³² - 1] 'start_fields_string_id' – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]

Die folgenden 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

array BrickRED::getProgramSchedulerState(int $program_id, int $session_id)¶

Parameter:	$program_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] $session_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]
Rückgabe-Array:	'error_code' – Typ: int, Wertebereich: Siehe Konstanten 'state' – Typ: int, Wertebereich: Siehe Konstanten 'timestamp' – Typ: int, Wertebereich: [0 bis 2⁶⁴ - 1] 'message_string_id' – Typ: int, Wertebereich: [0 bis 2¹⁶ - 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

int BrickRED::continueProgramSchedule(int $program_id)¶

Parameter:	$program_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 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

int BrickRED::startProgram(int $program_id)¶

Parameter:	$program_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 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

array BrickRED::getLastSpawnedProgramProcess(int $program_id, int $session_id)¶

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

array BrickRED::getCustomProgramOptionNames(int $program_id, int $session_id)¶

Parameter:	$program_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] $session_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]
Rückgabe-Array:	'error_code' – Typ: int, Wertebereich: Siehe Konstanten 'names_list_id' – Typ: int, Wertebereich: [0 bis 2¹⁶ - 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

int BrickRED::setCustomProgramOptionValue(int $program_id, int $name_string_id, int $value_string_id)¶

Parameter:	$program_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] $name_string_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] $value_string_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]
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

array BrickRED::getCustomProgramOptionValue(int $program_id, int $name_string_id, int $session_id)¶

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

int BrickRED::removeCustomProgramOption(int $program_id, int $name_string_id)¶

Parameter:	$program_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] $name_string_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 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

array BrickRED::getIdentity()¶

Rückgabe-Array:

'uid' – Typ: string, Länge: bis zu 8
'connected_uid' – Typ: string, Länge: bis zu 8
'position' – Typ: string, Wertebereich: ['0' bis '8']
'hardware_version' – Typ: array(int, ...), Länge: 3

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

'firmware_version' – Typ: array(int, ...), Länge: 3

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

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

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¶

void BrickRED::registerCallback(int $callback_id, callable $callback, mixed $user_data=NULL)¶

Parameter:	$callback_id – Typ: int $callback – Typ: callable $user_data – Typ: mixed

Registriert die $function für die gegebene $callback_id. Die optionalen $user_data werden der Funktion als letztes Parameter mit übergeben.

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 registerCallback() des Geräte Objektes durchgeführt werden. Der erste Parameter ist der Callback ID und der zweite die Callback-Funktion:

<?php

function myCallback($param)
{
    echo $param . "\n";
}

$red->registerCallback(BrickRED::CALLBACK_EXAMPLE, 'myCallback');

?>

Die verfügbaren IDs mit den dazugehörigen Funktionssignaturen 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.

int BrickRED::CALLBACK_ASYNC_FILE_READ¶

<?php   void callback(int $file_id, int $error_code, array $buffer, int $length_read [, mixed $user_data])   ?>

Callback-Parameter:	$file_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] $error_code – Typ: int, Wertebereich: Siehe Konstanten $buffer – Typ: array(int, ...), Länge: 60, Wertebereich: [0 bis 255] $length_read – Typ: int, Einheit: 1 B, Wertebereich: [0 bis 255] $user_data – Typ: mixed

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

int BrickRED::CALLBACK_ASYNC_FILE_WRITE¶

<?php   void callback(int $file_id, int $error_code, int $length_written [, mixed $user_data])   ?>

Callback-Parameter:	$file_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] $error_code – Typ: int, Wertebereich: Siehe Konstanten $length_written – Typ: int, Einheit: 1 B, Wertebereich: [0 bis 255] $user_data – Typ: mixed

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

int BrickRED::CALLBACK_FILE_EVENTS_OCCURRED¶

<?php   void callback(int $file_id, int $events [, mixed $user_data])   ?>

Callback-Parameter:	$file_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] $events – Typ: int, Wertebereich: Siehe Konstanten $user_data – Typ: mixed

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

Für $events:

BrickRED::FILE_EVENT_READABLE = 1
BrickRED::FILE_EVENT_WRITABLE = 2

int BrickRED::CALLBACK_PROCESS_STATE_CHANGED¶

<?php   void callback(int $process_id, int $state, int $timestamp, int $exit_code [, mixed $user_data])   ?>

Callback-Parameter:	$process_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] $state – Typ: int, Wertebereich: Siehe Konstanten $timestamp – Typ: int, Wertebereich: [0 bis 2⁶⁴ - 1] $exit_code – Typ: int, Wertebereich: [0 bis 255] $user_data – Typ: mixed

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

int BrickRED::CALLBACK_PROGRAM_SCHEDULER_STATE_CHANGED¶

<?php   void callback(int $program_id [, mixed $user_data])   ?>

Callback-Parameter:	$program_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] $user_data – Typ: mixed

int BrickRED::CALLBACK_PROGRAM_PROCESS_SPAWNED¶

<?php   void callback(int $program_id [, mixed $user_data])   ?>

Callback-Parameter:	$program_id – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] $user_data – Typ: mixed

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.

array BrickRED::getAPIVersion()¶

Rückgabe-Array:	$api_version – Typ: array(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.

bool BrickRED::getResponseExpected(int $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 setResponseExpected(). 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

void BrickRED::setResponseExpected(int $function_id, bool $response_expected)¶

Parameter:	$function_id – Typ: int, Wertebereich: Siehe Konstanten $response_expected – Typ: bool

Ä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.

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

void BrickRED::setResponseExpectedAll(bool $response_expected)¶

Parameter:	$response_expected – Typ: bool

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

Konstanten¶

int BrickRED::DEVICE_IDENTIFIER¶

Diese Konstante wird verwendet um einen RED Brick zu identifizieren.

Die getIdentity() Funktion und der IPConnection::CALLBACK_ENUMERATE Callback der IP Connection haben ein deviceIdentifier Parameter um den Typ des Bricks oder Bricklets anzugeben.

string BrickRED::DEVICE_DISPLAY_NAME¶: Diese Konstante stellt den Anzeigenamen eines RED Brick dar.