Go - RED Brick

Dies ist die Beschreibung der Go 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 Go API Bindings ist Teil deren allgemeine Beschreibung. Zusätzliche Dokumentation findet sich auf godoc.org.

API

Die API des RED Brick ist im Package github.com/Tinkerforge/go-api-bindings/red_brick definiert.

Fast alle Funktionen der Go Bindings können einen ipconnection.DeviceError, der das error-Interface implementiert, zurückgeben. Dieser kann folgende Werte annehmen:

  • ipconnection.DeviceErrorSuccess = 0
  • ipconnection.DeviceErrorInvalidParameter = 1
  • ipconnection.DeviceErrorFunctionNotSupported = 2
  • ipconnection.DeviceErrorUnknownError = 3

welche den Werten entsprechen, die der Brick oder das Bricklet zurückgeben.

Alle folgend aufgelisteten Funktionen sind Thread-sicher.

Bemerkung

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

Fortgeschrittene Funktionen

func (*REDBrick) CreateSession(lifetime uint32) (errorCode uint8, sessionId uint16, err error)
Parameter:
  • lifetime – Typ: uint32, Wertebereich: [0 bis 232 - 1]
Rückgabe:
  • errorCode – Typ: uint8, Wertebereich: Siehe Konstanten
  • sessionId – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • err – Typ: error

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

Für errorCode:

  • red_brick.ErrorCodeSuccess = 0
  • red_brick.ErrorCodeUnknownError = 1
  • red_brick.ErrorCodeInvalidOperation = 2
  • red_brick.ErrorCodeOperationAborted = 3
  • red_brick.ErrorCodeInternalError = 4
  • red_brick.ErrorCodeUnknownSessionId = 5
  • red_brick.ErrorCodeNoFreeSessionId = 6
  • red_brick.ErrorCodeUnknownObjectId = 7
  • red_brick.ErrorCodeNoFreeObjectId = 8
  • red_brick.ErrorCodeObjectIsLocked = 9
  • red_brick.ErrorCodeNoMoreData = 10
  • red_brick.ErrorCodeWrongListItemType = 11
  • red_brick.ErrorCodeProgramIsPurged = 12
  • red_brick.ErrorCodeInvalidParameter = 128
  • red_brick.ErrorCodeNoFreeMemory = 129
  • red_brick.ErrorCodeNoFreeSpace = 130
  • red_brick.ErrorCodeAccessDenied = 121
  • red_brick.ErrorCodeAlreadyExists = 132
  • red_brick.ErrorCodeDoesNotExist = 133
  • red_brick.ErrorCodeInterrupted = 134
  • red_brick.ErrorCodeIsDirectory = 135
  • red_brick.ErrorCodeNotADirectory = 136
  • red_brick.ErrorCodeWouldBlock = 137
  • red_brick.ErrorCodeOverflow = 138
  • red_brick.ErrorCodeBadFileDescriptor = 139
  • red_brick.ErrorCodeOutOfRange = 140
  • red_brick.ErrorCodeNameTooLong = 141
  • red_brick.ErrorCodeInvalidSeek = 142
  • red_brick.ErrorCodeNotSupported = 143
  • red_brick.ErrorCodeTooManyOpenFiles = 144
func (*REDBrick) ExpireSession(sessionId uint16) (errorCode uint8, err error)
Parameter:
  • sessionId – Typ: uint16, Wertebereich: [0 bis 216 - 1]
Rückgabe:
  • errorCode – Typ: uint8, Wertebereich: Siehe Konstanten
  • err – Typ: error

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

Für errorCode:

  • red_brick.ErrorCodeSuccess = 0
  • red_brick.ErrorCodeUnknownError = 1
  • red_brick.ErrorCodeInvalidOperation = 2
  • red_brick.ErrorCodeOperationAborted = 3
  • red_brick.ErrorCodeInternalError = 4
  • red_brick.ErrorCodeUnknownSessionId = 5
  • red_brick.ErrorCodeNoFreeSessionId = 6
  • red_brick.ErrorCodeUnknownObjectId = 7
  • red_brick.ErrorCodeNoFreeObjectId = 8
  • red_brick.ErrorCodeObjectIsLocked = 9
  • red_brick.ErrorCodeNoMoreData = 10
  • red_brick.ErrorCodeWrongListItemType = 11
  • red_brick.ErrorCodeProgramIsPurged = 12
  • red_brick.ErrorCodeInvalidParameter = 128
  • red_brick.ErrorCodeNoFreeMemory = 129
  • red_brick.ErrorCodeNoFreeSpace = 130
  • red_brick.ErrorCodeAccessDenied = 121
  • red_brick.ErrorCodeAlreadyExists = 132
  • red_brick.ErrorCodeDoesNotExist = 133
  • red_brick.ErrorCodeInterrupted = 134
  • red_brick.ErrorCodeIsDirectory = 135
  • red_brick.ErrorCodeNotADirectory = 136
  • red_brick.ErrorCodeWouldBlock = 137
  • red_brick.ErrorCodeOverflow = 138
  • red_brick.ErrorCodeBadFileDescriptor = 139
  • red_brick.ErrorCodeOutOfRange = 140
  • red_brick.ErrorCodeNameTooLong = 141
  • red_brick.ErrorCodeInvalidSeek = 142
  • red_brick.ErrorCodeNotSupported = 143
  • red_brick.ErrorCodeTooManyOpenFiles = 144
func (*REDBrick) ExpireSessionUnchecked(sessionId uint16) (err error)
Parameter:
  • sessionId – Typ: uint16, Wertebereich: [0 bis 216 - 1]
Rückgabe:
  • err – Typ: error
func (*REDBrick) KeepSessionAlive(sessionId uint16, lifetime uint32) (errorCode uint8, err error)
Parameter:
  • sessionId – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • lifetime – Typ: uint32, Wertebereich: [0 bis 232 - 1]
Rückgabe:
  • errorCode – Typ: uint8, Wertebereich: Siehe Konstanten
  • err – Typ: error

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

Für errorCode:

  • red_brick.ErrorCodeSuccess = 0
  • red_brick.ErrorCodeUnknownError = 1
  • red_brick.ErrorCodeInvalidOperation = 2
  • red_brick.ErrorCodeOperationAborted = 3
  • red_brick.ErrorCodeInternalError = 4
  • red_brick.ErrorCodeUnknownSessionId = 5
  • red_brick.ErrorCodeNoFreeSessionId = 6
  • red_brick.ErrorCodeUnknownObjectId = 7
  • red_brick.ErrorCodeNoFreeObjectId = 8
  • red_brick.ErrorCodeObjectIsLocked = 9
  • red_brick.ErrorCodeNoMoreData = 10
  • red_brick.ErrorCodeWrongListItemType = 11
  • red_brick.ErrorCodeProgramIsPurged = 12
  • red_brick.ErrorCodeInvalidParameter = 128
  • red_brick.ErrorCodeNoFreeMemory = 129
  • red_brick.ErrorCodeNoFreeSpace = 130
  • red_brick.ErrorCodeAccessDenied = 121
  • red_brick.ErrorCodeAlreadyExists = 132
  • red_brick.ErrorCodeDoesNotExist = 133
  • red_brick.ErrorCodeInterrupted = 134
  • red_brick.ErrorCodeIsDirectory = 135
  • red_brick.ErrorCodeNotADirectory = 136
  • red_brick.ErrorCodeWouldBlock = 137
  • red_brick.ErrorCodeOverflow = 138
  • red_brick.ErrorCodeBadFileDescriptor = 139
  • red_brick.ErrorCodeOutOfRange = 140
  • red_brick.ErrorCodeNameTooLong = 141
  • red_brick.ErrorCodeInvalidSeek = 142
  • red_brick.ErrorCodeNotSupported = 143
  • red_brick.ErrorCodeTooManyOpenFiles = 144
func (*REDBrick) ReleaseObject(objectId uint16, sessionId uint16) (errorCode uint8, err error)
Parameter:
  • objectId – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • sessionId – Typ: uint16, Wertebereich: [0 bis 216 - 1]
Rückgabe:
  • errorCode – Typ: uint8, Wertebereich: Siehe Konstanten
  • err – Typ: error

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

Für errorCode:

  • red_brick.ErrorCodeSuccess = 0
  • red_brick.ErrorCodeUnknownError = 1
  • red_brick.ErrorCodeInvalidOperation = 2
  • red_brick.ErrorCodeOperationAborted = 3
  • red_brick.ErrorCodeInternalError = 4
  • red_brick.ErrorCodeUnknownSessionId = 5
  • red_brick.ErrorCodeNoFreeSessionId = 6
  • red_brick.ErrorCodeUnknownObjectId = 7
  • red_brick.ErrorCodeNoFreeObjectId = 8
  • red_brick.ErrorCodeObjectIsLocked = 9
  • red_brick.ErrorCodeNoMoreData = 10
  • red_brick.ErrorCodeWrongListItemType = 11
  • red_brick.ErrorCodeProgramIsPurged = 12
  • red_brick.ErrorCodeInvalidParameter = 128
  • red_brick.ErrorCodeNoFreeMemory = 129
  • red_brick.ErrorCodeNoFreeSpace = 130
  • red_brick.ErrorCodeAccessDenied = 121
  • red_brick.ErrorCodeAlreadyExists = 132
  • red_brick.ErrorCodeDoesNotExist = 133
  • red_brick.ErrorCodeInterrupted = 134
  • red_brick.ErrorCodeIsDirectory = 135
  • red_brick.ErrorCodeNotADirectory = 136
  • red_brick.ErrorCodeWouldBlock = 137
  • red_brick.ErrorCodeOverflow = 138
  • red_brick.ErrorCodeBadFileDescriptor = 139
  • red_brick.ErrorCodeOutOfRange = 140
  • red_brick.ErrorCodeNameTooLong = 141
  • red_brick.ErrorCodeInvalidSeek = 142
  • red_brick.ErrorCodeNotSupported = 143
  • red_brick.ErrorCodeTooManyOpenFiles = 144
func (*REDBrick) ReleaseObjectUnchecked(objectId uint16, sessionId uint16) (err error)
Parameter:
  • objectId – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • sessionId – Typ: uint16, Wertebereich: [0 bis 216 - 1]
Rückgabe:
  • err – Typ: error
func (*REDBrick) AllocateString(lengthToReserve uint32, buffer string, sessionId uint16) (errorCode uint8, stringId uint16, err error)
Parameter:
  • lengthToReserve – Typ: uint32, Einheit: 1 B, Wertebereich: [0 bis 232 - 1]
  • buffer – Typ: string, Länge: bis zu 58
  • sessionId – Typ: uint16, Wertebereich: [0 bis 216 - 1]
Rückgabe:
  • errorCode – Typ: uint8, Wertebereich: Siehe Konstanten
  • stringId – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • err – Typ: error

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

Für errorCode:

  • red_brick.ErrorCodeSuccess = 0
  • red_brick.ErrorCodeUnknownError = 1
  • red_brick.ErrorCodeInvalidOperation = 2
  • red_brick.ErrorCodeOperationAborted = 3
  • red_brick.ErrorCodeInternalError = 4
  • red_brick.ErrorCodeUnknownSessionId = 5
  • red_brick.ErrorCodeNoFreeSessionId = 6
  • red_brick.ErrorCodeUnknownObjectId = 7
  • red_brick.ErrorCodeNoFreeObjectId = 8
  • red_brick.ErrorCodeObjectIsLocked = 9
  • red_brick.ErrorCodeNoMoreData = 10
  • red_brick.ErrorCodeWrongListItemType = 11
  • red_brick.ErrorCodeProgramIsPurged = 12
  • red_brick.ErrorCodeInvalidParameter = 128
  • red_brick.ErrorCodeNoFreeMemory = 129
  • red_brick.ErrorCodeNoFreeSpace = 130
  • red_brick.ErrorCodeAccessDenied = 121
  • red_brick.ErrorCodeAlreadyExists = 132
  • red_brick.ErrorCodeDoesNotExist = 133
  • red_brick.ErrorCodeInterrupted = 134
  • red_brick.ErrorCodeIsDirectory = 135
  • red_brick.ErrorCodeNotADirectory = 136
  • red_brick.ErrorCodeWouldBlock = 137
  • red_brick.ErrorCodeOverflow = 138
  • red_brick.ErrorCodeBadFileDescriptor = 139
  • red_brick.ErrorCodeOutOfRange = 140
  • red_brick.ErrorCodeNameTooLong = 141
  • red_brick.ErrorCodeInvalidSeek = 142
  • red_brick.ErrorCodeNotSupported = 143
  • red_brick.ErrorCodeTooManyOpenFiles = 144
func (*REDBrick) TruncateString(stringId uint16, length uint32) (errorCode uint8, err error)
Parameter:
  • stringId – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • length – Typ: uint32, Einheit: 1 B, Wertebereich: [0 bis 232 - 1]
Rückgabe:
  • errorCode – Typ: uint8, Wertebereich: Siehe Konstanten
  • err – Typ: error

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

Für errorCode:

  • red_brick.ErrorCodeSuccess = 0
  • red_brick.ErrorCodeUnknownError = 1
  • red_brick.ErrorCodeInvalidOperation = 2
  • red_brick.ErrorCodeOperationAborted = 3
  • red_brick.ErrorCodeInternalError = 4
  • red_brick.ErrorCodeUnknownSessionId = 5
  • red_brick.ErrorCodeNoFreeSessionId = 6
  • red_brick.ErrorCodeUnknownObjectId = 7
  • red_brick.ErrorCodeNoFreeObjectId = 8
  • red_brick.ErrorCodeObjectIsLocked = 9
  • red_brick.ErrorCodeNoMoreData = 10
  • red_brick.ErrorCodeWrongListItemType = 11
  • red_brick.ErrorCodeProgramIsPurged = 12
  • red_brick.ErrorCodeInvalidParameter = 128
  • red_brick.ErrorCodeNoFreeMemory = 129
  • red_brick.ErrorCodeNoFreeSpace = 130
  • red_brick.ErrorCodeAccessDenied = 121
  • red_brick.ErrorCodeAlreadyExists = 132
  • red_brick.ErrorCodeDoesNotExist = 133
  • red_brick.ErrorCodeInterrupted = 134
  • red_brick.ErrorCodeIsDirectory = 135
  • red_brick.ErrorCodeNotADirectory = 136
  • red_brick.ErrorCodeWouldBlock = 137
  • red_brick.ErrorCodeOverflow = 138
  • red_brick.ErrorCodeBadFileDescriptor = 139
  • red_brick.ErrorCodeOutOfRange = 140
  • red_brick.ErrorCodeNameTooLong = 141
  • red_brick.ErrorCodeInvalidSeek = 142
  • red_brick.ErrorCodeNotSupported = 143
  • red_brick.ErrorCodeTooManyOpenFiles = 144
func (*REDBrick) GetStringLength(stringId uint16) (errorCode uint8, length uint32, err error)
Parameter:
  • stringId – Typ: uint16, Wertebereich: [0 bis 216 - 1]
Rückgabe:
  • errorCode – Typ: uint8, Wertebereich: Siehe Konstanten
  • length – Typ: uint32, Einheit: 1 B, Wertebereich: [0 bis 232 - 1]
  • err – Typ: error

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

Für errorCode:

  • red_brick.ErrorCodeSuccess = 0
  • red_brick.ErrorCodeUnknownError = 1
  • red_brick.ErrorCodeInvalidOperation = 2
  • red_brick.ErrorCodeOperationAborted = 3
  • red_brick.ErrorCodeInternalError = 4
  • red_brick.ErrorCodeUnknownSessionId = 5
  • red_brick.ErrorCodeNoFreeSessionId = 6
  • red_brick.ErrorCodeUnknownObjectId = 7
  • red_brick.ErrorCodeNoFreeObjectId = 8
  • red_brick.ErrorCodeObjectIsLocked = 9
  • red_brick.ErrorCodeNoMoreData = 10
  • red_brick.ErrorCodeWrongListItemType = 11
  • red_brick.ErrorCodeProgramIsPurged = 12
  • red_brick.ErrorCodeInvalidParameter = 128
  • red_brick.ErrorCodeNoFreeMemory = 129
  • red_brick.ErrorCodeNoFreeSpace = 130
  • red_brick.ErrorCodeAccessDenied = 121
  • red_brick.ErrorCodeAlreadyExists = 132
  • red_brick.ErrorCodeDoesNotExist = 133
  • red_brick.ErrorCodeInterrupted = 134
  • red_brick.ErrorCodeIsDirectory = 135
  • red_brick.ErrorCodeNotADirectory = 136
  • red_brick.ErrorCodeWouldBlock = 137
  • red_brick.ErrorCodeOverflow = 138
  • red_brick.ErrorCodeBadFileDescriptor = 139
  • red_brick.ErrorCodeOutOfRange = 140
  • red_brick.ErrorCodeNameTooLong = 141
  • red_brick.ErrorCodeInvalidSeek = 142
  • red_brick.ErrorCodeNotSupported = 143
  • red_brick.ErrorCodeTooManyOpenFiles = 144
func (*REDBrick) SetStringChunk(stringId uint16, offset uint32, buffer string) (errorCode uint8, err error)
Parameter:
  • stringId – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • offset – Typ: uint32, Einheit: 1 B, Wertebereich: [0 bis 232 - 1]
  • buffer – Typ: string, Länge: bis zu 58
Rückgabe:
  • errorCode – Typ: uint8, Wertebereich: Siehe Konstanten
  • err – Typ: error

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

Für errorCode:

  • red_brick.ErrorCodeSuccess = 0
  • red_brick.ErrorCodeUnknownError = 1
  • red_brick.ErrorCodeInvalidOperation = 2
  • red_brick.ErrorCodeOperationAborted = 3
  • red_brick.ErrorCodeInternalError = 4
  • red_brick.ErrorCodeUnknownSessionId = 5
  • red_brick.ErrorCodeNoFreeSessionId = 6
  • red_brick.ErrorCodeUnknownObjectId = 7
  • red_brick.ErrorCodeNoFreeObjectId = 8
  • red_brick.ErrorCodeObjectIsLocked = 9
  • red_brick.ErrorCodeNoMoreData = 10
  • red_brick.ErrorCodeWrongListItemType = 11
  • red_brick.ErrorCodeProgramIsPurged = 12
  • red_brick.ErrorCodeInvalidParameter = 128
  • red_brick.ErrorCodeNoFreeMemory = 129
  • red_brick.ErrorCodeNoFreeSpace = 130
  • red_brick.ErrorCodeAccessDenied = 121
  • red_brick.ErrorCodeAlreadyExists = 132
  • red_brick.ErrorCodeDoesNotExist = 133
  • red_brick.ErrorCodeInterrupted = 134
  • red_brick.ErrorCodeIsDirectory = 135
  • red_brick.ErrorCodeNotADirectory = 136
  • red_brick.ErrorCodeWouldBlock = 137
  • red_brick.ErrorCodeOverflow = 138
  • red_brick.ErrorCodeBadFileDescriptor = 139
  • red_brick.ErrorCodeOutOfRange = 140
  • red_brick.ErrorCodeNameTooLong = 141
  • red_brick.ErrorCodeInvalidSeek = 142
  • red_brick.ErrorCodeNotSupported = 143
  • red_brick.ErrorCodeTooManyOpenFiles = 144
func (*REDBrick) GetStringChunk(stringId uint16, offset uint32) (errorCode uint8, buffer string, err error)
Parameter:
  • stringId – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • offset – Typ: uint32, Einheit: 1 B, Wertebereich: [0 bis 232 - 1]
Rückgabe:
  • errorCode – Typ: uint8, Wertebereich: Siehe Konstanten
  • buffer – Typ: string, Länge: bis zu 63
  • err – Typ: error

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

Für errorCode:

  • red_brick.ErrorCodeSuccess = 0
  • red_brick.ErrorCodeUnknownError = 1
  • red_brick.ErrorCodeInvalidOperation = 2
  • red_brick.ErrorCodeOperationAborted = 3
  • red_brick.ErrorCodeInternalError = 4
  • red_brick.ErrorCodeUnknownSessionId = 5
  • red_brick.ErrorCodeNoFreeSessionId = 6
  • red_brick.ErrorCodeUnknownObjectId = 7
  • red_brick.ErrorCodeNoFreeObjectId = 8
  • red_brick.ErrorCodeObjectIsLocked = 9
  • red_brick.ErrorCodeNoMoreData = 10
  • red_brick.ErrorCodeWrongListItemType = 11
  • red_brick.ErrorCodeProgramIsPurged = 12
  • red_brick.ErrorCodeInvalidParameter = 128
  • red_brick.ErrorCodeNoFreeMemory = 129
  • red_brick.ErrorCodeNoFreeSpace = 130
  • red_brick.ErrorCodeAccessDenied = 121
  • red_brick.ErrorCodeAlreadyExists = 132
  • red_brick.ErrorCodeDoesNotExist = 133
  • red_brick.ErrorCodeInterrupted = 134
  • red_brick.ErrorCodeIsDirectory = 135
  • red_brick.ErrorCodeNotADirectory = 136
  • red_brick.ErrorCodeWouldBlock = 137
  • red_brick.ErrorCodeOverflow = 138
  • red_brick.ErrorCodeBadFileDescriptor = 139
  • red_brick.ErrorCodeOutOfRange = 140
  • red_brick.ErrorCodeNameTooLong = 141
  • red_brick.ErrorCodeInvalidSeek = 142
  • red_brick.ErrorCodeNotSupported = 143
  • red_brick.ErrorCodeTooManyOpenFiles = 144
func (*REDBrick) AllocateList(lengthToReserve uint16, sessionId uint16) (errorCode uint8, listId uint16, err error)
Parameter:
  • lengthToReserve – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • sessionId – Typ: uint16, Wertebereich: [0 bis 216 - 1]
Rückgabe:
  • errorCode – Typ: uint8, Wertebereich: Siehe Konstanten
  • listId – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • err – Typ: error

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

Für errorCode:

  • red_brick.ErrorCodeSuccess = 0
  • red_brick.ErrorCodeUnknownError = 1
  • red_brick.ErrorCodeInvalidOperation = 2
  • red_brick.ErrorCodeOperationAborted = 3
  • red_brick.ErrorCodeInternalError = 4
  • red_brick.ErrorCodeUnknownSessionId = 5
  • red_brick.ErrorCodeNoFreeSessionId = 6
  • red_brick.ErrorCodeUnknownObjectId = 7
  • red_brick.ErrorCodeNoFreeObjectId = 8
  • red_brick.ErrorCodeObjectIsLocked = 9
  • red_brick.ErrorCodeNoMoreData = 10
  • red_brick.ErrorCodeWrongListItemType = 11
  • red_brick.ErrorCodeProgramIsPurged = 12
  • red_brick.ErrorCodeInvalidParameter = 128
  • red_brick.ErrorCodeNoFreeMemory = 129
  • red_brick.ErrorCodeNoFreeSpace = 130
  • red_brick.ErrorCodeAccessDenied = 121
  • red_brick.ErrorCodeAlreadyExists = 132
  • red_brick.ErrorCodeDoesNotExist = 133
  • red_brick.ErrorCodeInterrupted = 134
  • red_brick.ErrorCodeIsDirectory = 135
  • red_brick.ErrorCodeNotADirectory = 136
  • red_brick.ErrorCodeWouldBlock = 137
  • red_brick.ErrorCodeOverflow = 138
  • red_brick.ErrorCodeBadFileDescriptor = 139
  • red_brick.ErrorCodeOutOfRange = 140
  • red_brick.ErrorCodeNameTooLong = 141
  • red_brick.ErrorCodeInvalidSeek = 142
  • red_brick.ErrorCodeNotSupported = 143
  • red_brick.ErrorCodeTooManyOpenFiles = 144
func (*REDBrick) GetListLength(listId uint16) (errorCode uint8, length uint16, err error)
Parameter:
  • listId – Typ: uint16, Wertebereich: [0 bis 216 - 1]
Rückgabe:
  • errorCode – Typ: uint8, Wertebereich: Siehe Konstanten
  • length – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • err – Typ: error

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

Für errorCode:

  • red_brick.ErrorCodeSuccess = 0
  • red_brick.ErrorCodeUnknownError = 1
  • red_brick.ErrorCodeInvalidOperation = 2
  • red_brick.ErrorCodeOperationAborted = 3
  • red_brick.ErrorCodeInternalError = 4
  • red_brick.ErrorCodeUnknownSessionId = 5
  • red_brick.ErrorCodeNoFreeSessionId = 6
  • red_brick.ErrorCodeUnknownObjectId = 7
  • red_brick.ErrorCodeNoFreeObjectId = 8
  • red_brick.ErrorCodeObjectIsLocked = 9
  • red_brick.ErrorCodeNoMoreData = 10
  • red_brick.ErrorCodeWrongListItemType = 11
  • red_brick.ErrorCodeProgramIsPurged = 12
  • red_brick.ErrorCodeInvalidParameter = 128
  • red_brick.ErrorCodeNoFreeMemory = 129
  • red_brick.ErrorCodeNoFreeSpace = 130
  • red_brick.ErrorCodeAccessDenied = 121
  • red_brick.ErrorCodeAlreadyExists = 132
  • red_brick.ErrorCodeDoesNotExist = 133
  • red_brick.ErrorCodeInterrupted = 134
  • red_brick.ErrorCodeIsDirectory = 135
  • red_brick.ErrorCodeNotADirectory = 136
  • red_brick.ErrorCodeWouldBlock = 137
  • red_brick.ErrorCodeOverflow = 138
  • red_brick.ErrorCodeBadFileDescriptor = 139
  • red_brick.ErrorCodeOutOfRange = 140
  • red_brick.ErrorCodeNameTooLong = 141
  • red_brick.ErrorCodeInvalidSeek = 142
  • red_brick.ErrorCodeNotSupported = 143
  • red_brick.ErrorCodeTooManyOpenFiles = 144
func (*REDBrick) GetListItem(listId uint16, index uint16, sessionId uint16) (errorCode uint8, itemObjectId uint16, type_ uint8, err error)
Parameter:
  • listId – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • index – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • sessionId – Typ: uint16, Wertebereich: [0 bis 216 - 1]
Rückgabe:
  • errorCode – Typ: uint8, Wertebereich: Siehe Konstanten
  • itemObjectId – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • type – Typ: uint8, Wertebereich: Siehe Konstanten
  • err – Typ: error

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

Für errorCode:

  • red_brick.ErrorCodeSuccess = 0
  • red_brick.ErrorCodeUnknownError = 1
  • red_brick.ErrorCodeInvalidOperation = 2
  • red_brick.ErrorCodeOperationAborted = 3
  • red_brick.ErrorCodeInternalError = 4
  • red_brick.ErrorCodeUnknownSessionId = 5
  • red_brick.ErrorCodeNoFreeSessionId = 6
  • red_brick.ErrorCodeUnknownObjectId = 7
  • red_brick.ErrorCodeNoFreeObjectId = 8
  • red_brick.ErrorCodeObjectIsLocked = 9
  • red_brick.ErrorCodeNoMoreData = 10
  • red_brick.ErrorCodeWrongListItemType = 11
  • red_brick.ErrorCodeProgramIsPurged = 12
  • red_brick.ErrorCodeInvalidParameter = 128
  • red_brick.ErrorCodeNoFreeMemory = 129
  • red_brick.ErrorCodeNoFreeSpace = 130
  • red_brick.ErrorCodeAccessDenied = 121
  • red_brick.ErrorCodeAlreadyExists = 132
  • red_brick.ErrorCodeDoesNotExist = 133
  • red_brick.ErrorCodeInterrupted = 134
  • red_brick.ErrorCodeIsDirectory = 135
  • red_brick.ErrorCodeNotADirectory = 136
  • red_brick.ErrorCodeWouldBlock = 137
  • red_brick.ErrorCodeOverflow = 138
  • red_brick.ErrorCodeBadFileDescriptor = 139
  • red_brick.ErrorCodeOutOfRange = 140
  • red_brick.ErrorCodeNameTooLong = 141
  • red_brick.ErrorCodeInvalidSeek = 142
  • red_brick.ErrorCodeNotSupported = 143
  • red_brick.ErrorCodeTooManyOpenFiles = 144

Für type:

  • red_brick.ObjectTypeString = 0
  • red_brick.ObjectTypeList = 1
  • red_brick.ObjectTypeFile = 2
  • red_brick.ObjectTypeDirectory = 3
  • red_brick.ObjectTypeProcess = 4
  • red_brick.ObjectTypeProgram = 5
func (*REDBrick) AppendToList(listId uint16, itemObjectId uint16) (errorCode uint8, err error)
Parameter:
  • listId – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • itemObjectId – Typ: uint16, Wertebereich: [0 bis 216 - 1]
Rückgabe:
  • errorCode – Typ: uint8, Wertebereich: Siehe Konstanten
  • err – Typ: error

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

Für errorCode:

  • red_brick.ErrorCodeSuccess = 0
  • red_brick.ErrorCodeUnknownError = 1
  • red_brick.ErrorCodeInvalidOperation = 2
  • red_brick.ErrorCodeOperationAborted = 3
  • red_brick.ErrorCodeInternalError = 4
  • red_brick.ErrorCodeUnknownSessionId = 5
  • red_brick.ErrorCodeNoFreeSessionId = 6
  • red_brick.ErrorCodeUnknownObjectId = 7
  • red_brick.ErrorCodeNoFreeObjectId = 8
  • red_brick.ErrorCodeObjectIsLocked = 9
  • red_brick.ErrorCodeNoMoreData = 10
  • red_brick.ErrorCodeWrongListItemType = 11
  • red_brick.ErrorCodeProgramIsPurged = 12
  • red_brick.ErrorCodeInvalidParameter = 128
  • red_brick.ErrorCodeNoFreeMemory = 129
  • red_brick.ErrorCodeNoFreeSpace = 130
  • red_brick.ErrorCodeAccessDenied = 121
  • red_brick.ErrorCodeAlreadyExists = 132
  • red_brick.ErrorCodeDoesNotExist = 133
  • red_brick.ErrorCodeInterrupted = 134
  • red_brick.ErrorCodeIsDirectory = 135
  • red_brick.ErrorCodeNotADirectory = 136
  • red_brick.ErrorCodeWouldBlock = 137
  • red_brick.ErrorCodeOverflow = 138
  • red_brick.ErrorCodeBadFileDescriptor = 139
  • red_brick.ErrorCodeOutOfRange = 140
  • red_brick.ErrorCodeNameTooLong = 141
  • red_brick.ErrorCodeInvalidSeek = 142
  • red_brick.ErrorCodeNotSupported = 143
  • red_brick.ErrorCodeTooManyOpenFiles = 144
func (*REDBrick) RemoveFromList(listId uint16, index uint16) (errorCode uint8, err error)
Parameter:
  • listId – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • index – Typ: uint16, Wertebereich: [0 bis 216 - 1]
Rückgabe:
  • errorCode – Typ: uint8, Wertebereich: Siehe Konstanten
  • err – Typ: error

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

Für errorCode:

  • red_brick.ErrorCodeSuccess = 0
  • red_brick.ErrorCodeUnknownError = 1
  • red_brick.ErrorCodeInvalidOperation = 2
  • red_brick.ErrorCodeOperationAborted = 3
  • red_brick.ErrorCodeInternalError = 4
  • red_brick.ErrorCodeUnknownSessionId = 5
  • red_brick.ErrorCodeNoFreeSessionId = 6
  • red_brick.ErrorCodeUnknownObjectId = 7
  • red_brick.ErrorCodeNoFreeObjectId = 8
  • red_brick.ErrorCodeObjectIsLocked = 9
  • red_brick.ErrorCodeNoMoreData = 10
  • red_brick.ErrorCodeWrongListItemType = 11
  • red_brick.ErrorCodeProgramIsPurged = 12
  • red_brick.ErrorCodeInvalidParameter = 128
  • red_brick.ErrorCodeNoFreeMemory = 129
  • red_brick.ErrorCodeNoFreeSpace = 130
  • red_brick.ErrorCodeAccessDenied = 121
  • red_brick.ErrorCodeAlreadyExists = 132
  • red_brick.ErrorCodeDoesNotExist = 133
  • red_brick.ErrorCodeInterrupted = 134
  • red_brick.ErrorCodeIsDirectory = 135
  • red_brick.ErrorCodeNotADirectory = 136
  • red_brick.ErrorCodeWouldBlock = 137
  • red_brick.ErrorCodeOverflow = 138
  • red_brick.ErrorCodeBadFileDescriptor = 139
  • red_brick.ErrorCodeOutOfRange = 140
  • red_brick.ErrorCodeNameTooLong = 141
  • red_brick.ErrorCodeInvalidSeek = 142
  • red_brick.ErrorCodeNotSupported = 143
  • red_brick.ErrorCodeTooManyOpenFiles = 144
func (*REDBrick) OpenFile(nameStringId uint16, flags uint32, permissions uint16, uid uint32, gid uint32, sessionId uint16) (errorCode uint8, fileId uint16, err error)
Parameter:
  • nameStringId – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • flags – Typ: uint32, Wertebereich: Siehe Konstanten
  • permissions – Typ: uint16, Wertebereich: Siehe Konstanten
  • uid – Typ: uint32, Wertebereich: [0 bis 232 - 1]
  • gid – Typ: uint32, Wertebereich: [0 bis 232 - 1]
  • sessionId – Typ: uint16, Wertebereich: [0 bis 216 - 1]
Rückgabe:
  • errorCode – Typ: uint8, Wertebereich: Siehe Konstanten
  • fileId – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • err – Typ: error

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

Für flags:

  • red_brick.FileFlagReadOnly = 1
  • red_brick.FileFlagWriteOnly = 2
  • red_brick.FileFlagReadWrite = 4
  • red_brick.FileFlagAppend = 8
  • red_brick.FileFlagCreate = 16
  • red_brick.FileFlagExclusive = 32
  • red_brick.FileFlagNonBlocking = 64
  • red_brick.FileFlagTruncate = 128
  • red_brick.FileFlagTemporary = 256
  • red_brick.FileFlagReplace = 512

Für permissions:

  • red_brick.FilePermissionUserAll = 448
  • red_brick.FilePermissionUserRead = 256
  • red_brick.FilePermissionUserWrite = 128
  • red_brick.FilePermissionUserExecute = 64
  • red_brick.FilePermissionGroupAll = 56
  • red_brick.FilePermissionGroupRead = 32
  • red_brick.FilePermissionGroupWrite = 16
  • red_brick.FilePermissionGroupExecute = 8
  • red_brick.FilePermissionOthersAll = 7
  • red_brick.FilePermissionOthersRead = 4
  • red_brick.FilePermissionOthersWrite = 2
  • red_brick.FilePermissionOthersExecute = 1

Für errorCode:

  • red_brick.ErrorCodeSuccess = 0
  • red_brick.ErrorCodeUnknownError = 1
  • red_brick.ErrorCodeInvalidOperation = 2
  • red_brick.ErrorCodeOperationAborted = 3
  • red_brick.ErrorCodeInternalError = 4
  • red_brick.ErrorCodeUnknownSessionId = 5
  • red_brick.ErrorCodeNoFreeSessionId = 6
  • red_brick.ErrorCodeUnknownObjectId = 7
  • red_brick.ErrorCodeNoFreeObjectId = 8
  • red_brick.ErrorCodeObjectIsLocked = 9
  • red_brick.ErrorCodeNoMoreData = 10
  • red_brick.ErrorCodeWrongListItemType = 11
  • red_brick.ErrorCodeProgramIsPurged = 12
  • red_brick.ErrorCodeInvalidParameter = 128
  • red_brick.ErrorCodeNoFreeMemory = 129
  • red_brick.ErrorCodeNoFreeSpace = 130
  • red_brick.ErrorCodeAccessDenied = 121
  • red_brick.ErrorCodeAlreadyExists = 132
  • red_brick.ErrorCodeDoesNotExist = 133
  • red_brick.ErrorCodeInterrupted = 134
  • red_brick.ErrorCodeIsDirectory = 135
  • red_brick.ErrorCodeNotADirectory = 136
  • red_brick.ErrorCodeWouldBlock = 137
  • red_brick.ErrorCodeOverflow = 138
  • red_brick.ErrorCodeBadFileDescriptor = 139
  • red_brick.ErrorCodeOutOfRange = 140
  • red_brick.ErrorCodeNameTooLong = 141
  • red_brick.ErrorCodeInvalidSeek = 142
  • red_brick.ErrorCodeNotSupported = 143
  • red_brick.ErrorCodeTooManyOpenFiles = 144
func (*REDBrick) CreatePipe(flags uint32, length uint64, sessionId uint16) (errorCode uint8, fileId uint16, err error)
Parameter:
  • flags – Typ: uint32, Wertebereich: Siehe Konstanten
  • length – Typ: uint64, Einheit: 1 B, Wertebereich: [0 bis 264 - 1]
  • sessionId – Typ: uint16, Wertebereich: [0 bis 216 - 1]
Rückgabe:
  • errorCode – Typ: uint8, Wertebereich: Siehe Konstanten
  • fileId – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • err – Typ: error

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

Für flags:

  • red_brick.PipeFlagNonBlockingRead = 1
  • red_brick.PipeFlagNonBlockingWrite = 2

Für errorCode:

  • red_brick.ErrorCodeSuccess = 0
  • red_brick.ErrorCodeUnknownError = 1
  • red_brick.ErrorCodeInvalidOperation = 2
  • red_brick.ErrorCodeOperationAborted = 3
  • red_brick.ErrorCodeInternalError = 4
  • red_brick.ErrorCodeUnknownSessionId = 5
  • red_brick.ErrorCodeNoFreeSessionId = 6
  • red_brick.ErrorCodeUnknownObjectId = 7
  • red_brick.ErrorCodeNoFreeObjectId = 8
  • red_brick.ErrorCodeObjectIsLocked = 9
  • red_brick.ErrorCodeNoMoreData = 10
  • red_brick.ErrorCodeWrongListItemType = 11
  • red_brick.ErrorCodeProgramIsPurged = 12
  • red_brick.ErrorCodeInvalidParameter = 128
  • red_brick.ErrorCodeNoFreeMemory = 129
  • red_brick.ErrorCodeNoFreeSpace = 130
  • red_brick.ErrorCodeAccessDenied = 121
  • red_brick.ErrorCodeAlreadyExists = 132
  • red_brick.ErrorCodeDoesNotExist = 133
  • red_brick.ErrorCodeInterrupted = 134
  • red_brick.ErrorCodeIsDirectory = 135
  • red_brick.ErrorCodeNotADirectory = 136
  • red_brick.ErrorCodeWouldBlock = 137
  • red_brick.ErrorCodeOverflow = 138
  • red_brick.ErrorCodeBadFileDescriptor = 139
  • red_brick.ErrorCodeOutOfRange = 140
  • red_brick.ErrorCodeNameTooLong = 141
  • red_brick.ErrorCodeInvalidSeek = 142
  • red_brick.ErrorCodeNotSupported = 143
  • red_brick.ErrorCodeTooManyOpenFiles = 144
func (*REDBrick) GetFileInfo(fileId uint16, sessionId uint16) (errorCode uint8, type_ uint8, nameStringId uint16, flags uint32, permissions uint16, uid uint32, gid uint32, length uint64, accessTimestamp uint64, modificationTimestamp uint64, statusChangeTimestamp uint64, err error)
Parameter:
  • fileId – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • sessionId – Typ: uint16, Wertebereich: [0 bis 216 - 1]
Rückgabe:
  • errorCode – Typ: uint8, Wertebereich: Siehe Konstanten
  • type – Typ: uint8, Wertebereich: Siehe Konstanten
  • nameStringId – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • flags – Typ: uint32, Wertebereich: Siehe Konstanten
  • permissions – Typ: uint16, Wertebereich: Siehe Konstanten
  • uid – Typ: uint32, Wertebereich: [0 bis 232 - 1]
  • gid – Typ: uint32, Wertebereich: [0 bis 232 - 1]
  • length – Typ: uint64, Einheit: 1 B, Wertebereich: [0 bis 264 - 1]
  • accessTimestamp – Typ: uint64, Wertebereich: [0 bis 264 - 1]
  • modificationTimestamp – Typ: uint64, Wertebereich: [0 bis 264 - 1]
  • statusChangeTimestamp – Typ: uint64, Wertebereich: [0 bis 264 - 1]
  • err – Typ: error

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

Für errorCode:

  • red_brick.ErrorCodeSuccess = 0
  • red_brick.ErrorCodeUnknownError = 1
  • red_brick.ErrorCodeInvalidOperation = 2
  • red_brick.ErrorCodeOperationAborted = 3
  • red_brick.ErrorCodeInternalError = 4
  • red_brick.ErrorCodeUnknownSessionId = 5
  • red_brick.ErrorCodeNoFreeSessionId = 6
  • red_brick.ErrorCodeUnknownObjectId = 7
  • red_brick.ErrorCodeNoFreeObjectId = 8
  • red_brick.ErrorCodeObjectIsLocked = 9
  • red_brick.ErrorCodeNoMoreData = 10
  • red_brick.ErrorCodeWrongListItemType = 11
  • red_brick.ErrorCodeProgramIsPurged = 12
  • red_brick.ErrorCodeInvalidParameter = 128
  • red_brick.ErrorCodeNoFreeMemory = 129
  • red_brick.ErrorCodeNoFreeSpace = 130
  • red_brick.ErrorCodeAccessDenied = 121
  • red_brick.ErrorCodeAlreadyExists = 132
  • red_brick.ErrorCodeDoesNotExist = 133
  • red_brick.ErrorCodeInterrupted = 134
  • red_brick.ErrorCodeIsDirectory = 135
  • red_brick.ErrorCodeNotADirectory = 136
  • red_brick.ErrorCodeWouldBlock = 137
  • red_brick.ErrorCodeOverflow = 138
  • red_brick.ErrorCodeBadFileDescriptor = 139
  • red_brick.ErrorCodeOutOfRange = 140
  • red_brick.ErrorCodeNameTooLong = 141
  • red_brick.ErrorCodeInvalidSeek = 142
  • red_brick.ErrorCodeNotSupported = 143
  • red_brick.ErrorCodeTooManyOpenFiles = 144

Für type:

  • red_brick.FileTypeUnknown = 0
  • red_brick.FileTypeRegular = 1
  • red_brick.FileTypeDirectory = 2
  • red_brick.FileTypeCharacter = 3
  • red_brick.FileTypeBlock = 4
  • red_brick.FileTypeFIFO = 5
  • red_brick.FileTypeSymlink = 6
  • red_brick.FileTypeSocket = 7
  • red_brick.FileTypePipe = 8

Für flags:

  • red_brick.FileFlagReadOnly = 1
  • red_brick.FileFlagWriteOnly = 2
  • red_brick.FileFlagReadWrite = 4
  • red_brick.FileFlagAppend = 8
  • red_brick.FileFlagCreate = 16
  • red_brick.FileFlagExclusive = 32
  • red_brick.FileFlagNonBlocking = 64
  • red_brick.FileFlagTruncate = 128
  • red_brick.FileFlagTemporary = 256
  • red_brick.FileFlagReplace = 512

Für permissions:

  • red_brick.FilePermissionUserAll = 448
  • red_brick.FilePermissionUserRead = 256
  • red_brick.FilePermissionUserWrite = 128
  • red_brick.FilePermissionUserExecute = 64
  • red_brick.FilePermissionGroupAll = 56
  • red_brick.FilePermissionGroupRead = 32
  • red_brick.FilePermissionGroupWrite = 16
  • red_brick.FilePermissionGroupExecute = 8
  • red_brick.FilePermissionOthersAll = 7
  • red_brick.FilePermissionOthersRead = 4
  • red_brick.FilePermissionOthersWrite = 2
  • red_brick.FilePermissionOthersExecute = 1
func (*REDBrick) ReadFile(fileId uint16, lengthToRead uint8) (errorCode uint8, buffer [62]uint8, lengthRead uint8, err error)
Parameter:
  • fileId – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • lengthToRead – Typ: uint8, Einheit: 1 B, Wertebereich: [0 bis 255]
Rückgabe:
  • errorCode – Typ: uint8, Wertebereich: Siehe Konstanten
  • buffer – Typ: [62]uint8, Wertebereich: [0 bis 255]
  • lengthRead – Typ: uint8, Einheit: 1 B, Wertebereich: [0 bis 255]
  • err – Typ: error

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

Für errorCode:

  • red_brick.ErrorCodeSuccess = 0
  • red_brick.ErrorCodeUnknownError = 1
  • red_brick.ErrorCodeInvalidOperation = 2
  • red_brick.ErrorCodeOperationAborted = 3
  • red_brick.ErrorCodeInternalError = 4
  • red_brick.ErrorCodeUnknownSessionId = 5
  • red_brick.ErrorCodeNoFreeSessionId = 6
  • red_brick.ErrorCodeUnknownObjectId = 7
  • red_brick.ErrorCodeNoFreeObjectId = 8
  • red_brick.ErrorCodeObjectIsLocked = 9
  • red_brick.ErrorCodeNoMoreData = 10
  • red_brick.ErrorCodeWrongListItemType = 11
  • red_brick.ErrorCodeProgramIsPurged = 12
  • red_brick.ErrorCodeInvalidParameter = 128
  • red_brick.ErrorCodeNoFreeMemory = 129
  • red_brick.ErrorCodeNoFreeSpace = 130
  • red_brick.ErrorCodeAccessDenied = 121
  • red_brick.ErrorCodeAlreadyExists = 132
  • red_brick.ErrorCodeDoesNotExist = 133
  • red_brick.ErrorCodeInterrupted = 134
  • red_brick.ErrorCodeIsDirectory = 135
  • red_brick.ErrorCodeNotADirectory = 136
  • red_brick.ErrorCodeWouldBlock = 137
  • red_brick.ErrorCodeOverflow = 138
  • red_brick.ErrorCodeBadFileDescriptor = 139
  • red_brick.ErrorCodeOutOfRange = 140
  • red_brick.ErrorCodeNameTooLong = 141
  • red_brick.ErrorCodeInvalidSeek = 142
  • red_brick.ErrorCodeNotSupported = 143
  • red_brick.ErrorCodeTooManyOpenFiles = 144
func (*REDBrick) ReadFileAsync(fileId uint16, lengthToRead uint64) (err error)
Parameter:
  • fileId – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • lengthToRead – Typ: uint64, Einheit: 1 B, Wertebereich: [0 bis 264 - 1]
Rückgabe:
  • err – Typ: error
func (*REDBrick) AbortAsyncFileRead(fileId uint16) (errorCode uint8, err error)
Parameter:
  • fileId – Typ: uint16, Wertebereich: [0 bis 216 - 1]
Rückgabe:
  • errorCode – Typ: uint8, Wertebereich: Siehe Konstanten
  • err – Typ: error

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

Für errorCode:

  • red_brick.ErrorCodeSuccess = 0
  • red_brick.ErrorCodeUnknownError = 1
  • red_brick.ErrorCodeInvalidOperation = 2
  • red_brick.ErrorCodeOperationAborted = 3
  • red_brick.ErrorCodeInternalError = 4
  • red_brick.ErrorCodeUnknownSessionId = 5
  • red_brick.ErrorCodeNoFreeSessionId = 6
  • red_brick.ErrorCodeUnknownObjectId = 7
  • red_brick.ErrorCodeNoFreeObjectId = 8
  • red_brick.ErrorCodeObjectIsLocked = 9
  • red_brick.ErrorCodeNoMoreData = 10
  • red_brick.ErrorCodeWrongListItemType = 11
  • red_brick.ErrorCodeProgramIsPurged = 12
  • red_brick.ErrorCodeInvalidParameter = 128
  • red_brick.ErrorCodeNoFreeMemory = 129
  • red_brick.ErrorCodeNoFreeSpace = 130
  • red_brick.ErrorCodeAccessDenied = 121
  • red_brick.ErrorCodeAlreadyExists = 132
  • red_brick.ErrorCodeDoesNotExist = 133
  • red_brick.ErrorCodeInterrupted = 134
  • red_brick.ErrorCodeIsDirectory = 135
  • red_brick.ErrorCodeNotADirectory = 136
  • red_brick.ErrorCodeWouldBlock = 137
  • red_brick.ErrorCodeOverflow = 138
  • red_brick.ErrorCodeBadFileDescriptor = 139
  • red_brick.ErrorCodeOutOfRange = 140
  • red_brick.ErrorCodeNameTooLong = 141
  • red_brick.ErrorCodeInvalidSeek = 142
  • red_brick.ErrorCodeNotSupported = 143
  • red_brick.ErrorCodeTooManyOpenFiles = 144
func (*REDBrick) WriteFile(fileId uint16, buffer [61]uint8, lengthToWrite uint8) (errorCode uint8, lengthWritten uint8, err error)
Parameter:
  • fileId – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • buffer – Typ: [61]uint8, Wertebereich: [0 bis 255]
  • lengthToWrite – Typ: uint8, Einheit: 1 B, Wertebereich: [0 bis 255]
Rückgabe:
  • errorCode – Typ: uint8, Wertebereich: Siehe Konstanten
  • lengthWritten – Typ: uint8, Einheit: 1 B, Wertebereich: [0 bis 255]
  • err – Typ: error

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

Für errorCode:

  • red_brick.ErrorCodeSuccess = 0
  • red_brick.ErrorCodeUnknownError = 1
  • red_brick.ErrorCodeInvalidOperation = 2
  • red_brick.ErrorCodeOperationAborted = 3
  • red_brick.ErrorCodeInternalError = 4
  • red_brick.ErrorCodeUnknownSessionId = 5
  • red_brick.ErrorCodeNoFreeSessionId = 6
  • red_brick.ErrorCodeUnknownObjectId = 7
  • red_brick.ErrorCodeNoFreeObjectId = 8
  • red_brick.ErrorCodeObjectIsLocked = 9
  • red_brick.ErrorCodeNoMoreData = 10
  • red_brick.ErrorCodeWrongListItemType = 11
  • red_brick.ErrorCodeProgramIsPurged = 12
  • red_brick.ErrorCodeInvalidParameter = 128
  • red_brick.ErrorCodeNoFreeMemory = 129
  • red_brick.ErrorCodeNoFreeSpace = 130
  • red_brick.ErrorCodeAccessDenied = 121
  • red_brick.ErrorCodeAlreadyExists = 132
  • red_brick.ErrorCodeDoesNotExist = 133
  • red_brick.ErrorCodeInterrupted = 134
  • red_brick.ErrorCodeIsDirectory = 135
  • red_brick.ErrorCodeNotADirectory = 136
  • red_brick.ErrorCodeWouldBlock = 137
  • red_brick.ErrorCodeOverflow = 138
  • red_brick.ErrorCodeBadFileDescriptor = 139
  • red_brick.ErrorCodeOutOfRange = 140
  • red_brick.ErrorCodeNameTooLong = 141
  • red_brick.ErrorCodeInvalidSeek = 142
  • red_brick.ErrorCodeNotSupported = 143
  • red_brick.ErrorCodeTooManyOpenFiles = 144
func (*REDBrick) WriteFileUnchecked(fileId uint16, buffer [61]uint8, lengthToWrite uint8) (err error)
Parameter:
  • fileId – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • buffer – Typ: [61]uint8, Wertebereich: [0 bis 255]
  • lengthToWrite – Typ: uint8, Einheit: 1 B, Wertebereich: [0 bis 255]
Rückgabe:
  • err – Typ: error
func (*REDBrick) WriteFileAsync(fileId uint16, buffer [61]uint8, lengthToWrite uint8) (err error)
Parameter:
  • fileId – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • buffer – Typ: [61]uint8, Wertebereich: [0 bis 255]
  • lengthToWrite – Typ: uint8, Einheit: 1 B, Wertebereich: [0 bis 255]
Rückgabe:
  • err – Typ: error
func (*REDBrick) SetFilePosition(fileId uint16, offset int64, origin uint8) (errorCode uint8, position uint64, err error)
Parameter:
  • fileId – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • offset – Typ: int64, Einheit: 1 B, Wertebereich: [-263 bis 263 - 1]
  • origin – Typ: uint8, Wertebereich: Siehe Konstanten
Rückgabe:
  • errorCode – Typ: uint8, Wertebereich: Siehe Konstanten
  • position – Typ: uint64, Einheit: 1 B, Wertebereich: [0 bis 264 - 1]
  • err – Typ: error

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

Für origin:

  • red_brick.FileOriginBeginning = 0
  • red_brick.FileOriginCurrent = 1
  • red_brick.FileOriginEnd = 2

Für errorCode:

  • red_brick.ErrorCodeSuccess = 0
  • red_brick.ErrorCodeUnknownError = 1
  • red_brick.ErrorCodeInvalidOperation = 2
  • red_brick.ErrorCodeOperationAborted = 3
  • red_brick.ErrorCodeInternalError = 4
  • red_brick.ErrorCodeUnknownSessionId = 5
  • red_brick.ErrorCodeNoFreeSessionId = 6
  • red_brick.ErrorCodeUnknownObjectId = 7
  • red_brick.ErrorCodeNoFreeObjectId = 8
  • red_brick.ErrorCodeObjectIsLocked = 9
  • red_brick.ErrorCodeNoMoreData = 10
  • red_brick.ErrorCodeWrongListItemType = 11
  • red_brick.ErrorCodeProgramIsPurged = 12
  • red_brick.ErrorCodeInvalidParameter = 128
  • red_brick.ErrorCodeNoFreeMemory = 129
  • red_brick.ErrorCodeNoFreeSpace = 130
  • red_brick.ErrorCodeAccessDenied = 121
  • red_brick.ErrorCodeAlreadyExists = 132
  • red_brick.ErrorCodeDoesNotExist = 133
  • red_brick.ErrorCodeInterrupted = 134
  • red_brick.ErrorCodeIsDirectory = 135
  • red_brick.ErrorCodeNotADirectory = 136
  • red_brick.ErrorCodeWouldBlock = 137
  • red_brick.ErrorCodeOverflow = 138
  • red_brick.ErrorCodeBadFileDescriptor = 139
  • red_brick.ErrorCodeOutOfRange = 140
  • red_brick.ErrorCodeNameTooLong = 141
  • red_brick.ErrorCodeInvalidSeek = 142
  • red_brick.ErrorCodeNotSupported = 143
  • red_brick.ErrorCodeTooManyOpenFiles = 144
func (*REDBrick) GetFilePosition(fileId uint16) (errorCode uint8, position uint64, err error)
Parameter:
  • fileId – Typ: uint16, Wertebereich: [0 bis 216 - 1]
Rückgabe:
  • errorCode – Typ: uint8, Wertebereich: Siehe Konstanten
  • position – Typ: uint64, Einheit: 1 B, Wertebereich: [0 bis 264 - 1]
  • err – Typ: error

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

Für errorCode:

  • red_brick.ErrorCodeSuccess = 0
  • red_brick.ErrorCodeUnknownError = 1
  • red_brick.ErrorCodeInvalidOperation = 2
  • red_brick.ErrorCodeOperationAborted = 3
  • red_brick.ErrorCodeInternalError = 4
  • red_brick.ErrorCodeUnknownSessionId = 5
  • red_brick.ErrorCodeNoFreeSessionId = 6
  • red_brick.ErrorCodeUnknownObjectId = 7
  • red_brick.ErrorCodeNoFreeObjectId = 8
  • red_brick.ErrorCodeObjectIsLocked = 9
  • red_brick.ErrorCodeNoMoreData = 10
  • red_brick.ErrorCodeWrongListItemType = 11
  • red_brick.ErrorCodeProgramIsPurged = 12
  • red_brick.ErrorCodeInvalidParameter = 128
  • red_brick.ErrorCodeNoFreeMemory = 129
  • red_brick.ErrorCodeNoFreeSpace = 130
  • red_brick.ErrorCodeAccessDenied = 121
  • red_brick.ErrorCodeAlreadyExists = 132
  • red_brick.ErrorCodeDoesNotExist = 133
  • red_brick.ErrorCodeInterrupted = 134
  • red_brick.ErrorCodeIsDirectory = 135
  • red_brick.ErrorCodeNotADirectory = 136
  • red_brick.ErrorCodeWouldBlock = 137
  • red_brick.ErrorCodeOverflow = 138
  • red_brick.ErrorCodeBadFileDescriptor = 139
  • red_brick.ErrorCodeOutOfRange = 140
  • red_brick.ErrorCodeNameTooLong = 141
  • red_brick.ErrorCodeInvalidSeek = 142
  • red_brick.ErrorCodeNotSupported = 143
  • red_brick.ErrorCodeTooManyOpenFiles = 144
func (*REDBrick) SetFileEvents(fileId uint16, events uint16) (errorCode uint8, err error)
Parameter:
  • fileId – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • events – Typ: uint16, Wertebereich: Siehe Konstanten
Rückgabe:
  • errorCode – Typ: uint8, Wertebereich: Siehe Konstanten
  • err – Typ: error

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

Für events:

  • red_brick.FileEventReadable = 1
  • red_brick.FileEventWritable = 2

Für errorCode:

  • red_brick.ErrorCodeSuccess = 0
  • red_brick.ErrorCodeUnknownError = 1
  • red_brick.ErrorCodeInvalidOperation = 2
  • red_brick.ErrorCodeOperationAborted = 3
  • red_brick.ErrorCodeInternalError = 4
  • red_brick.ErrorCodeUnknownSessionId = 5
  • red_brick.ErrorCodeNoFreeSessionId = 6
  • red_brick.ErrorCodeUnknownObjectId = 7
  • red_brick.ErrorCodeNoFreeObjectId = 8
  • red_brick.ErrorCodeObjectIsLocked = 9
  • red_brick.ErrorCodeNoMoreData = 10
  • red_brick.ErrorCodeWrongListItemType = 11
  • red_brick.ErrorCodeProgramIsPurged = 12
  • red_brick.ErrorCodeInvalidParameter = 128
  • red_brick.ErrorCodeNoFreeMemory = 129
  • red_brick.ErrorCodeNoFreeSpace = 130
  • red_brick.ErrorCodeAccessDenied = 121
  • red_brick.ErrorCodeAlreadyExists = 132
  • red_brick.ErrorCodeDoesNotExist = 133
  • red_brick.ErrorCodeInterrupted = 134
  • red_brick.ErrorCodeIsDirectory = 135
  • red_brick.ErrorCodeNotADirectory = 136
  • red_brick.ErrorCodeWouldBlock = 137
  • red_brick.ErrorCodeOverflow = 138
  • red_brick.ErrorCodeBadFileDescriptor = 139
  • red_brick.ErrorCodeOutOfRange = 140
  • red_brick.ErrorCodeNameTooLong = 141
  • red_brick.ErrorCodeInvalidSeek = 142
  • red_brick.ErrorCodeNotSupported = 143
  • red_brick.ErrorCodeTooManyOpenFiles = 144
func (*REDBrick) GetFileEvents(fileId uint16) (errorCode uint8, events uint16, err error)
Parameter:
  • fileId – Typ: uint16, Wertebereich: [0 bis 216 - 1]
Rückgabe:
  • errorCode – Typ: uint8, Wertebereich: Siehe Konstanten
  • events – Typ: uint16, Wertebereich: Siehe Konstanten
  • err – Typ: error

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

Für errorCode:

  • red_brick.ErrorCodeSuccess = 0
  • red_brick.ErrorCodeUnknownError = 1
  • red_brick.ErrorCodeInvalidOperation = 2
  • red_brick.ErrorCodeOperationAborted = 3
  • red_brick.ErrorCodeInternalError = 4
  • red_brick.ErrorCodeUnknownSessionId = 5
  • red_brick.ErrorCodeNoFreeSessionId = 6
  • red_brick.ErrorCodeUnknownObjectId = 7
  • red_brick.ErrorCodeNoFreeObjectId = 8
  • red_brick.ErrorCodeObjectIsLocked = 9
  • red_brick.ErrorCodeNoMoreData = 10
  • red_brick.ErrorCodeWrongListItemType = 11
  • red_brick.ErrorCodeProgramIsPurged = 12
  • red_brick.ErrorCodeInvalidParameter = 128
  • red_brick.ErrorCodeNoFreeMemory = 129
  • red_brick.ErrorCodeNoFreeSpace = 130
  • red_brick.ErrorCodeAccessDenied = 121
  • red_brick.ErrorCodeAlreadyExists = 132
  • red_brick.ErrorCodeDoesNotExist = 133
  • red_brick.ErrorCodeInterrupted = 134
  • red_brick.ErrorCodeIsDirectory = 135
  • red_brick.ErrorCodeNotADirectory = 136
  • red_brick.ErrorCodeWouldBlock = 137
  • red_brick.ErrorCodeOverflow = 138
  • red_brick.ErrorCodeBadFileDescriptor = 139
  • red_brick.ErrorCodeOutOfRange = 140
  • red_brick.ErrorCodeNameTooLong = 141
  • red_brick.ErrorCodeInvalidSeek = 142
  • red_brick.ErrorCodeNotSupported = 143
  • red_brick.ErrorCodeTooManyOpenFiles = 144

Für events:

  • red_brick.FileEventReadable = 1
  • red_brick.FileEventWritable = 2
func (*REDBrick) OpenDirectory(nameStringId uint16, sessionId uint16) (errorCode uint8, directoryId uint16, err error)
Parameter:
  • nameStringId – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • sessionId – Typ: uint16, Wertebereich: [0 bis 216 - 1]
Rückgabe:
  • errorCode – Typ: uint8, Wertebereich: Siehe Konstanten
  • directoryId – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • err – Typ: error

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

Für errorCode:

  • red_brick.ErrorCodeSuccess = 0
  • red_brick.ErrorCodeUnknownError = 1
  • red_brick.ErrorCodeInvalidOperation = 2
  • red_brick.ErrorCodeOperationAborted = 3
  • red_brick.ErrorCodeInternalError = 4
  • red_brick.ErrorCodeUnknownSessionId = 5
  • red_brick.ErrorCodeNoFreeSessionId = 6
  • red_brick.ErrorCodeUnknownObjectId = 7
  • red_brick.ErrorCodeNoFreeObjectId = 8
  • red_brick.ErrorCodeObjectIsLocked = 9
  • red_brick.ErrorCodeNoMoreData = 10
  • red_brick.ErrorCodeWrongListItemType = 11
  • red_brick.ErrorCodeProgramIsPurged = 12
  • red_brick.ErrorCodeInvalidParameter = 128
  • red_brick.ErrorCodeNoFreeMemory = 129
  • red_brick.ErrorCodeNoFreeSpace = 130
  • red_brick.ErrorCodeAccessDenied = 121
  • red_brick.ErrorCodeAlreadyExists = 132
  • red_brick.ErrorCodeDoesNotExist = 133
  • red_brick.ErrorCodeInterrupted = 134
  • red_brick.ErrorCodeIsDirectory = 135
  • red_brick.ErrorCodeNotADirectory = 136
  • red_brick.ErrorCodeWouldBlock = 137
  • red_brick.ErrorCodeOverflow = 138
  • red_brick.ErrorCodeBadFileDescriptor = 139
  • red_brick.ErrorCodeOutOfRange = 140
  • red_brick.ErrorCodeNameTooLong = 141
  • red_brick.ErrorCodeInvalidSeek = 142
  • red_brick.ErrorCodeNotSupported = 143
  • red_brick.ErrorCodeTooManyOpenFiles = 144
func (*REDBrick) GetDirectoryName(directoryId uint16, sessionId uint16) (errorCode uint8, nameStringId uint16, err error)
Parameter:
  • directoryId – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • sessionId – Typ: uint16, Wertebereich: [0 bis 216 - 1]
Rückgabe:
  • errorCode – Typ: uint8, Wertebereich: Siehe Konstanten
  • nameStringId – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • err – Typ: error

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

Für errorCode:

  • red_brick.ErrorCodeSuccess = 0
  • red_brick.ErrorCodeUnknownError = 1
  • red_brick.ErrorCodeInvalidOperation = 2
  • red_brick.ErrorCodeOperationAborted = 3
  • red_brick.ErrorCodeInternalError = 4
  • red_brick.ErrorCodeUnknownSessionId = 5
  • red_brick.ErrorCodeNoFreeSessionId = 6
  • red_brick.ErrorCodeUnknownObjectId = 7
  • red_brick.ErrorCodeNoFreeObjectId = 8
  • red_brick.ErrorCodeObjectIsLocked = 9
  • red_brick.ErrorCodeNoMoreData = 10
  • red_brick.ErrorCodeWrongListItemType = 11
  • red_brick.ErrorCodeProgramIsPurged = 12
  • red_brick.ErrorCodeInvalidParameter = 128
  • red_brick.ErrorCodeNoFreeMemory = 129
  • red_brick.ErrorCodeNoFreeSpace = 130
  • red_brick.ErrorCodeAccessDenied = 121
  • red_brick.ErrorCodeAlreadyExists = 132
  • red_brick.ErrorCodeDoesNotExist = 133
  • red_brick.ErrorCodeInterrupted = 134
  • red_brick.ErrorCodeIsDirectory = 135
  • red_brick.ErrorCodeNotADirectory = 136
  • red_brick.ErrorCodeWouldBlock = 137
  • red_brick.ErrorCodeOverflow = 138
  • red_brick.ErrorCodeBadFileDescriptor = 139
  • red_brick.ErrorCodeOutOfRange = 140
  • red_brick.ErrorCodeNameTooLong = 141
  • red_brick.ErrorCodeInvalidSeek = 142
  • red_brick.ErrorCodeNotSupported = 143
  • red_brick.ErrorCodeTooManyOpenFiles = 144
func (*REDBrick) GetNextDirectoryEntry(directoryId uint16, sessionId uint16) (errorCode uint8, nameStringId uint16, type_ uint8, err error)
Parameter:
  • directoryId – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • sessionId – Typ: uint16, Wertebereich: [0 bis 216 - 1]
Rückgabe:
  • errorCode – Typ: uint8, Wertebereich: Siehe Konstanten
  • nameStringId – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • type – Typ: uint8, Wertebereich: Siehe Konstanten
  • err – Typ: error

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

Für errorCode:

  • red_brick.ErrorCodeSuccess = 0
  • red_brick.ErrorCodeUnknownError = 1
  • red_brick.ErrorCodeInvalidOperation = 2
  • red_brick.ErrorCodeOperationAborted = 3
  • red_brick.ErrorCodeInternalError = 4
  • red_brick.ErrorCodeUnknownSessionId = 5
  • red_brick.ErrorCodeNoFreeSessionId = 6
  • red_brick.ErrorCodeUnknownObjectId = 7
  • red_brick.ErrorCodeNoFreeObjectId = 8
  • red_brick.ErrorCodeObjectIsLocked = 9
  • red_brick.ErrorCodeNoMoreData = 10
  • red_brick.ErrorCodeWrongListItemType = 11
  • red_brick.ErrorCodeProgramIsPurged = 12
  • red_brick.ErrorCodeInvalidParameter = 128
  • red_brick.ErrorCodeNoFreeMemory = 129
  • red_brick.ErrorCodeNoFreeSpace = 130
  • red_brick.ErrorCodeAccessDenied = 121
  • red_brick.ErrorCodeAlreadyExists = 132
  • red_brick.ErrorCodeDoesNotExist = 133
  • red_brick.ErrorCodeInterrupted = 134
  • red_brick.ErrorCodeIsDirectory = 135
  • red_brick.ErrorCodeNotADirectory = 136
  • red_brick.ErrorCodeWouldBlock = 137
  • red_brick.ErrorCodeOverflow = 138
  • red_brick.ErrorCodeBadFileDescriptor = 139
  • red_brick.ErrorCodeOutOfRange = 140
  • red_brick.ErrorCodeNameTooLong = 141
  • red_brick.ErrorCodeInvalidSeek = 142
  • red_brick.ErrorCodeNotSupported = 143
  • red_brick.ErrorCodeTooManyOpenFiles = 144

Für type:

  • red_brick.DirectoryEntryTypeUnknown = 0
  • red_brick.DirectoryEntryTypeRegular = 1
  • red_brick.DirectoryEntryTypeDirectory = 2
  • red_brick.DirectoryEntryTypeCharacter = 3
  • red_brick.DirectoryEntryTypeBlock = 4
  • red_brick.DirectoryEntryTypeFIFO = 5
  • red_brick.DirectoryEntryTypeSymlink = 6
  • red_brick.DirectoryEntryTypeSocket = 7
func (*REDBrick) RewindDirectory(directoryId uint16) (errorCode uint8, err error)
Parameter:
  • directoryId – Typ: uint16, Wertebereich: [0 bis 216 - 1]
Rückgabe:
  • errorCode – Typ: uint8, Wertebereich: Siehe Konstanten
  • err – Typ: error

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

Für errorCode:

  • red_brick.ErrorCodeSuccess = 0
  • red_brick.ErrorCodeUnknownError = 1
  • red_brick.ErrorCodeInvalidOperation = 2
  • red_brick.ErrorCodeOperationAborted = 3
  • red_brick.ErrorCodeInternalError = 4
  • red_brick.ErrorCodeUnknownSessionId = 5
  • red_brick.ErrorCodeNoFreeSessionId = 6
  • red_brick.ErrorCodeUnknownObjectId = 7
  • red_brick.ErrorCodeNoFreeObjectId = 8
  • red_brick.ErrorCodeObjectIsLocked = 9
  • red_brick.ErrorCodeNoMoreData = 10
  • red_brick.ErrorCodeWrongListItemType = 11
  • red_brick.ErrorCodeProgramIsPurged = 12
  • red_brick.ErrorCodeInvalidParameter = 128
  • red_brick.ErrorCodeNoFreeMemory = 129
  • red_brick.ErrorCodeNoFreeSpace = 130
  • red_brick.ErrorCodeAccessDenied = 121
  • red_brick.ErrorCodeAlreadyExists = 132
  • red_brick.ErrorCodeDoesNotExist = 133
  • red_brick.ErrorCodeInterrupted = 134
  • red_brick.ErrorCodeIsDirectory = 135
  • red_brick.ErrorCodeNotADirectory = 136
  • red_brick.ErrorCodeWouldBlock = 137
  • red_brick.ErrorCodeOverflow = 138
  • red_brick.ErrorCodeBadFileDescriptor = 139
  • red_brick.ErrorCodeOutOfRange = 140
  • red_brick.ErrorCodeNameTooLong = 141
  • red_brick.ErrorCodeInvalidSeek = 142
  • red_brick.ErrorCodeNotSupported = 143
  • red_brick.ErrorCodeTooManyOpenFiles = 144
func (*REDBrick) CreateDirectory(nameStringId uint16, flags uint32, permissions uint16, uid uint32, gid uint32) (errorCode uint8, err error)
Parameter:
  • nameStringId – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • flags – Typ: uint32, Wertebereich: Siehe Konstanten
  • permissions – Typ: uint16, Wertebereich: Siehe Konstanten
  • uid – Typ: uint32, Wertebereich: [0 bis 232 - 1]
  • gid – Typ: uint32, Wertebereich: [0 bis 232 - 1]
Rückgabe:
  • errorCode – Typ: uint8, Wertebereich: Siehe Konstanten
  • err – Typ: error

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

Für flags:

  • red_brick.DirectoryFlagRecursive = 1
  • red_brick.DirectoryFlagExclusive = 2

Für permissions:

  • red_brick.FilePermissionUserAll = 448
  • red_brick.FilePermissionUserRead = 256
  • red_brick.FilePermissionUserWrite = 128
  • red_brick.FilePermissionUserExecute = 64
  • red_brick.FilePermissionGroupAll = 56
  • red_brick.FilePermissionGroupRead = 32
  • red_brick.FilePermissionGroupWrite = 16
  • red_brick.FilePermissionGroupExecute = 8
  • red_brick.FilePermissionOthersAll = 7
  • red_brick.FilePermissionOthersRead = 4
  • red_brick.FilePermissionOthersWrite = 2
  • red_brick.FilePermissionOthersExecute = 1

Für errorCode:

  • red_brick.ErrorCodeSuccess = 0
  • red_brick.ErrorCodeUnknownError = 1
  • red_brick.ErrorCodeInvalidOperation = 2
  • red_brick.ErrorCodeOperationAborted = 3
  • red_brick.ErrorCodeInternalError = 4
  • red_brick.ErrorCodeUnknownSessionId = 5
  • red_brick.ErrorCodeNoFreeSessionId = 6
  • red_brick.ErrorCodeUnknownObjectId = 7
  • red_brick.ErrorCodeNoFreeObjectId = 8
  • red_brick.ErrorCodeObjectIsLocked = 9
  • red_brick.ErrorCodeNoMoreData = 10
  • red_brick.ErrorCodeWrongListItemType = 11
  • red_brick.ErrorCodeProgramIsPurged = 12
  • red_brick.ErrorCodeInvalidParameter = 128
  • red_brick.ErrorCodeNoFreeMemory = 129
  • red_brick.ErrorCodeNoFreeSpace = 130
  • red_brick.ErrorCodeAccessDenied = 121
  • red_brick.ErrorCodeAlreadyExists = 132
  • red_brick.ErrorCodeDoesNotExist = 133
  • red_brick.ErrorCodeInterrupted = 134
  • red_brick.ErrorCodeIsDirectory = 135
  • red_brick.ErrorCodeNotADirectory = 136
  • red_brick.ErrorCodeWouldBlock = 137
  • red_brick.ErrorCodeOverflow = 138
  • red_brick.ErrorCodeBadFileDescriptor = 139
  • red_brick.ErrorCodeOutOfRange = 140
  • red_brick.ErrorCodeNameTooLong = 141
  • red_brick.ErrorCodeInvalidSeek = 142
  • red_brick.ErrorCodeNotSupported = 143
  • red_brick.ErrorCodeTooManyOpenFiles = 144
func (*REDBrick) GetProcesses(sessionId uint16) (errorCode uint8, processesListId uint16, err error)
Parameter:
  • sessionId – Typ: uint16, Wertebereich: [0 bis 216 - 1]
Rückgabe:
  • errorCode – Typ: uint8, Wertebereich: Siehe Konstanten
  • processesListId – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • err – Typ: error

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

Für errorCode:

  • red_brick.ErrorCodeSuccess = 0
  • red_brick.ErrorCodeUnknownError = 1
  • red_brick.ErrorCodeInvalidOperation = 2
  • red_brick.ErrorCodeOperationAborted = 3
  • red_brick.ErrorCodeInternalError = 4
  • red_brick.ErrorCodeUnknownSessionId = 5
  • red_brick.ErrorCodeNoFreeSessionId = 6
  • red_brick.ErrorCodeUnknownObjectId = 7
  • red_brick.ErrorCodeNoFreeObjectId = 8
  • red_brick.ErrorCodeObjectIsLocked = 9
  • red_brick.ErrorCodeNoMoreData = 10
  • red_brick.ErrorCodeWrongListItemType = 11
  • red_brick.ErrorCodeProgramIsPurged = 12
  • red_brick.ErrorCodeInvalidParameter = 128
  • red_brick.ErrorCodeNoFreeMemory = 129
  • red_brick.ErrorCodeNoFreeSpace = 130
  • red_brick.ErrorCodeAccessDenied = 121
  • red_brick.ErrorCodeAlreadyExists = 132
  • red_brick.ErrorCodeDoesNotExist = 133
  • red_brick.ErrorCodeInterrupted = 134
  • red_brick.ErrorCodeIsDirectory = 135
  • red_brick.ErrorCodeNotADirectory = 136
  • red_brick.ErrorCodeWouldBlock = 137
  • red_brick.ErrorCodeOverflow = 138
  • red_brick.ErrorCodeBadFileDescriptor = 139
  • red_brick.ErrorCodeOutOfRange = 140
  • red_brick.ErrorCodeNameTooLong = 141
  • red_brick.ErrorCodeInvalidSeek = 142
  • red_brick.ErrorCodeNotSupported = 143
  • red_brick.ErrorCodeTooManyOpenFiles = 144
func (*REDBrick) SpawnProcess(executableStringId uint16, argumentsListId uint16, environmentListId uint16, workingDirectoryStringId uint16, uid uint32, gid uint32, stdinFileId uint16, stdoutFileId uint16, stderrFileId uint16, sessionId uint16) (errorCode uint8, processId uint16, err error)
Parameter:
  • executableStringId – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • argumentsListId – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • environmentListId – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • workingDirectoryStringId – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • uid – Typ: uint32, Wertebereich: [0 bis 232 - 1]
  • gid – Typ: uint32, Wertebereich: [0 bis 232 - 1]
  • stdinFileId – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • stdoutFileId – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • stderrFileId – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • sessionId – Typ: uint16, Wertebereich: [0 bis 216 - 1]
Rückgabe:
  • errorCode – Typ: uint8, Wertebereich: Siehe Konstanten
  • processId – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • err – Typ: error

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

Für errorCode:

  • red_brick.ErrorCodeSuccess = 0
  • red_brick.ErrorCodeUnknownError = 1
  • red_brick.ErrorCodeInvalidOperation = 2
  • red_brick.ErrorCodeOperationAborted = 3
  • red_brick.ErrorCodeInternalError = 4
  • red_brick.ErrorCodeUnknownSessionId = 5
  • red_brick.ErrorCodeNoFreeSessionId = 6
  • red_brick.ErrorCodeUnknownObjectId = 7
  • red_brick.ErrorCodeNoFreeObjectId = 8
  • red_brick.ErrorCodeObjectIsLocked = 9
  • red_brick.ErrorCodeNoMoreData = 10
  • red_brick.ErrorCodeWrongListItemType = 11
  • red_brick.ErrorCodeProgramIsPurged = 12
  • red_brick.ErrorCodeInvalidParameter = 128
  • red_brick.ErrorCodeNoFreeMemory = 129
  • red_brick.ErrorCodeNoFreeSpace = 130
  • red_brick.ErrorCodeAccessDenied = 121
  • red_brick.ErrorCodeAlreadyExists = 132
  • red_brick.ErrorCodeDoesNotExist = 133
  • red_brick.ErrorCodeInterrupted = 134
  • red_brick.ErrorCodeIsDirectory = 135
  • red_brick.ErrorCodeNotADirectory = 136
  • red_brick.ErrorCodeWouldBlock = 137
  • red_brick.ErrorCodeOverflow = 138
  • red_brick.ErrorCodeBadFileDescriptor = 139
  • red_brick.ErrorCodeOutOfRange = 140
  • red_brick.ErrorCodeNameTooLong = 141
  • red_brick.ErrorCodeInvalidSeek = 142
  • red_brick.ErrorCodeNotSupported = 143
  • red_brick.ErrorCodeTooManyOpenFiles = 144
func (*REDBrick) KillProcess(processId uint16, signal uint8) (errorCode uint8, err error)
Parameter:
  • processId – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • signal – Typ: uint8, Wertebereich: Siehe Konstanten
Rückgabe:
  • errorCode – Typ: uint8, Wertebereich: Siehe Konstanten
  • err – Typ: error

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

Für signal:

  • red_brick.ProcessSignalInterrupt = 2
  • red_brick.ProcessSignalQuit = 3
  • red_brick.ProcessSignalAbort = 6
  • red_brick.ProcessSignalKill = 9
  • red_brick.ProcessSignalUser1 = 10
  • red_brick.ProcessSignalUser2 = 12
  • red_brick.ProcessSignalTerminate = 15
  • red_brick.ProcessSignalContinue = 18
  • red_brick.ProcessSignalStop = 19

Für errorCode:

  • red_brick.ErrorCodeSuccess = 0
  • red_brick.ErrorCodeUnknownError = 1
  • red_brick.ErrorCodeInvalidOperation = 2
  • red_brick.ErrorCodeOperationAborted = 3
  • red_brick.ErrorCodeInternalError = 4
  • red_brick.ErrorCodeUnknownSessionId = 5
  • red_brick.ErrorCodeNoFreeSessionId = 6
  • red_brick.ErrorCodeUnknownObjectId = 7
  • red_brick.ErrorCodeNoFreeObjectId = 8
  • red_brick.ErrorCodeObjectIsLocked = 9
  • red_brick.ErrorCodeNoMoreData = 10
  • red_brick.ErrorCodeWrongListItemType = 11
  • red_brick.ErrorCodeProgramIsPurged = 12
  • red_brick.ErrorCodeInvalidParameter = 128
  • red_brick.ErrorCodeNoFreeMemory = 129
  • red_brick.ErrorCodeNoFreeSpace = 130
  • red_brick.ErrorCodeAccessDenied = 121
  • red_brick.ErrorCodeAlreadyExists = 132
  • red_brick.ErrorCodeDoesNotExist = 133
  • red_brick.ErrorCodeInterrupted = 134
  • red_brick.ErrorCodeIsDirectory = 135
  • red_brick.ErrorCodeNotADirectory = 136
  • red_brick.ErrorCodeWouldBlock = 137
  • red_brick.ErrorCodeOverflow = 138
  • red_brick.ErrorCodeBadFileDescriptor = 139
  • red_brick.ErrorCodeOutOfRange = 140
  • red_brick.ErrorCodeNameTooLong = 141
  • red_brick.ErrorCodeInvalidSeek = 142
  • red_brick.ErrorCodeNotSupported = 143
  • red_brick.ErrorCodeTooManyOpenFiles = 144
func (*REDBrick) GetProcessCommand(processId uint16, sessionId uint16) (errorCode uint8, executableStringId uint16, argumentsListId uint16, environmentListId uint16, workingDirectoryStringId uint16, err error)
Parameter:
  • processId – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • sessionId – Typ: uint16, Wertebereich: [0 bis 216 - 1]
Rückgabe:
  • errorCode – Typ: uint8, Wertebereich: Siehe Konstanten
  • executableStringId – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • argumentsListId – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • environmentListId – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • workingDirectoryStringId – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • err – Typ: error

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

Für errorCode:

  • red_brick.ErrorCodeSuccess = 0
  • red_brick.ErrorCodeUnknownError = 1
  • red_brick.ErrorCodeInvalidOperation = 2
  • red_brick.ErrorCodeOperationAborted = 3
  • red_brick.ErrorCodeInternalError = 4
  • red_brick.ErrorCodeUnknownSessionId = 5
  • red_brick.ErrorCodeNoFreeSessionId = 6
  • red_brick.ErrorCodeUnknownObjectId = 7
  • red_brick.ErrorCodeNoFreeObjectId = 8
  • red_brick.ErrorCodeObjectIsLocked = 9
  • red_brick.ErrorCodeNoMoreData = 10
  • red_brick.ErrorCodeWrongListItemType = 11
  • red_brick.ErrorCodeProgramIsPurged = 12
  • red_brick.ErrorCodeInvalidParameter = 128
  • red_brick.ErrorCodeNoFreeMemory = 129
  • red_brick.ErrorCodeNoFreeSpace = 130
  • red_brick.ErrorCodeAccessDenied = 121
  • red_brick.ErrorCodeAlreadyExists = 132
  • red_brick.ErrorCodeDoesNotExist = 133
  • red_brick.ErrorCodeInterrupted = 134
  • red_brick.ErrorCodeIsDirectory = 135
  • red_brick.ErrorCodeNotADirectory = 136
  • red_brick.ErrorCodeWouldBlock = 137
  • red_brick.ErrorCodeOverflow = 138
  • red_brick.ErrorCodeBadFileDescriptor = 139
  • red_brick.ErrorCodeOutOfRange = 140
  • red_brick.ErrorCodeNameTooLong = 141
  • red_brick.ErrorCodeInvalidSeek = 142
  • red_brick.ErrorCodeNotSupported = 143
  • red_brick.ErrorCodeTooManyOpenFiles = 144
func (*REDBrick) GetProcessIdentity(processId uint16) (errorCode uint8, pid uint32, uid uint32, gid uint32, err error)
Parameter:
  • processId – Typ: uint16, Wertebereich: [0 bis 216 - 1]
Rückgabe:
  • errorCode – Typ: uint8, Wertebereich: Siehe Konstanten
  • pid – Typ: uint32, Wertebereich: [0 bis 232 - 1]
  • uid – Typ: uint32, Wertebereich: [0 bis 232 - 1]
  • gid – Typ: uint32, Wertebereich: [0 bis 232 - 1]
  • err – Typ: error

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

Für errorCode:

  • red_brick.ErrorCodeSuccess = 0
  • red_brick.ErrorCodeUnknownError = 1
  • red_brick.ErrorCodeInvalidOperation = 2
  • red_brick.ErrorCodeOperationAborted = 3
  • red_brick.ErrorCodeInternalError = 4
  • red_brick.ErrorCodeUnknownSessionId = 5
  • red_brick.ErrorCodeNoFreeSessionId = 6
  • red_brick.ErrorCodeUnknownObjectId = 7
  • red_brick.ErrorCodeNoFreeObjectId = 8
  • red_brick.ErrorCodeObjectIsLocked = 9
  • red_brick.ErrorCodeNoMoreData = 10
  • red_brick.ErrorCodeWrongListItemType = 11
  • red_brick.ErrorCodeProgramIsPurged = 12
  • red_brick.ErrorCodeInvalidParameter = 128
  • red_brick.ErrorCodeNoFreeMemory = 129
  • red_brick.ErrorCodeNoFreeSpace = 130
  • red_brick.ErrorCodeAccessDenied = 121
  • red_brick.ErrorCodeAlreadyExists = 132
  • red_brick.ErrorCodeDoesNotExist = 133
  • red_brick.ErrorCodeInterrupted = 134
  • red_brick.ErrorCodeIsDirectory = 135
  • red_brick.ErrorCodeNotADirectory = 136
  • red_brick.ErrorCodeWouldBlock = 137
  • red_brick.ErrorCodeOverflow = 138
  • red_brick.ErrorCodeBadFileDescriptor = 139
  • red_brick.ErrorCodeOutOfRange = 140
  • red_brick.ErrorCodeNameTooLong = 141
  • red_brick.ErrorCodeInvalidSeek = 142
  • red_brick.ErrorCodeNotSupported = 143
  • red_brick.ErrorCodeTooManyOpenFiles = 144
func (*REDBrick) GetProcessStdio(processId uint16, sessionId uint16) (errorCode uint8, stdinFileId uint16, stdoutFileId uint16, stderrFileId uint16, err error)
Parameter:
  • processId – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • sessionId – Typ: uint16, Wertebereich: [0 bis 216 - 1]
Rückgabe:
  • errorCode – Typ: uint8, Wertebereich: Siehe Konstanten
  • stdinFileId – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • stdoutFileId – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • stderrFileId – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • err – Typ: error

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

Für errorCode:

  • red_brick.ErrorCodeSuccess = 0
  • red_brick.ErrorCodeUnknownError = 1
  • red_brick.ErrorCodeInvalidOperation = 2
  • red_brick.ErrorCodeOperationAborted = 3
  • red_brick.ErrorCodeInternalError = 4
  • red_brick.ErrorCodeUnknownSessionId = 5
  • red_brick.ErrorCodeNoFreeSessionId = 6
  • red_brick.ErrorCodeUnknownObjectId = 7
  • red_brick.ErrorCodeNoFreeObjectId = 8
  • red_brick.ErrorCodeObjectIsLocked = 9
  • red_brick.ErrorCodeNoMoreData = 10
  • red_brick.ErrorCodeWrongListItemType = 11
  • red_brick.ErrorCodeProgramIsPurged = 12
  • red_brick.ErrorCodeInvalidParameter = 128
  • red_brick.ErrorCodeNoFreeMemory = 129
  • red_brick.ErrorCodeNoFreeSpace = 130
  • red_brick.ErrorCodeAccessDenied = 121
  • red_brick.ErrorCodeAlreadyExists = 132
  • red_brick.ErrorCodeDoesNotExist = 133
  • red_brick.ErrorCodeInterrupted = 134
  • red_brick.ErrorCodeIsDirectory = 135
  • red_brick.ErrorCodeNotADirectory = 136
  • red_brick.ErrorCodeWouldBlock = 137
  • red_brick.ErrorCodeOverflow = 138
  • red_brick.ErrorCodeBadFileDescriptor = 139
  • red_brick.ErrorCodeOutOfRange = 140
  • red_brick.ErrorCodeNameTooLong = 141
  • red_brick.ErrorCodeInvalidSeek = 142
  • red_brick.ErrorCodeNotSupported = 143
  • red_brick.ErrorCodeTooManyOpenFiles = 144
func (*REDBrick) GetProcessState(processId uint16) (errorCode uint8, state uint8, timestamp uint64, exitCode uint8, err error)
Parameter:
  • processId – Typ: uint16, Wertebereich: [0 bis 216 - 1]
Rückgabe:
  • errorCode – Typ: uint8, Wertebereich: Siehe Konstanten
  • state – Typ: uint8, Wertebereich: Siehe Konstanten
  • timestamp – Typ: uint64, Wertebereich: [0 bis 264 - 1]
  • exitCode – Typ: uint8, Wertebereich: [0 bis 255]
  • err – Typ: error

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

Für errorCode:

  • red_brick.ErrorCodeSuccess = 0
  • red_brick.ErrorCodeUnknownError = 1
  • red_brick.ErrorCodeInvalidOperation = 2
  • red_brick.ErrorCodeOperationAborted = 3
  • red_brick.ErrorCodeInternalError = 4
  • red_brick.ErrorCodeUnknownSessionId = 5
  • red_brick.ErrorCodeNoFreeSessionId = 6
  • red_brick.ErrorCodeUnknownObjectId = 7
  • red_brick.ErrorCodeNoFreeObjectId = 8
  • red_brick.ErrorCodeObjectIsLocked = 9
  • red_brick.ErrorCodeNoMoreData = 10
  • red_brick.ErrorCodeWrongListItemType = 11
  • red_brick.ErrorCodeProgramIsPurged = 12
  • red_brick.ErrorCodeInvalidParameter = 128
  • red_brick.ErrorCodeNoFreeMemory = 129
  • red_brick.ErrorCodeNoFreeSpace = 130
  • red_brick.ErrorCodeAccessDenied = 121
  • red_brick.ErrorCodeAlreadyExists = 132
  • red_brick.ErrorCodeDoesNotExist = 133
  • red_brick.ErrorCodeInterrupted = 134
  • red_brick.ErrorCodeIsDirectory = 135
  • red_brick.ErrorCodeNotADirectory = 136
  • red_brick.ErrorCodeWouldBlock = 137
  • red_brick.ErrorCodeOverflow = 138
  • red_brick.ErrorCodeBadFileDescriptor = 139
  • red_brick.ErrorCodeOutOfRange = 140
  • red_brick.ErrorCodeNameTooLong = 141
  • red_brick.ErrorCodeInvalidSeek = 142
  • red_brick.ErrorCodeNotSupported = 143
  • red_brick.ErrorCodeTooManyOpenFiles = 144

Für state:

  • red_brick.ProcessStateUnknown = 0
  • red_brick.ProcessStateRunning = 1
  • red_brick.ProcessStateError = 2
  • red_brick.ProcessStateExited = 3
  • red_brick.ProcessStateKilled = 4
  • red_brick.ProcessStateStopped = 5
func (*REDBrick) GetPrograms(sessionId uint16) (errorCode uint8, programsListId uint16, err error)
Parameter:
  • sessionId – Typ: uint16, Wertebereich: [0 bis 216 - 1]
Rückgabe:
  • errorCode – Typ: uint8, Wertebereich: Siehe Konstanten
  • programsListId – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • err – Typ: error

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

Für errorCode:

  • red_brick.ErrorCodeSuccess = 0
  • red_brick.ErrorCodeUnknownError = 1
  • red_brick.ErrorCodeInvalidOperation = 2
  • red_brick.ErrorCodeOperationAborted = 3
  • red_brick.ErrorCodeInternalError = 4
  • red_brick.ErrorCodeUnknownSessionId = 5
  • red_brick.ErrorCodeNoFreeSessionId = 6
  • red_brick.ErrorCodeUnknownObjectId = 7
  • red_brick.ErrorCodeNoFreeObjectId = 8
  • red_brick.ErrorCodeObjectIsLocked = 9
  • red_brick.ErrorCodeNoMoreData = 10
  • red_brick.ErrorCodeWrongListItemType = 11
  • red_brick.ErrorCodeProgramIsPurged = 12
  • red_brick.ErrorCodeInvalidParameter = 128
  • red_brick.ErrorCodeNoFreeMemory = 129
  • red_brick.ErrorCodeNoFreeSpace = 130
  • red_brick.ErrorCodeAccessDenied = 121
  • red_brick.ErrorCodeAlreadyExists = 132
  • red_brick.ErrorCodeDoesNotExist = 133
  • red_brick.ErrorCodeInterrupted = 134
  • red_brick.ErrorCodeIsDirectory = 135
  • red_brick.ErrorCodeNotADirectory = 136
  • red_brick.ErrorCodeWouldBlock = 137
  • red_brick.ErrorCodeOverflow = 138
  • red_brick.ErrorCodeBadFileDescriptor = 139
  • red_brick.ErrorCodeOutOfRange = 140
  • red_brick.ErrorCodeNameTooLong = 141
  • red_brick.ErrorCodeInvalidSeek = 142
  • red_brick.ErrorCodeNotSupported = 143
  • red_brick.ErrorCodeTooManyOpenFiles = 144
func (*REDBrick) DefineProgram(identifierStringId uint16, sessionId uint16) (errorCode uint8, programId uint16, err error)
Parameter:
  • identifierStringId – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • sessionId – Typ: uint16, Wertebereich: [0 bis 216 - 1]
Rückgabe:
  • errorCode – Typ: uint8, Wertebereich: Siehe Konstanten
  • programId – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • err – Typ: error

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

Für errorCode:

  • red_brick.ErrorCodeSuccess = 0
  • red_brick.ErrorCodeUnknownError = 1
  • red_brick.ErrorCodeInvalidOperation = 2
  • red_brick.ErrorCodeOperationAborted = 3
  • red_brick.ErrorCodeInternalError = 4
  • red_brick.ErrorCodeUnknownSessionId = 5
  • red_brick.ErrorCodeNoFreeSessionId = 6
  • red_brick.ErrorCodeUnknownObjectId = 7
  • red_brick.ErrorCodeNoFreeObjectId = 8
  • red_brick.ErrorCodeObjectIsLocked = 9
  • red_brick.ErrorCodeNoMoreData = 10
  • red_brick.ErrorCodeWrongListItemType = 11
  • red_brick.ErrorCodeProgramIsPurged = 12
  • red_brick.ErrorCodeInvalidParameter = 128
  • red_brick.ErrorCodeNoFreeMemory = 129
  • red_brick.ErrorCodeNoFreeSpace = 130
  • red_brick.ErrorCodeAccessDenied = 121
  • red_brick.ErrorCodeAlreadyExists = 132
  • red_brick.ErrorCodeDoesNotExist = 133
  • red_brick.ErrorCodeInterrupted = 134
  • red_brick.ErrorCodeIsDirectory = 135
  • red_brick.ErrorCodeNotADirectory = 136
  • red_brick.ErrorCodeWouldBlock = 137
  • red_brick.ErrorCodeOverflow = 138
  • red_brick.ErrorCodeBadFileDescriptor = 139
  • red_brick.ErrorCodeOutOfRange = 140
  • red_brick.ErrorCodeNameTooLong = 141
  • red_brick.ErrorCodeInvalidSeek = 142
  • red_brick.ErrorCodeNotSupported = 143
  • red_brick.ErrorCodeTooManyOpenFiles = 144
func (*REDBrick) PurgeProgram(programId uint16, cookie uint32) (errorCode uint8, err error)
Parameter:
  • programId – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • cookie – Typ: uint32, Wertebereich: [0 bis 232 - 1]
Rückgabe:
  • errorCode – Typ: uint8, Wertebereich: Siehe Konstanten
  • err – Typ: error

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

Für errorCode:

  • red_brick.ErrorCodeSuccess = 0
  • red_brick.ErrorCodeUnknownError = 1
  • red_brick.ErrorCodeInvalidOperation = 2
  • red_brick.ErrorCodeOperationAborted = 3
  • red_brick.ErrorCodeInternalError = 4
  • red_brick.ErrorCodeUnknownSessionId = 5
  • red_brick.ErrorCodeNoFreeSessionId = 6
  • red_brick.ErrorCodeUnknownObjectId = 7
  • red_brick.ErrorCodeNoFreeObjectId = 8
  • red_brick.ErrorCodeObjectIsLocked = 9
  • red_brick.ErrorCodeNoMoreData = 10
  • red_brick.ErrorCodeWrongListItemType = 11
  • red_brick.ErrorCodeProgramIsPurged = 12
  • red_brick.ErrorCodeInvalidParameter = 128
  • red_brick.ErrorCodeNoFreeMemory = 129
  • red_brick.ErrorCodeNoFreeSpace = 130
  • red_brick.ErrorCodeAccessDenied = 121
  • red_brick.ErrorCodeAlreadyExists = 132
  • red_brick.ErrorCodeDoesNotExist = 133
  • red_brick.ErrorCodeInterrupted = 134
  • red_brick.ErrorCodeIsDirectory = 135
  • red_brick.ErrorCodeNotADirectory = 136
  • red_brick.ErrorCodeWouldBlock = 137
  • red_brick.ErrorCodeOverflow = 138
  • red_brick.ErrorCodeBadFileDescriptor = 139
  • red_brick.ErrorCodeOutOfRange = 140
  • red_brick.ErrorCodeNameTooLong = 141
  • red_brick.ErrorCodeInvalidSeek = 142
  • red_brick.ErrorCodeNotSupported = 143
  • red_brick.ErrorCodeTooManyOpenFiles = 144
func (*REDBrick) GetProgramIdentifier(programId uint16, sessionId uint16) (errorCode uint8, identifierStringId uint16, err error)
Parameter:
  • programId – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • sessionId – Typ: uint16, Wertebereich: [0 bis 216 - 1]
Rückgabe:
  • errorCode – Typ: uint8, Wertebereich: Siehe Konstanten
  • identifierStringId – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • err – Typ: error

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

Für errorCode:

  • red_brick.ErrorCodeSuccess = 0
  • red_brick.ErrorCodeUnknownError = 1
  • red_brick.ErrorCodeInvalidOperation = 2
  • red_brick.ErrorCodeOperationAborted = 3
  • red_brick.ErrorCodeInternalError = 4
  • red_brick.ErrorCodeUnknownSessionId = 5
  • red_brick.ErrorCodeNoFreeSessionId = 6
  • red_brick.ErrorCodeUnknownObjectId = 7
  • red_brick.ErrorCodeNoFreeObjectId = 8
  • red_brick.ErrorCodeObjectIsLocked = 9
  • red_brick.ErrorCodeNoMoreData = 10
  • red_brick.ErrorCodeWrongListItemType = 11
  • red_brick.ErrorCodeProgramIsPurged = 12
  • red_brick.ErrorCodeInvalidParameter = 128
  • red_brick.ErrorCodeNoFreeMemory = 129
  • red_brick.ErrorCodeNoFreeSpace = 130
  • red_brick.ErrorCodeAccessDenied = 121
  • red_brick.ErrorCodeAlreadyExists = 132
  • red_brick.ErrorCodeDoesNotExist = 133
  • red_brick.ErrorCodeInterrupted = 134
  • red_brick.ErrorCodeIsDirectory = 135
  • red_brick.ErrorCodeNotADirectory = 136
  • red_brick.ErrorCodeWouldBlock = 137
  • red_brick.ErrorCodeOverflow = 138
  • red_brick.ErrorCodeBadFileDescriptor = 139
  • red_brick.ErrorCodeOutOfRange = 140
  • red_brick.ErrorCodeNameTooLong = 141
  • red_brick.ErrorCodeInvalidSeek = 142
  • red_brick.ErrorCodeNotSupported = 143
  • red_brick.ErrorCodeTooManyOpenFiles = 144
func (*REDBrick) GetProgramRootDirectory(programId uint16, sessionId uint16) (errorCode uint8, rootDirectoryStringId uint16, err error)
Parameter:
  • programId – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • sessionId – Typ: uint16, Wertebereich: [0 bis 216 - 1]
Rückgabe:
  • errorCode – Typ: uint8, Wertebereich: Siehe Konstanten
  • rootDirectoryStringId – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • err – Typ: error

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

Für errorCode:

  • red_brick.ErrorCodeSuccess = 0
  • red_brick.ErrorCodeUnknownError = 1
  • red_brick.ErrorCodeInvalidOperation = 2
  • red_brick.ErrorCodeOperationAborted = 3
  • red_brick.ErrorCodeInternalError = 4
  • red_brick.ErrorCodeUnknownSessionId = 5
  • red_brick.ErrorCodeNoFreeSessionId = 6
  • red_brick.ErrorCodeUnknownObjectId = 7
  • red_brick.ErrorCodeNoFreeObjectId = 8
  • red_brick.ErrorCodeObjectIsLocked = 9
  • red_brick.ErrorCodeNoMoreData = 10
  • red_brick.ErrorCodeWrongListItemType = 11
  • red_brick.ErrorCodeProgramIsPurged = 12
  • red_brick.ErrorCodeInvalidParameter = 128
  • red_brick.ErrorCodeNoFreeMemory = 129
  • red_brick.ErrorCodeNoFreeSpace = 130
  • red_brick.ErrorCodeAccessDenied = 121
  • red_brick.ErrorCodeAlreadyExists = 132
  • red_brick.ErrorCodeDoesNotExist = 133
  • red_brick.ErrorCodeInterrupted = 134
  • red_brick.ErrorCodeIsDirectory = 135
  • red_brick.ErrorCodeNotADirectory = 136
  • red_brick.ErrorCodeWouldBlock = 137
  • red_brick.ErrorCodeOverflow = 138
  • red_brick.ErrorCodeBadFileDescriptor = 139
  • red_brick.ErrorCodeOutOfRange = 140
  • red_brick.ErrorCodeNameTooLong = 141
  • red_brick.ErrorCodeInvalidSeek = 142
  • red_brick.ErrorCodeNotSupported = 143
  • red_brick.ErrorCodeTooManyOpenFiles = 144
func (*REDBrick) SetProgramCommand(programId uint16, executableStringId uint16, argumentsListId uint16, environmentListId uint16, workingDirectoryStringId uint16) (errorCode uint8, err error)
Parameter:
  • programId – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • executableStringId – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • argumentsListId – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • environmentListId – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • workingDirectoryStringId – Typ: uint16, Wertebereich: [0 bis 216 - 1]
Rückgabe:
  • errorCode – Typ: uint8, Wertebereich: Siehe Konstanten
  • err – Typ: error

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

Für errorCode:

  • red_brick.ErrorCodeSuccess = 0
  • red_brick.ErrorCodeUnknownError = 1
  • red_brick.ErrorCodeInvalidOperation = 2
  • red_brick.ErrorCodeOperationAborted = 3
  • red_brick.ErrorCodeInternalError = 4
  • red_brick.ErrorCodeUnknownSessionId = 5
  • red_brick.ErrorCodeNoFreeSessionId = 6
  • red_brick.ErrorCodeUnknownObjectId = 7
  • red_brick.ErrorCodeNoFreeObjectId = 8
  • red_brick.ErrorCodeObjectIsLocked = 9
  • red_brick.ErrorCodeNoMoreData = 10
  • red_brick.ErrorCodeWrongListItemType = 11
  • red_brick.ErrorCodeProgramIsPurged = 12
  • red_brick.ErrorCodeInvalidParameter = 128
  • red_brick.ErrorCodeNoFreeMemory = 129
  • red_brick.ErrorCodeNoFreeSpace = 130
  • red_brick.ErrorCodeAccessDenied = 121
  • red_brick.ErrorCodeAlreadyExists = 132
  • red_brick.ErrorCodeDoesNotExist = 133
  • red_brick.ErrorCodeInterrupted = 134
  • red_brick.ErrorCodeIsDirectory = 135
  • red_brick.ErrorCodeNotADirectory = 136
  • red_brick.ErrorCodeWouldBlock = 137
  • red_brick.ErrorCodeOverflow = 138
  • red_brick.ErrorCodeBadFileDescriptor = 139
  • red_brick.ErrorCodeOutOfRange = 140
  • red_brick.ErrorCodeNameTooLong = 141
  • red_brick.ErrorCodeInvalidSeek = 142
  • red_brick.ErrorCodeNotSupported = 143
  • red_brick.ErrorCodeTooManyOpenFiles = 144
func (*REDBrick) GetProgramCommand(programId uint16, sessionId uint16) (errorCode uint8, executableStringId uint16, argumentsListId uint16, environmentListId uint16, workingDirectoryStringId uint16, err error)
Parameter:
  • programId – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • sessionId – Typ: uint16, Wertebereich: [0 bis 216 - 1]
Rückgabe:
  • errorCode – Typ: uint8, Wertebereich: Siehe Konstanten
  • executableStringId – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • argumentsListId – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • environmentListId – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • workingDirectoryStringId – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • err – Typ: error

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

Für errorCode:

  • red_brick.ErrorCodeSuccess = 0
  • red_brick.ErrorCodeUnknownError = 1
  • red_brick.ErrorCodeInvalidOperation = 2
  • red_brick.ErrorCodeOperationAborted = 3
  • red_brick.ErrorCodeInternalError = 4
  • red_brick.ErrorCodeUnknownSessionId = 5
  • red_brick.ErrorCodeNoFreeSessionId = 6
  • red_brick.ErrorCodeUnknownObjectId = 7
  • red_brick.ErrorCodeNoFreeObjectId = 8
  • red_brick.ErrorCodeObjectIsLocked = 9
  • red_brick.ErrorCodeNoMoreData = 10
  • red_brick.ErrorCodeWrongListItemType = 11
  • red_brick.ErrorCodeProgramIsPurged = 12
  • red_brick.ErrorCodeInvalidParameter = 128
  • red_brick.ErrorCodeNoFreeMemory = 129
  • red_brick.ErrorCodeNoFreeSpace = 130
  • red_brick.ErrorCodeAccessDenied = 121
  • red_brick.ErrorCodeAlreadyExists = 132
  • red_brick.ErrorCodeDoesNotExist = 133
  • red_brick.ErrorCodeInterrupted = 134
  • red_brick.ErrorCodeIsDirectory = 135
  • red_brick.ErrorCodeNotADirectory = 136
  • red_brick.ErrorCodeWouldBlock = 137
  • red_brick.ErrorCodeOverflow = 138
  • red_brick.ErrorCodeBadFileDescriptor = 139
  • red_brick.ErrorCodeOutOfRange = 140
  • red_brick.ErrorCodeNameTooLong = 141
  • red_brick.ErrorCodeInvalidSeek = 142
  • red_brick.ErrorCodeNotSupported = 143
  • red_brick.ErrorCodeTooManyOpenFiles = 144
func (*REDBrick) SetProgramStdioRedirection(programId uint16, stdinRedirection uint8, stdinFileNameStringId uint16, stdoutRedirection uint8, stdoutFileNameStringId uint16, stderrRedirection uint8, stderrFileNameStringId uint16) (errorCode uint8, err error)
Parameter:
  • programId – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • stdinRedirection – Typ: uint8, Wertebereich: Siehe Konstanten
  • stdinFileNameStringId – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • stdoutRedirection – Typ: uint8, Wertebereich: Siehe Konstanten
  • stdoutFileNameStringId – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • stderrRedirection – Typ: uint8, Wertebereich: Siehe Konstanten
  • stderrFileNameStringId – Typ: uint16, Wertebereich: [0 bis 216 - 1]
Rückgabe:
  • errorCode – Typ: uint8, Wertebereich: Siehe Konstanten
  • err – Typ: error

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

Für stdinRedirection:

  • red_brick.ProgramStdioRedirectionDevNull = 0
  • red_brick.ProgramStdioRedirectionPipe = 1
  • red_brick.ProgramStdioRedirectionFile = 2
  • red_brick.ProgramStdioRedirectionIndividualLog = 3
  • red_brick.ProgramStdioRedirectionContinuousLog = 4
  • red_brick.ProgramStdioRedirectionStdout = 5

Für stdoutRedirection:

  • red_brick.ProgramStdioRedirectionDevNull = 0
  • red_brick.ProgramStdioRedirectionPipe = 1
  • red_brick.ProgramStdioRedirectionFile = 2
  • red_brick.ProgramStdioRedirectionIndividualLog = 3
  • red_brick.ProgramStdioRedirectionContinuousLog = 4
  • red_brick.ProgramStdioRedirectionStdout = 5

Für stderrRedirection:

  • red_brick.ProgramStdioRedirectionDevNull = 0
  • red_brick.ProgramStdioRedirectionPipe = 1
  • red_brick.ProgramStdioRedirectionFile = 2
  • red_brick.ProgramStdioRedirectionIndividualLog = 3
  • red_brick.ProgramStdioRedirectionContinuousLog = 4
  • red_brick.ProgramStdioRedirectionStdout = 5

Für errorCode:

  • red_brick.ErrorCodeSuccess = 0
  • red_brick.ErrorCodeUnknownError = 1
  • red_brick.ErrorCodeInvalidOperation = 2
  • red_brick.ErrorCodeOperationAborted = 3
  • red_brick.ErrorCodeInternalError = 4
  • red_brick.ErrorCodeUnknownSessionId = 5
  • red_brick.ErrorCodeNoFreeSessionId = 6
  • red_brick.ErrorCodeUnknownObjectId = 7
  • red_brick.ErrorCodeNoFreeObjectId = 8
  • red_brick.ErrorCodeObjectIsLocked = 9
  • red_brick.ErrorCodeNoMoreData = 10
  • red_brick.ErrorCodeWrongListItemType = 11
  • red_brick.ErrorCodeProgramIsPurged = 12
  • red_brick.ErrorCodeInvalidParameter = 128
  • red_brick.ErrorCodeNoFreeMemory = 129
  • red_brick.ErrorCodeNoFreeSpace = 130
  • red_brick.ErrorCodeAccessDenied = 121
  • red_brick.ErrorCodeAlreadyExists = 132
  • red_brick.ErrorCodeDoesNotExist = 133
  • red_brick.ErrorCodeInterrupted = 134
  • red_brick.ErrorCodeIsDirectory = 135
  • red_brick.ErrorCodeNotADirectory = 136
  • red_brick.ErrorCodeWouldBlock = 137
  • red_brick.ErrorCodeOverflow = 138
  • red_brick.ErrorCodeBadFileDescriptor = 139
  • red_brick.ErrorCodeOutOfRange = 140
  • red_brick.ErrorCodeNameTooLong = 141
  • red_brick.ErrorCodeInvalidSeek = 142
  • red_brick.ErrorCodeNotSupported = 143
  • red_brick.ErrorCodeTooManyOpenFiles = 144
func (*REDBrick) GetProgramStdioRedirection(programId uint16, sessionId uint16) (errorCode uint8, stdinRedirection uint8, stdinFileNameStringId uint16, stdoutRedirection uint8, stdoutFileNameStringId uint16, stderrRedirection uint8, stderrFileNameStringId uint16, err error)
Parameter:
  • programId – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • sessionId – Typ: uint16, Wertebereich: [0 bis 216 - 1]
Rückgabe:
  • errorCode – Typ: uint8, Wertebereich: Siehe Konstanten
  • stdinRedirection – Typ: uint8, Wertebereich: Siehe Konstanten
  • stdinFileNameStringId – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • stdoutRedirection – Typ: uint8, Wertebereich: Siehe Konstanten
  • stdoutFileNameStringId – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • stderrRedirection – Typ: uint8, Wertebereich: Siehe Konstanten
  • stderrFileNameStringId – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • err – Typ: error

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

Für errorCode:

  • red_brick.ErrorCodeSuccess = 0
  • red_brick.ErrorCodeUnknownError = 1
  • red_brick.ErrorCodeInvalidOperation = 2
  • red_brick.ErrorCodeOperationAborted = 3
  • red_brick.ErrorCodeInternalError = 4
  • red_brick.ErrorCodeUnknownSessionId = 5
  • red_brick.ErrorCodeNoFreeSessionId = 6
  • red_brick.ErrorCodeUnknownObjectId = 7
  • red_brick.ErrorCodeNoFreeObjectId = 8
  • red_brick.ErrorCodeObjectIsLocked = 9
  • red_brick.ErrorCodeNoMoreData = 10
  • red_brick.ErrorCodeWrongListItemType = 11
  • red_brick.ErrorCodeProgramIsPurged = 12
  • red_brick.ErrorCodeInvalidParameter = 128
  • red_brick.ErrorCodeNoFreeMemory = 129
  • red_brick.ErrorCodeNoFreeSpace = 130
  • red_brick.ErrorCodeAccessDenied = 121
  • red_brick.ErrorCodeAlreadyExists = 132
  • red_brick.ErrorCodeDoesNotExist = 133
  • red_brick.ErrorCodeInterrupted = 134
  • red_brick.ErrorCodeIsDirectory = 135
  • red_brick.ErrorCodeNotADirectory = 136
  • red_brick.ErrorCodeWouldBlock = 137
  • red_brick.ErrorCodeOverflow = 138
  • red_brick.ErrorCodeBadFileDescriptor = 139
  • red_brick.ErrorCodeOutOfRange = 140
  • red_brick.ErrorCodeNameTooLong = 141
  • red_brick.ErrorCodeInvalidSeek = 142
  • red_brick.ErrorCodeNotSupported = 143
  • red_brick.ErrorCodeTooManyOpenFiles = 144

Für stdinRedirection:

  • red_brick.ProgramStdioRedirectionDevNull = 0
  • red_brick.ProgramStdioRedirectionPipe = 1
  • red_brick.ProgramStdioRedirectionFile = 2
  • red_brick.ProgramStdioRedirectionIndividualLog = 3
  • red_brick.ProgramStdioRedirectionContinuousLog = 4
  • red_brick.ProgramStdioRedirectionStdout = 5

Für stdoutRedirection:

  • red_brick.ProgramStdioRedirectionDevNull = 0
  • red_brick.ProgramStdioRedirectionPipe = 1
  • red_brick.ProgramStdioRedirectionFile = 2
  • red_brick.ProgramStdioRedirectionIndividualLog = 3
  • red_brick.ProgramStdioRedirectionContinuousLog = 4
  • red_brick.ProgramStdioRedirectionStdout = 5

Für stderrRedirection:

  • red_brick.ProgramStdioRedirectionDevNull = 0
  • red_brick.ProgramStdioRedirectionPipe = 1
  • red_brick.ProgramStdioRedirectionFile = 2
  • red_brick.ProgramStdioRedirectionIndividualLog = 3
  • red_brick.ProgramStdioRedirectionContinuousLog = 4
  • red_brick.ProgramStdioRedirectionStdout = 5
func (*REDBrick) SetProgramSchedule(programId uint16, startMode uint8, continueAfterError bool, startInterval uint32, startFieldsStringId uint16) (errorCode uint8, err error)
Parameter:
  • programId – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • startMode – Typ: uint8, Wertebereich: Siehe Konstanten
  • continueAfterError – Typ: bool
  • startInterval – Typ: uint32, Wertebereich: [0 bis 232 - 1]
  • startFieldsStringId – Typ: uint16, Wertebereich: [0 bis 216 - 1]
Rückgabe:
  • errorCode – Typ: uint8, Wertebereich: Siehe Konstanten
  • err – Typ: error

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

Für startMode:

  • red_brick.ProgramStartModeNever = 0
  • red_brick.ProgramStartModeAlways = 1
  • red_brick.ProgramStartModeInterval = 2
  • red_brick.ProgramStartModeCron = 3

Für errorCode:

  • red_brick.ErrorCodeSuccess = 0
  • red_brick.ErrorCodeUnknownError = 1
  • red_brick.ErrorCodeInvalidOperation = 2
  • red_brick.ErrorCodeOperationAborted = 3
  • red_brick.ErrorCodeInternalError = 4
  • red_brick.ErrorCodeUnknownSessionId = 5
  • red_brick.ErrorCodeNoFreeSessionId = 6
  • red_brick.ErrorCodeUnknownObjectId = 7
  • red_brick.ErrorCodeNoFreeObjectId = 8
  • red_brick.ErrorCodeObjectIsLocked = 9
  • red_brick.ErrorCodeNoMoreData = 10
  • red_brick.ErrorCodeWrongListItemType = 11
  • red_brick.ErrorCodeProgramIsPurged = 12
  • red_brick.ErrorCodeInvalidParameter = 128
  • red_brick.ErrorCodeNoFreeMemory = 129
  • red_brick.ErrorCodeNoFreeSpace = 130
  • red_brick.ErrorCodeAccessDenied = 121
  • red_brick.ErrorCodeAlreadyExists = 132
  • red_brick.ErrorCodeDoesNotExist = 133
  • red_brick.ErrorCodeInterrupted = 134
  • red_brick.ErrorCodeIsDirectory = 135
  • red_brick.ErrorCodeNotADirectory = 136
  • red_brick.ErrorCodeWouldBlock = 137
  • red_brick.ErrorCodeOverflow = 138
  • red_brick.ErrorCodeBadFileDescriptor = 139
  • red_brick.ErrorCodeOutOfRange = 140
  • red_brick.ErrorCodeNameTooLong = 141
  • red_brick.ErrorCodeInvalidSeek = 142
  • red_brick.ErrorCodeNotSupported = 143
  • red_brick.ErrorCodeTooManyOpenFiles = 144
func (*REDBrick) GetProgramSchedule(programId uint16, sessionId uint16) (errorCode uint8, startMode uint8, continueAfterError bool, startInterval uint32, startFieldsStringId uint16, err error)
Parameter:
  • programId – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • sessionId – Typ: uint16, Wertebereich: [0 bis 216 - 1]
Rückgabe:
  • errorCode – Typ: uint8, Wertebereich: Siehe Konstanten
  • startMode – Typ: uint8, Wertebereich: Siehe Konstanten
  • continueAfterError – Typ: bool
  • startInterval – Typ: uint32, Wertebereich: [0 bis 232 - 1]
  • startFieldsStringId – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • err – Typ: error

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

Für errorCode:

  • red_brick.ErrorCodeSuccess = 0
  • red_brick.ErrorCodeUnknownError = 1
  • red_brick.ErrorCodeInvalidOperation = 2
  • red_brick.ErrorCodeOperationAborted = 3
  • red_brick.ErrorCodeInternalError = 4
  • red_brick.ErrorCodeUnknownSessionId = 5
  • red_brick.ErrorCodeNoFreeSessionId = 6
  • red_brick.ErrorCodeUnknownObjectId = 7
  • red_brick.ErrorCodeNoFreeObjectId = 8
  • red_brick.ErrorCodeObjectIsLocked = 9
  • red_brick.ErrorCodeNoMoreData = 10
  • red_brick.ErrorCodeWrongListItemType = 11
  • red_brick.ErrorCodeProgramIsPurged = 12
  • red_brick.ErrorCodeInvalidParameter = 128
  • red_brick.ErrorCodeNoFreeMemory = 129
  • red_brick.ErrorCodeNoFreeSpace = 130
  • red_brick.ErrorCodeAccessDenied = 121
  • red_brick.ErrorCodeAlreadyExists = 132
  • red_brick.ErrorCodeDoesNotExist = 133
  • red_brick.ErrorCodeInterrupted = 134
  • red_brick.ErrorCodeIsDirectory = 135
  • red_brick.ErrorCodeNotADirectory = 136
  • red_brick.ErrorCodeWouldBlock = 137
  • red_brick.ErrorCodeOverflow = 138
  • red_brick.ErrorCodeBadFileDescriptor = 139
  • red_brick.ErrorCodeOutOfRange = 140
  • red_brick.ErrorCodeNameTooLong = 141
  • red_brick.ErrorCodeInvalidSeek = 142
  • red_brick.ErrorCodeNotSupported = 143
  • red_brick.ErrorCodeTooManyOpenFiles = 144

Für startMode:

  • red_brick.ProgramStartModeNever = 0
  • red_brick.ProgramStartModeAlways = 1
  • red_brick.ProgramStartModeInterval = 2
  • red_brick.ProgramStartModeCron = 3
func (*REDBrick) GetProgramSchedulerState(programId uint16, sessionId uint16) (errorCode uint8, state uint8, timestamp uint64, messageStringId uint16, err error)
Parameter:
  • programId – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • sessionId – Typ: uint16, Wertebereich: [0 bis 216 - 1]
Rückgabe:
  • errorCode – Typ: uint8, Wertebereich: Siehe Konstanten
  • state – Typ: uint8, Wertebereich: Siehe Konstanten
  • timestamp – Typ: uint64, Wertebereich: [0 bis 264 - 1]
  • messageStringId – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • err – Typ: error

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

Für errorCode:

  • red_brick.ErrorCodeSuccess = 0
  • red_brick.ErrorCodeUnknownError = 1
  • red_brick.ErrorCodeInvalidOperation = 2
  • red_brick.ErrorCodeOperationAborted = 3
  • red_brick.ErrorCodeInternalError = 4
  • red_brick.ErrorCodeUnknownSessionId = 5
  • red_brick.ErrorCodeNoFreeSessionId = 6
  • red_brick.ErrorCodeUnknownObjectId = 7
  • red_brick.ErrorCodeNoFreeObjectId = 8
  • red_brick.ErrorCodeObjectIsLocked = 9
  • red_brick.ErrorCodeNoMoreData = 10
  • red_brick.ErrorCodeWrongListItemType = 11
  • red_brick.ErrorCodeProgramIsPurged = 12
  • red_brick.ErrorCodeInvalidParameter = 128
  • red_brick.ErrorCodeNoFreeMemory = 129
  • red_brick.ErrorCodeNoFreeSpace = 130
  • red_brick.ErrorCodeAccessDenied = 121
  • red_brick.ErrorCodeAlreadyExists = 132
  • red_brick.ErrorCodeDoesNotExist = 133
  • red_brick.ErrorCodeInterrupted = 134
  • red_brick.ErrorCodeIsDirectory = 135
  • red_brick.ErrorCodeNotADirectory = 136
  • red_brick.ErrorCodeWouldBlock = 137
  • red_brick.ErrorCodeOverflow = 138
  • red_brick.ErrorCodeBadFileDescriptor = 139
  • red_brick.ErrorCodeOutOfRange = 140
  • red_brick.ErrorCodeNameTooLong = 141
  • red_brick.ErrorCodeInvalidSeek = 142
  • red_brick.ErrorCodeNotSupported = 143
  • red_brick.ErrorCodeTooManyOpenFiles = 144

Für state:

  • red_brick.ProgramSchedulerStateStopped = 0
  • red_brick.ProgramSchedulerStateRunning = 1
func (*REDBrick) ContinueProgramSchedule(programId uint16) (errorCode uint8, err error)
Parameter:
  • programId – Typ: uint16, Wertebereich: [0 bis 216 - 1]
Rückgabe:
  • errorCode – Typ: uint8, Wertebereich: Siehe Konstanten
  • err – Typ: error

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

Für errorCode:

  • red_brick.ErrorCodeSuccess = 0
  • red_brick.ErrorCodeUnknownError = 1
  • red_brick.ErrorCodeInvalidOperation = 2
  • red_brick.ErrorCodeOperationAborted = 3
  • red_brick.ErrorCodeInternalError = 4
  • red_brick.ErrorCodeUnknownSessionId = 5
  • red_brick.ErrorCodeNoFreeSessionId = 6
  • red_brick.ErrorCodeUnknownObjectId = 7
  • red_brick.ErrorCodeNoFreeObjectId = 8
  • red_brick.ErrorCodeObjectIsLocked = 9
  • red_brick.ErrorCodeNoMoreData = 10
  • red_brick.ErrorCodeWrongListItemType = 11
  • red_brick.ErrorCodeProgramIsPurged = 12
  • red_brick.ErrorCodeInvalidParameter = 128
  • red_brick.ErrorCodeNoFreeMemory = 129
  • red_brick.ErrorCodeNoFreeSpace = 130
  • red_brick.ErrorCodeAccessDenied = 121
  • red_brick.ErrorCodeAlreadyExists = 132
  • red_brick.ErrorCodeDoesNotExist = 133
  • red_brick.ErrorCodeInterrupted = 134
  • red_brick.ErrorCodeIsDirectory = 135
  • red_brick.ErrorCodeNotADirectory = 136
  • red_brick.ErrorCodeWouldBlock = 137
  • red_brick.ErrorCodeOverflow = 138
  • red_brick.ErrorCodeBadFileDescriptor = 139
  • red_brick.ErrorCodeOutOfRange = 140
  • red_brick.ErrorCodeNameTooLong = 141
  • red_brick.ErrorCodeInvalidSeek = 142
  • red_brick.ErrorCodeNotSupported = 143
  • red_brick.ErrorCodeTooManyOpenFiles = 144
func (*REDBrick) StartProgram(programId uint16) (errorCode uint8, err error)
Parameter:
  • programId – Typ: uint16, Wertebereich: [0 bis 216 - 1]
Rückgabe:
  • errorCode – Typ: uint8, Wertebereich: Siehe Konstanten
  • err – Typ: error

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

Für errorCode:

  • red_brick.ErrorCodeSuccess = 0
  • red_brick.ErrorCodeUnknownError = 1
  • red_brick.ErrorCodeInvalidOperation = 2
  • red_brick.ErrorCodeOperationAborted = 3
  • red_brick.ErrorCodeInternalError = 4
  • red_brick.ErrorCodeUnknownSessionId = 5
  • red_brick.ErrorCodeNoFreeSessionId = 6
  • red_brick.ErrorCodeUnknownObjectId = 7
  • red_brick.ErrorCodeNoFreeObjectId = 8
  • red_brick.ErrorCodeObjectIsLocked = 9
  • red_brick.ErrorCodeNoMoreData = 10
  • red_brick.ErrorCodeWrongListItemType = 11
  • red_brick.ErrorCodeProgramIsPurged = 12
  • red_brick.ErrorCodeInvalidParameter = 128
  • red_brick.ErrorCodeNoFreeMemory = 129
  • red_brick.ErrorCodeNoFreeSpace = 130
  • red_brick.ErrorCodeAccessDenied = 121
  • red_brick.ErrorCodeAlreadyExists = 132
  • red_brick.ErrorCodeDoesNotExist = 133
  • red_brick.ErrorCodeInterrupted = 134
  • red_brick.ErrorCodeIsDirectory = 135
  • red_brick.ErrorCodeNotADirectory = 136
  • red_brick.ErrorCodeWouldBlock = 137
  • red_brick.ErrorCodeOverflow = 138
  • red_brick.ErrorCodeBadFileDescriptor = 139
  • red_brick.ErrorCodeOutOfRange = 140
  • red_brick.ErrorCodeNameTooLong = 141
  • red_brick.ErrorCodeInvalidSeek = 142
  • red_brick.ErrorCodeNotSupported = 143
  • red_brick.ErrorCodeTooManyOpenFiles = 144
func (*REDBrick) GetLastSpawnedProgramProcess(programId uint16, sessionId uint16) (errorCode uint8, processId uint16, timestamp uint64, err error)
Parameter:
  • programId – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • sessionId – Typ: uint16, Wertebereich: [0 bis 216 - 1]
Rückgabe:
  • errorCode – Typ: uint8, Wertebereich: Siehe Konstanten
  • processId – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • timestamp – Typ: uint64, Wertebereich: [0 bis 264 - 1]
  • err – Typ: error

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

Für errorCode:

  • red_brick.ErrorCodeSuccess = 0
  • red_brick.ErrorCodeUnknownError = 1
  • red_brick.ErrorCodeInvalidOperation = 2
  • red_brick.ErrorCodeOperationAborted = 3
  • red_brick.ErrorCodeInternalError = 4
  • red_brick.ErrorCodeUnknownSessionId = 5
  • red_brick.ErrorCodeNoFreeSessionId = 6
  • red_brick.ErrorCodeUnknownObjectId = 7
  • red_brick.ErrorCodeNoFreeObjectId = 8
  • red_brick.ErrorCodeObjectIsLocked = 9
  • red_brick.ErrorCodeNoMoreData = 10
  • red_brick.ErrorCodeWrongListItemType = 11
  • red_brick.ErrorCodeProgramIsPurged = 12
  • red_brick.ErrorCodeInvalidParameter = 128
  • red_brick.ErrorCodeNoFreeMemory = 129
  • red_brick.ErrorCodeNoFreeSpace = 130
  • red_brick.ErrorCodeAccessDenied = 121
  • red_brick.ErrorCodeAlreadyExists = 132
  • red_brick.ErrorCodeDoesNotExist = 133
  • red_brick.ErrorCodeInterrupted = 134
  • red_brick.ErrorCodeIsDirectory = 135
  • red_brick.ErrorCodeNotADirectory = 136
  • red_brick.ErrorCodeWouldBlock = 137
  • red_brick.ErrorCodeOverflow = 138
  • red_brick.ErrorCodeBadFileDescriptor = 139
  • red_brick.ErrorCodeOutOfRange = 140
  • red_brick.ErrorCodeNameTooLong = 141
  • red_brick.ErrorCodeInvalidSeek = 142
  • red_brick.ErrorCodeNotSupported = 143
  • red_brick.ErrorCodeTooManyOpenFiles = 144
func (*REDBrick) GetCustomProgramOptionNames(programId uint16, sessionId uint16) (errorCode uint8, namesListId uint16, err error)
Parameter:
  • programId – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • sessionId – Typ: uint16, Wertebereich: [0 bis 216 - 1]
Rückgabe:
  • errorCode – Typ: uint8, Wertebereich: Siehe Konstanten
  • namesListId – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • err – Typ: error

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

Für errorCode:

  • red_brick.ErrorCodeSuccess = 0
  • red_brick.ErrorCodeUnknownError = 1
  • red_brick.ErrorCodeInvalidOperation = 2
  • red_brick.ErrorCodeOperationAborted = 3
  • red_brick.ErrorCodeInternalError = 4
  • red_brick.ErrorCodeUnknownSessionId = 5
  • red_brick.ErrorCodeNoFreeSessionId = 6
  • red_brick.ErrorCodeUnknownObjectId = 7
  • red_brick.ErrorCodeNoFreeObjectId = 8
  • red_brick.ErrorCodeObjectIsLocked = 9
  • red_brick.ErrorCodeNoMoreData = 10
  • red_brick.ErrorCodeWrongListItemType = 11
  • red_brick.ErrorCodeProgramIsPurged = 12
  • red_brick.ErrorCodeInvalidParameter = 128
  • red_brick.ErrorCodeNoFreeMemory = 129
  • red_brick.ErrorCodeNoFreeSpace = 130
  • red_brick.ErrorCodeAccessDenied = 121
  • red_brick.ErrorCodeAlreadyExists = 132
  • red_brick.ErrorCodeDoesNotExist = 133
  • red_brick.ErrorCodeInterrupted = 134
  • red_brick.ErrorCodeIsDirectory = 135
  • red_brick.ErrorCodeNotADirectory = 136
  • red_brick.ErrorCodeWouldBlock = 137
  • red_brick.ErrorCodeOverflow = 138
  • red_brick.ErrorCodeBadFileDescriptor = 139
  • red_brick.ErrorCodeOutOfRange = 140
  • red_brick.ErrorCodeNameTooLong = 141
  • red_brick.ErrorCodeInvalidSeek = 142
  • red_brick.ErrorCodeNotSupported = 143
  • red_brick.ErrorCodeTooManyOpenFiles = 144
func (*REDBrick) SetCustomProgramOptionValue(programId uint16, nameStringId uint16, valueStringId uint16) (errorCode uint8, err error)
Parameter:
  • programId – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • nameStringId – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • valueStringId – Typ: uint16, Wertebereich: [0 bis 216 - 1]
Rückgabe:
  • errorCode – Typ: uint8, Wertebereich: Siehe Konstanten
  • err – Typ: error

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

Für errorCode:

  • red_brick.ErrorCodeSuccess = 0
  • red_brick.ErrorCodeUnknownError = 1
  • red_brick.ErrorCodeInvalidOperation = 2
  • red_brick.ErrorCodeOperationAborted = 3
  • red_brick.ErrorCodeInternalError = 4
  • red_brick.ErrorCodeUnknownSessionId = 5
  • red_brick.ErrorCodeNoFreeSessionId = 6
  • red_brick.ErrorCodeUnknownObjectId = 7
  • red_brick.ErrorCodeNoFreeObjectId = 8
  • red_brick.ErrorCodeObjectIsLocked = 9
  • red_brick.ErrorCodeNoMoreData = 10
  • red_brick.ErrorCodeWrongListItemType = 11
  • red_brick.ErrorCodeProgramIsPurged = 12
  • red_brick.ErrorCodeInvalidParameter = 128
  • red_brick.ErrorCodeNoFreeMemory = 129
  • red_brick.ErrorCodeNoFreeSpace = 130
  • red_brick.ErrorCodeAccessDenied = 121
  • red_brick.ErrorCodeAlreadyExists = 132
  • red_brick.ErrorCodeDoesNotExist = 133
  • red_brick.ErrorCodeInterrupted = 134
  • red_brick.ErrorCodeIsDirectory = 135
  • red_brick.ErrorCodeNotADirectory = 136
  • red_brick.ErrorCodeWouldBlock = 137
  • red_brick.ErrorCodeOverflow = 138
  • red_brick.ErrorCodeBadFileDescriptor = 139
  • red_brick.ErrorCodeOutOfRange = 140
  • red_brick.ErrorCodeNameTooLong = 141
  • red_brick.ErrorCodeInvalidSeek = 142
  • red_brick.ErrorCodeNotSupported = 143
  • red_brick.ErrorCodeTooManyOpenFiles = 144
func (*REDBrick) GetCustomProgramOptionValue(programId uint16, nameStringId uint16, sessionId uint16) (errorCode uint8, valueStringId uint16, err error)
Parameter:
  • programId – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • nameStringId – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • sessionId – Typ: uint16, Wertebereich: [0 bis 216 - 1]
Rückgabe:
  • errorCode – Typ: uint8, Wertebereich: Siehe Konstanten
  • valueStringId – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • err – Typ: error

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

Für errorCode:

  • red_brick.ErrorCodeSuccess = 0
  • red_brick.ErrorCodeUnknownError = 1
  • red_brick.ErrorCodeInvalidOperation = 2
  • red_brick.ErrorCodeOperationAborted = 3
  • red_brick.ErrorCodeInternalError = 4
  • red_brick.ErrorCodeUnknownSessionId = 5
  • red_brick.ErrorCodeNoFreeSessionId = 6
  • red_brick.ErrorCodeUnknownObjectId = 7
  • red_brick.ErrorCodeNoFreeObjectId = 8
  • red_brick.ErrorCodeObjectIsLocked = 9
  • red_brick.ErrorCodeNoMoreData = 10
  • red_brick.ErrorCodeWrongListItemType = 11
  • red_brick.ErrorCodeProgramIsPurged = 12
  • red_brick.ErrorCodeInvalidParameter = 128
  • red_brick.ErrorCodeNoFreeMemory = 129
  • red_brick.ErrorCodeNoFreeSpace = 130
  • red_brick.ErrorCodeAccessDenied = 121
  • red_brick.ErrorCodeAlreadyExists = 132
  • red_brick.ErrorCodeDoesNotExist = 133
  • red_brick.ErrorCodeInterrupted = 134
  • red_brick.ErrorCodeIsDirectory = 135
  • red_brick.ErrorCodeNotADirectory = 136
  • red_brick.ErrorCodeWouldBlock = 137
  • red_brick.ErrorCodeOverflow = 138
  • red_brick.ErrorCodeBadFileDescriptor = 139
  • red_brick.ErrorCodeOutOfRange = 140
  • red_brick.ErrorCodeNameTooLong = 141
  • red_brick.ErrorCodeInvalidSeek = 142
  • red_brick.ErrorCodeNotSupported = 143
  • red_brick.ErrorCodeTooManyOpenFiles = 144
func (*REDBrick) RemoveCustomProgramOption(programId uint16, nameStringId uint16) (errorCode uint8, err error)
Parameter:
  • programId – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • nameStringId – Typ: uint16, Wertebereich: [0 bis 216 - 1]
Rückgabe:
  • errorCode – Typ: uint8, Wertebereich: Siehe Konstanten
  • err – Typ: error

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

Für errorCode:

  • red_brick.ErrorCodeSuccess = 0
  • red_brick.ErrorCodeUnknownError = 1
  • red_brick.ErrorCodeInvalidOperation = 2
  • red_brick.ErrorCodeOperationAborted = 3
  • red_brick.ErrorCodeInternalError = 4
  • red_brick.ErrorCodeUnknownSessionId = 5
  • red_brick.ErrorCodeNoFreeSessionId = 6
  • red_brick.ErrorCodeUnknownObjectId = 7
  • red_brick.ErrorCodeNoFreeObjectId = 8
  • red_brick.ErrorCodeObjectIsLocked = 9
  • red_brick.ErrorCodeNoMoreData = 10
  • red_brick.ErrorCodeWrongListItemType = 11
  • red_brick.ErrorCodeProgramIsPurged = 12
  • red_brick.ErrorCodeInvalidParameter = 128
  • red_brick.ErrorCodeNoFreeMemory = 129
  • red_brick.ErrorCodeNoFreeSpace = 130
  • red_brick.ErrorCodeAccessDenied = 121
  • red_brick.ErrorCodeAlreadyExists = 132
  • red_brick.ErrorCodeDoesNotExist = 133
  • red_brick.ErrorCodeInterrupted = 134
  • red_brick.ErrorCodeIsDirectory = 135
  • red_brick.ErrorCodeNotADirectory = 136
  • red_brick.ErrorCodeWouldBlock = 137
  • red_brick.ErrorCodeOverflow = 138
  • red_brick.ErrorCodeBadFileDescriptor = 139
  • red_brick.ErrorCodeOutOfRange = 140
  • red_brick.ErrorCodeNameTooLong = 141
  • red_brick.ErrorCodeInvalidSeek = 142
  • red_brick.ErrorCodeNotSupported = 143
  • red_brick.ErrorCodeTooManyOpenFiles = 144
func (*REDBrick) GetIdentity() (uid string, connectedUid string, position rune, hardwareVersion [3]uint8, firmwareVersion [3]uint8, deviceIdentifier uint16, err error)
Rückgabe:
  • uid – Typ: string, Länge: bis zu 8
  • connectedUid – Typ: string, Länge: bis zu 8
  • position – Typ: rune, Wertebereich: ['0' bis '8']
  • hardwareVersion – Typ: [3]uint8
    • 0: major – Typ: uint8, Wertebereich: [0 bis 255]
    • 1: minor – Typ: uint8, Wertebereich: [0 bis 255]
    • 2: revision – Typ: uint8, Wertebereich: [0 bis 255]
  • firmwareVersion – Typ: [3]uint8
    • 0: major – Typ: uint8, Wertebereich: [0 bis 255]
    • 1: minor – Typ: uint8, Wertebereich: [0 bis 255]
    • 2: revision – Typ: uint8, Wertebereich: [0 bis 255]
  • deviceIdentifier – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • err – Typ: error

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.

Callbacks

Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung kann mit der entsprechenden Register*Callback-Function durchgeführt werden, welche eine eindeutige Callback-ID zurück gibt. Mit dieser ID kann das Callback später deregistriert werden.

Bemerkung

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

func (*REDBrick) RegisterAsyncFileReadCallback(func(fileId uint16, errorCode uint8, buffer [60]uint8, lengthRead uint8)) (registrationId uint64)
Callback-Parameter:
  • fileId – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • errorCode – Typ: uint8, Wertebereich: Siehe Konstanten
  • buffer – Typ: [60]uint8, Wertebereich: [0 bis 255]
  • lengthRead – Typ: uint8, Einheit: 1 B, Wertebereich: [0 bis 255]
Rückgabe:
  • registrationId – Typ: uint64

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

Für errorCode:

  • red_brick.ErrorCodeSuccess = 0
  • red_brick.ErrorCodeUnknownError = 1
  • red_brick.ErrorCodeInvalidOperation = 2
  • red_brick.ErrorCodeOperationAborted = 3
  • red_brick.ErrorCodeInternalError = 4
  • red_brick.ErrorCodeUnknownSessionId = 5
  • red_brick.ErrorCodeNoFreeSessionId = 6
  • red_brick.ErrorCodeUnknownObjectId = 7
  • red_brick.ErrorCodeNoFreeObjectId = 8
  • red_brick.ErrorCodeObjectIsLocked = 9
  • red_brick.ErrorCodeNoMoreData = 10
  • red_brick.ErrorCodeWrongListItemType = 11
  • red_brick.ErrorCodeProgramIsPurged = 12
  • red_brick.ErrorCodeInvalidParameter = 128
  • red_brick.ErrorCodeNoFreeMemory = 129
  • red_brick.ErrorCodeNoFreeSpace = 130
  • red_brick.ErrorCodeAccessDenied = 121
  • red_brick.ErrorCodeAlreadyExists = 132
  • red_brick.ErrorCodeDoesNotExist = 133
  • red_brick.ErrorCodeInterrupted = 134
  • red_brick.ErrorCodeIsDirectory = 135
  • red_brick.ErrorCodeNotADirectory = 136
  • red_brick.ErrorCodeWouldBlock = 137
  • red_brick.ErrorCodeOverflow = 138
  • red_brick.ErrorCodeBadFileDescriptor = 139
  • red_brick.ErrorCodeOutOfRange = 140
  • red_brick.ErrorCodeNameTooLong = 141
  • red_brick.ErrorCodeInvalidSeek = 142
  • red_brick.ErrorCodeNotSupported = 143
  • red_brick.ErrorCodeTooManyOpenFiles = 144
func (*REDBrick) RegisterAsyncFileWriteCallback(func(fileId uint16, errorCode uint8, lengthWritten uint8)) (registrationId uint64)
Callback-Parameter:
  • fileId – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • errorCode – Typ: uint8, Wertebereich: Siehe Konstanten
  • lengthWritten – Typ: uint8, Einheit: 1 B, Wertebereich: [0 bis 255]
Rückgabe:
  • registrationId – Typ: uint64

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

Für errorCode:

  • red_brick.ErrorCodeSuccess = 0
  • red_brick.ErrorCodeUnknownError = 1
  • red_brick.ErrorCodeInvalidOperation = 2
  • red_brick.ErrorCodeOperationAborted = 3
  • red_brick.ErrorCodeInternalError = 4
  • red_brick.ErrorCodeUnknownSessionId = 5
  • red_brick.ErrorCodeNoFreeSessionId = 6
  • red_brick.ErrorCodeUnknownObjectId = 7
  • red_brick.ErrorCodeNoFreeObjectId = 8
  • red_brick.ErrorCodeObjectIsLocked = 9
  • red_brick.ErrorCodeNoMoreData = 10
  • red_brick.ErrorCodeWrongListItemType = 11
  • red_brick.ErrorCodeProgramIsPurged = 12
  • red_brick.ErrorCodeInvalidParameter = 128
  • red_brick.ErrorCodeNoFreeMemory = 129
  • red_brick.ErrorCodeNoFreeSpace = 130
  • red_brick.ErrorCodeAccessDenied = 121
  • red_brick.ErrorCodeAlreadyExists = 132
  • red_brick.ErrorCodeDoesNotExist = 133
  • red_brick.ErrorCodeInterrupted = 134
  • red_brick.ErrorCodeIsDirectory = 135
  • red_brick.ErrorCodeNotADirectory = 136
  • red_brick.ErrorCodeWouldBlock = 137
  • red_brick.ErrorCodeOverflow = 138
  • red_brick.ErrorCodeBadFileDescriptor = 139
  • red_brick.ErrorCodeOutOfRange = 140
  • red_brick.ErrorCodeNameTooLong = 141
  • red_brick.ErrorCodeInvalidSeek = 142
  • red_brick.ErrorCodeNotSupported = 143
  • red_brick.ErrorCodeTooManyOpenFiles = 144
func (*REDBrick) RegisterFileEventsOccurredCallback(func(fileId uint16, events uint16)) (registrationId uint64)
Callback-Parameter:
  • fileId – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • events – Typ: uint16, Wertebereich: Siehe Konstanten
Rückgabe:
  • registrationId – Typ: uint64

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

Für events:

  • red_brick.FileEventReadable = 1
  • red_brick.FileEventWritable = 2
func (*REDBrick) RegisterProcessStateChangedCallback(func(processId uint16, state uint8, timestamp uint64, exitCode uint8)) (registrationId uint64)
Callback-Parameter:
  • processId – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • state – Typ: uint8, Wertebereich: Siehe Konstanten
  • timestamp – Typ: uint64, Wertebereich: [0 bis 264 - 1]
  • exitCode – Typ: uint8, Wertebereich: [0 bis 255]
Rückgabe:
  • registrationId – Typ: uint64

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

Für state:

  • red_brick.ProcessStateUnknown = 0
  • red_brick.ProcessStateRunning = 1
  • red_brick.ProcessStateError = 2
  • red_brick.ProcessStateExited = 3
  • red_brick.ProcessStateKilled = 4
  • red_brick.ProcessStateStopped = 5
func (*REDBrick) RegisterProgramSchedulerStateChangedCallback(func(programId uint16)) (registrationId uint64)
Callback-Parameter:
  • programId – Typ: uint16, Wertebereich: [0 bis 216 - 1]
Rückgabe:
  • registrationId – Typ: uint64
func (*REDBrick) RegisterProgramProcessSpawnedCallback(func(programId uint16)) (registrationId uint64)
Callback-Parameter:
  • programId – Typ: uint16, Wertebereich: [0 bis 216 - 1]
Rückgabe:
  • registrationId – Typ: uint64

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.

func (*REDBrick) GetAPIVersion() (apiVersion [3]uint8, err error)
Rückgabe:
  • apiVersion – Typ: [3]uint8
    • 0: major – Typ: uint8, Wertebereich: [0 bis 255]
    • 1: minor – Typ: uint8, Wertebereich: [0 bis 255]
    • 2: revision – Typ: uint8, Wertebereich: [0 bis 255]
  • err – Typ: error

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.

func (*REDBrick) GetResponseExpected(functionId uint8) (responseExpected bool, err error)
Parameter:
  • functionId – Typ: uint8, Wertebereich: Siehe Konstanten
Rückgabe:
  • responseExpected – Typ: bool
  • err – Typ: error

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 functionId:

  • red_brick.FunctionExpireSessionUnchecked = 3
  • red_brick.FunctionReleaseObjectUnchecked = 6
  • red_brick.FunctionReadFileAsync = 21
  • red_brick.FunctionWriteFileUnchecked = 24
  • red_brick.FunctionWriteFileAsync = 25
func (*REDBrick) SetResponseExpected(functionId uint8, responseExpected bool) (err error)
Parameter:
  • functionId – Typ: uint8, Wertebereich: Siehe Konstanten
  • responseExpected – Typ: bool
Rückgabe:
  • err – Typ: error

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

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

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

Für functionId:

  • red_brick.FunctionExpireSessionUnchecked = 3
  • red_brick.FunctionReleaseObjectUnchecked = 6
  • red_brick.FunctionReadFileAsync = 21
  • red_brick.FunctionWriteFileUnchecked = 24
  • red_brick.FunctionWriteFileAsync = 25
func (*REDBrick) SetResponseExpectedAll(responseExpected bool) (err error)
Parameter:
  • responseExpected – Typ: bool
Rückgabe:
  • err – Typ: error

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

Konstanten

red_brick.DeviceIdentifier

Diese Konstante wird verwendet um einen RED Brick zu identifizieren.

Die GetIdentity() Funktion und der (*IPConnection) RegisterEnumerateCallback Callback der IPConnection haben ein deviceIdentifier Parameter um den Typ des Bricks oder Bricklets anzugeben.

red_brick.DeviceDisplayName

Diese Konstante stellt den Anzeigenamen eines RED Brick dar.