TruxtonMessage - Revision history

Sam: /* depotid: str */

2024-01-27T19:12:50Z

depotid: str

Sam: /* depotname: str */

2024-01-27T19:12:40Z

depotname: str

Sam: /* depotoffset: int */

2024-01-27T19:12:19Z

depotoffset: int

Sam: /* depotlength: int */

2024-01-27T19:12:05Z

depotlength: int

Sam: /* Sample */

2023-08-18T15:09:01Z

Sample

Sam: /* route() */

2023-05-02T21:54:44Z

route()

Sam at 21:03, 16 September 2022

2022-09-16T21:03:35Z

Sam at 15:38, 29 July 2022

2022-07-29T15:38:05Z

Sam at 09:41, 29 July 2022

2022-07-29T09:41:54Z

Sam: /* Sample */

2021-02-09T14:53:45Z

Sample

@@ Line 4: / Line 4: @@
 ==<code>depotid: str</code>==
 This is the [https://en.wikipedia.org/wiki/Universally_unique_identifier GUID] of the depot file that stores the contents of the file.
-This identifier corresponds to the <code>[ID]</code> column of the <code>[Depot]</code> table.
+This identifier corresponds to the <code>[ID]</code> column of the <code><nowiki>[</nowiki>[[Depot Table|Depot]]<nowiki>]</nowiki></code> table.
 ==<code>depotlength: int</code>==

@@ Line 12: / Line 12: @@
 ==<code>depotname: str</code>==
 The name of the depot that contains the file's contents.
-This corresponds to the <code>[Filename]</code> column of the <code>[Depot]</code> table.
+This corresponds to the <code>[Filename]</code> column of the <code><nowiki>[</nowiki>[[Depot Table|Depot]]<nowiki>]</nowiki></code> table.
 ==<code>depotoffset: int</code>==

@@ Line 16: / Line 16: @@
 ==<code>depotoffset: int</code>==
 The offset into the depot where the first byte of the file resides.
-This corresponds to the <code>[Offset]</code> column of the <code>[Content]</code> table.
+This corresponds to the <code>[Offset]</code> column of the <code><nowiki>[</nowiki>[[Content Table|Content]]<nowiki>]</nowiki></code> table.
 ==<code>dontroute: int</code>==

@@ Line 8: / Line 8: @@
 ==<code>depotlength: int</code>==
 The number of bytes in the depot file that make up this file's contents.
-This corresponds to the <code>[Length]</code> column of the <code>[Content]</code> table.
+This corresponds to the <code>[Length]</code> column of the <code><nowiki>[</nowiki>[[Content Table|Content]]<nowiki>]</nowiki></code> table.
 ==<code>depotname: str</code>==

@@ Line 120: / Line 120: @@
 if __name__ == "__main__":
-   main()
+   sys.exit(main())
 </source>

@@ Line 56: / Line 56: @@
 When this value is non-zero, the message queue is empty.
-==<code>route()</code>==
+==<code>route() -> None</code>==
 This method will send the message using the current route to the message bus.

@@ Line 63: / Line 63: @@
 It should be a value in the <code>[LoadConfigurationID]</code> column of the <code><nowiki>[</nowiki>[[ETLRoute Table|ETLRoute]]<nowiki>]</nowiki></code> table.
-==<code>send(queue_name: str) -> bool</code>==
+==<code>send(queue_name: str) -> boolean</code>==
 This method will send the message to the specified message queue.
 It will return [https://docs.python.org/3/library/constants.html#True True] if the message was sent, [https://docs.python.org/3/library/constants.html#False False] otherwise.

@@ Line 62: / Line 62: @@
 This integer represents the path that files should take through the exploitation processes.
 It should be a value in the <code>[LoadConfigurationID]</code> column of the <code><nowiki>[</nowiki>[[ETLRoute Table|ETLRoute]]<nowiki>]</nowiki></code> table.
 ==<code>signature: int</code>==

@@ Line 2: / Line 2: @@
 =Attributes and Methods=
-==<code>depotid</code>==
+==<code>depotid: str</code>==
 This is the [https://en.wikipedia.org/wiki/Universally_unique_identifier GUID] of the depot file that stores the contents of the file.
 This identifier corresponds to the <code>[ID]</code> column of the <code>[Depot]</code> table.
-==<code>depotlength</code>==
+==<code>depotlength: int</code>==
 The number of bytes in the depot file that make up this file's contents.
 This corresponds to the <code>[Length]</code> column of the <code>[Content]</code> table.
-==<code>depotname</code>==
+==<code>depotname: str</code>==
 The name of the depot that contains the file's contents.
 This corresponds to the <code>[Filename]</code> column of the <code>[Depot]</code> table.
-==<code>depotoffset</code>==
+==<code>depotoffset: int</code>==
 The offset into the depot where the first byte of the file resides.
 This corresponds to the <code>[Offset]</code> column of the <code>[Content]</code> table.
-==<code>dontroute</code>==
+==<code>dontroute: int</code>==
 This integer controls whether the message should be further routed through the message bus.
 This is usually only set when debugging an ETL process.
-==<code>file()</code>==
+==<code>file() -> [[TruxtonFileIO]]</code>==
-This method will return a read-only [[TruxtonFileIO | file]] that you can use to read the contents of the file.
+This method will return a read-only [[TruxtonFileIO|file]] that you can use to read the contents of the file.
-==<code>fileid</code>==
+==<code>fileid: str</code>==
 This is the [https://en.wikipedia.org/wiki/Universally_unique_identifier GUID] of the file.
 This identifier corresponds to the <code>[ID]</code> column of the <code><nowiki>[</nowiki>[[File Table|File]]<nowiki>]</nowiki></code> table.
-==<code>filetype</code>==
+==<code>filetype: int</code>==
 The [[File Types Supported|type of the file]].
 This corresponds to the <code>[FileTypeID]</code> column of the <code><nowiki>[</nowiki>[[File Table|File]]<nowiki>]</nowiki></code> table.
-==<code>hash</code>==
+==<code>hash: str</code>==
 The [https://en.wikipedia.org/wiki/MD5 MD5] hash of the contents of the file.
 This corresponds to the <code>[HashID]</code> column of the <code><nowiki>[</nowiki>[[File Table|File]]<nowiki>]</nowiki></code> table.
-==<code>media()</code>==
+==<code>media() -> [[TruxtonMedia]]</code>==
-Retrieves the [[TruxtonMedia | media]] object associated with this message.
+Retrieves the [[TruxtonMedia|media]] object associated with this message.
-==<code>mediaid</code>==
+==<code>mediaid: str</code>==
 This is the [https://en.wikipedia.org/wiki/Universally_unique_identifier GUID] of the file.
 This identifier corresponds to the <code>[MediaID]</code> column of the <code><nowiki>[</nowiki>[[File Table|File]]<nowiki>]</nowiki></code> table.
-==<code>parentid</code>==
+==<code>parentid: str</code>==
 This is the [https://en.wikipedia.org/wiki/Universally_unique_identifier GUID] of the file.
 This identifier corresponds to the <code>[ParentID]</code> column of the <code><nowiki>[</nowiki>[[File Table|File]]<nowiki>]</nowiki></code> table.
-==<code>priority</code>==
+==<code>priority: int</code>==
 This integer value controls the prioriy of the message.
 High values have greater priority than lower values.
-==<code>queueempty</code>==
+==<code>queueempty: int</code>==
 This integer tells you if your message queue is empty.
 When this value is non-zero, the message queue is empty.
@@ Line 59: / Line 59: @@
 This method will send the message using the current route to the message bus.
-==<code>routeid</code>==
+==<code>routeid: int</code>==
 This integer represents the path that files should take through the exploitation processes.
 It should be a value in the <code>[LoadConfigurationID]</code> column of the <code><nowiki>[</nowiki>[[ETLRoute Table|ETLRoute]]<nowiki>]</nowiki></code> table.
-==<code>signature</code>==
+==<code>signature: int</code>==
 The first four bytes of the file stored as an integer.
 This corresponds to the <code>[Signature]</code> column of the <code><nowiki>[</nowiki>[[File Table|File]]<nowiki>]</nowiki></code> table.

@@ Line 68: / Line 68: @@
 =Sample=
-<source lang="Python" highlight="27, 39-40">
+<source lang="Python" highlight="29, 41-42">
 import truxton