-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
16 changed files
with
1,370 additions
and
46 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -24,3 +24,4 @@ docs/ | |
| *.lst | ||
| source/tristanable/queue.d | ||
| dub.selections.json | ||
| tristanable-test-library | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,221 @@ | ||
| /** | ||
| * Encoding/decoding of the tristanable format | ||
| */ | ||
| module tristanable.encoding; | ||
|
|
||
| import std.conv : to; | ||
|
|
||
| /** | ||
| * Represents a tagged message that has been decoded | ||
| * from its raw byte encoding, this is a tuple of | ||
| * a numeric tag and a byte array of payload data | ||
| * | ||
| * Also provides a static method to decode from such | ||
| * raw encoding and an instance method to do the reverse | ||
| */ | ||
| public final class TaggedMessage | ||
| { | ||
| /** | ||
| * This message's tag | ||
| */ | ||
| private ulong tag; | ||
|
|
||
| /** | ||
| * The payload | ||
| */ | ||
| private byte[] data; | ||
|
|
||
| /** | ||
| * Constructs a new TaggedMessage with the given tag and payload | ||
| * | ||
| * Params: | ||
| * tag = the tag to use | ||
| * data = the payload | ||
| */ | ||
| this(ulong tag, byte[] data) | ||
| { | ||
| this.tag = tag; | ||
| this.data = data; | ||
| } | ||
|
|
||
| /** | ||
| * Parameterless constructor used for decoder | ||
| */ | ||
| private this() {} | ||
|
|
||
| /** | ||
| * Decodes the wire-formatted tristanable bytes into an instance | ||
| * of TaggedMessage whereby the tag and data can be seperately | ||
| * accessed and manipulated | ||
| * | ||
| * Params: | ||
| * encodedMessage = the wire-format encoded bytes | ||
| * Returns: an instance of TaggedMessage | ||
| */ | ||
| public static TaggedMessage decode(byte[] encodedMessage) | ||
| { | ||
| /* The decoded message */ | ||
| TaggedMessage decodedMessage = new TaggedMessage(); | ||
|
|
||
| /* The decoded tag */ | ||
| ulong decodedTag; | ||
|
|
||
| /* If on little endian then dump direct */ | ||
| version(LittleEndian) | ||
| { | ||
| decodedTag = *cast(ulong*)encodedMessage.ptr; | ||
| } | ||
| /* If on big endian then reverse received 8 bytes */ | ||
| else version(BigEndian) | ||
| { | ||
| /* Base of our tag */ | ||
| byte* tagHighPtr = cast(byte*)decodedTag.ptr; | ||
|
|
||
| *(tagHighPtr+0) = encodedMessage[7]; | ||
| *(tagHighPtr+1) = encodedMessage[6]; | ||
| *(tagHighPtr+2) = encodedMessage[5]; | ||
| *(tagHighPtr+3) = encodedMessage[4]; | ||
| *(tagHighPtr+4) = encodedMessage[3]; | ||
| *(tagHighPtr+5) = encodedMessage[2]; | ||
| *(tagHighPtr+6) = encodedMessage[1]; | ||
| *(tagHighPtr+7) = encodedMessage[0]; | ||
| } | ||
| /* Blessed is the fruit of thy womb Jesus, hail Mary, mother of God, pray for our sinners - now and at the hour of our death - Amen */ | ||
| else | ||
| { | ||
| pragma(msg, "Not too sure about tha 'ey 😳️"); | ||
| } | ||
|
|
||
| /* Set the tag */ | ||
| decodedMessage.setTag(decodedTag); | ||
|
|
||
| /* Set the data *(9-th byte onwards) */ | ||
| decodedMessage.setPayload(encodedMessage[8..$]); | ||
|
|
||
| return decodedMessage; | ||
| } | ||
|
|
||
| /** | ||
| * Encodes the tagged message into the tristanable | ||
| * wire format ready for transmission | ||
| * | ||
| * Returns: the encoded bytes | ||
| */ | ||
| public byte[] encode() | ||
| { | ||
| /* The encoded bytes */ | ||
| byte[] encodedMessage; | ||
|
|
||
| /* If on little endian, then dump 64 bit as is - little endian */ | ||
| version(LittleEndian) | ||
| { | ||
| /* Base (little first) of tag */ | ||
| byte* basePtr = cast(byte*)&tag; | ||
|
|
||
| encodedMessage ~= *(basePtr+0); | ||
| encodedMessage ~= *(basePtr+1); | ||
| encodedMessage ~= *(basePtr+2); | ||
| encodedMessage ~= *(basePtr+3); | ||
| encodedMessage ~= *(basePtr+4); | ||
| encodedMessage ~= *(basePtr+5); | ||
| encodedMessage ~= *(basePtr+6); | ||
| encodedMessage ~= *(basePtr+7); | ||
| } | ||
| /* If on big endian, then traverse 64-bit number in reverse - and tack on */ | ||
| else version(BigEndian) | ||
| { | ||
| /* Base (biggest first) of tag */ | ||
| byte* highPtr = cast(byte*)&tag; | ||
|
|
||
| encodedMessage ~= *(highPtr+7); | ||
| encodedMessage ~= *(highPtr+6); | ||
| encodedMessage ~= *(highPtr+5); | ||
| encodedMessage ~= *(highPtr+4); | ||
| encodedMessage ~= *(highPtr+3); | ||
| encodedMessage ~= *(highPtr+2); | ||
| encodedMessage ~= *(highPtr+1); | ||
| encodedMessage ~= *(highPtr+0); | ||
| } | ||
| /* Hail marry, mother of God, pray for our sinners, now and at the our of our death Amen */ | ||
| else | ||
| { | ||
| pragma(msg, "Not feeling scrumptious homeslice 😎️"); | ||
| } | ||
|
|
||
| /* Tack on the data */ | ||
| encodedMessage ~= data; | ||
|
|
||
| return encodedMessage; | ||
| } | ||
|
|
||
| /** | ||
| * Get the message's payload | ||
| * | ||
| * Returns: the payload | ||
| */ | ||
| public byte[] getPayload() | ||
| { | ||
| return data; | ||
| } | ||
|
|
||
| /** | ||
| * Get the message's tag | ||
| * | ||
| * Returns: the tag | ||
| */ | ||
| public ulong getTag() | ||
| { | ||
| return tag; | ||
| } | ||
|
|
||
| /** | ||
| * Set the message's payload | ||
| * | ||
| * Params: | ||
| * newPayload = the payload to use | ||
| */ | ||
| public void setPayload(byte[] newPayload) | ||
| { | ||
| this.data = newPayload; | ||
| } | ||
|
|
||
| /** | ||
| * Set the message's tag | ||
| * | ||
| * Params: | ||
| * newTag = the tag to use | ||
| */ | ||
| public void setTag(ulong newTag) | ||
| { | ||
| this.tag = newTag; | ||
| } | ||
|
|
||
| /** | ||
| * Returns a string representation of the TaggedMessage | ||
| * | ||
| * Returns: the string represenation | ||
| */ | ||
| public override string toString() | ||
| { | ||
| return "TMessage [Tag: "~to!(string)(tag)~", Payload: "~to!(string)(data)~"]"; | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Test encoding and decoding | ||
| */ | ||
| unittest | ||
| { | ||
| /* Setup testing data */ | ||
| TaggedMessage testData = new TaggedMessage(420, [1,2,3]); | ||
|
|
||
| /* Encode */ | ||
| byte[] encoded = testData.encode(); | ||
|
|
||
| /* Decode */ | ||
| TaggedMessage decoded = TaggedMessage.decode(encoded); | ||
|
|
||
| /* Now ensure that `decoded` == original `testData` */ | ||
| assert(decoded.getTag() == testData.getTag); | ||
| assert(decoded.getPayload() == testData.getPayload()); | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,73 @@ | ||
| /** | ||
| * Error handling type definitions | ||
| */ | ||
| module tristanable.exceptions; | ||
|
|
||
| import std.conv : to; | ||
|
|
||
| /** | ||
| * The type of sub-error of the `TristanableException` | ||
| */ | ||
| public enum ErrorType | ||
| { | ||
| /** | ||
| * If the requested queue could not be found | ||
| */ | ||
| QUEUE_NOT_FOUND, | ||
|
|
||
| /** | ||
| * If the queue wanting to be registered has already | ||
| * been registered under the same tag | ||
| */ | ||
| QUEUE_ALREADY_EXISTS, | ||
|
|
||
| /** | ||
| * If no default queue is configured | ||
| */ | ||
| NO_DEFAULT_QUEUE, | ||
|
|
||
| /** | ||
| * The blocking call to `dequeue()`, somehow, failed | ||
| */ | ||
| DEQUEUE_FAILED, | ||
|
|
||
| /** | ||
| * The call to `enqueue()`, somehow, failed | ||
| */ | ||
| ENQUEUE_FAILED | ||
| } | ||
|
|
||
| /** | ||
| * Any sort of error that occurs during runtime of the tristanable | ||
| * engine | ||
| */ | ||
| public class TristanableException : Exception | ||
| { | ||
| /** | ||
| * The sub-error type | ||
| */ | ||
| private ErrorType err; | ||
|
|
||
| /** | ||
| * Constructs a new `TristanableException` with the provided | ||
| * sub-error type | ||
| * | ||
| * Params: | ||
| * err = the `ErrorType` | ||
| */ | ||
| this(ErrorType err) | ||
| { | ||
| super(this.classinfo.name~": "~to!(string)(err)); | ||
| this.err = err; | ||
| } | ||
|
|
||
| /** | ||
| * Retrieve the sub-error type | ||
| * | ||
| * Returns: the sub-error type as a `ErrorType` | ||
| */ | ||
| public ErrorType getError() | ||
| { | ||
| return err; | ||
| } | ||
| } |
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.