Compare commits
16 Commits
e356c06c25
...
bfee652a94
|
|
@ -6,9 +6,9 @@ name: D
|
|||
|
||||
on:
|
||||
push:
|
||||
branches: [ "master" ]
|
||||
branches: [ "**" ]
|
||||
pull_request:
|
||||
branches: [ "master", "nextgen" ]
|
||||
branches: [ "**" ]
|
||||
|
||||
permissions:
|
||||
contents: read
|
||||
|
|
@ -22,6 +22,11 @@ jobs:
|
|||
- uses: actions/checkout@v3
|
||||
- uses: dlang-community/setup-dlang@4c99aa991ce7d19dd3064de0a4f2f6b2f152e2d7
|
||||
|
||||
- name: Install Doveralls (code coverage tool)
|
||||
run: |
|
||||
dub fetch doveralls
|
||||
sudo apt install libcurl4-openssl-dev
|
||||
|
||||
- name: 'Build & Test'
|
||||
run: |
|
||||
# Build the project, with its main file included, without unittests
|
||||
|
|
@ -29,4 +34,8 @@ jobs:
|
|||
# Build and run tests, as defined by `unittest` configuration
|
||||
# In this mode, `mainSourceFile` is excluded and `version (unittest)` are included
|
||||
# See https://dub.pm/package-format-json.html#configurations
|
||||
dub test --compiler=$DC
|
||||
dub test --compiler=$DC --coverage
|
||||
|
||||
- name: Coverage upload
|
||||
run: |
|
||||
dub run doveralls -- -t ${{secrets.COVERALLS_REPO_TOKEN}}
|
||||
|
|
|
|||
|
|
@ -3,7 +3,8 @@
|
|||
tristanable
|
||||
===========
|
||||
|
||||
[](https://github.com/deavmi/tristanable/actions/workflows/d.yml)
|
||||
[](https://github.com/deavmi/tristanable/actions/workflows/d.yml)    [](https://coveralls.io/github/deavmi/tristanable?branch=master)
|
||||
|
||||
|
||||
**Tristanable** is a library for D-based libraries and applications that need a way to receive variable-length messages of different types (via a `Socket`) and place these messages into their own respectively tagged queues indicated by their _"type"_ or `id`.
|
||||
|
||||
|
|
|
|||
4
dub.json
4
dub.json
|
|
@ -4,8 +4,8 @@
|
|||
],
|
||||
"copyright": "Copyright © 2023, Tristan B. Kildaire",
|
||||
"dependencies": {
|
||||
"bformat": "4.1.0",
|
||||
"libsnooze": "0.3.3"
|
||||
"bformat": ">=4.1.1",
|
||||
"niknaks": ">=0.3.0"
|
||||
},
|
||||
"description": "Tristanable network message queuing framework",
|
||||
"homepage": "https://deavmi.assigned.network/projects/tristanable",
|
||||
|
|
|
|||
|
|
@ -4,6 +4,7 @@
|
|||
module tristanable.encoding;
|
||||
|
||||
import std.conv : to;
|
||||
import niknaks.bits : bytesToIntegral, Order, order, toBytes;
|
||||
|
||||
/**
|
||||
* Represents a tagged message that has been decoded
|
||||
|
|
@ -60,31 +61,9 @@ public final class 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 😳️");
|
||||
}
|
||||
/* Take ulong-many bytes and only flip them to LE if not on LE host */
|
||||
decodedTag = order(bytesToIntegral!(ushort)(cast(ubyte[])encodedMessage), Order.LE);
|
||||
|
||||
|
||||
/* Set the tag */
|
||||
decodedMessage.setTag(decodedTag);
|
||||
|
|
@ -106,41 +85,9 @@ public final class TaggedMessage
|
|||
/* 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;
|
||||
/* If on little endian then no re-order, if host is BE flip (the tag) */
|
||||
encodedMessage ~= toBytes(order(tag, Order.LE));
|
||||
|
||||
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;
|
||||
|
|
|
|||
|
|
@ -24,7 +24,17 @@ public enum ErrorType
|
|||
/**
|
||||
* If no default queue is configured
|
||||
*/
|
||||
NO_DEFAULT_QUEUE
|
||||
NO_DEFAULT_QUEUE,
|
||||
|
||||
/**
|
||||
* The blocking call to `dequeue()`, somehow, failed
|
||||
*/
|
||||
DEQUEUE_FAILED,
|
||||
|
||||
/**
|
||||
* The call to `enqueue()`, somehow, failed
|
||||
*/
|
||||
ENQUEUE_FAILED
|
||||
}
|
||||
|
||||
/**
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@
|
|||
module tristanable.manager.manager;
|
||||
|
||||
import std.socket;
|
||||
import tristanable.queue : Queue;
|
||||
import tristanable.queue.queue : Queue;
|
||||
import core.sync.mutex : Mutex;
|
||||
import tristanable.manager.watcher : Watcher;
|
||||
import tristanable.encoding : TaggedMessage;
|
||||
|
|
|
|||
|
|
@ -11,7 +11,7 @@ import std.socket;
|
|||
import bformat;
|
||||
import tristanable.encoding;
|
||||
import tristanable.exceptions;
|
||||
import tristanable.queue;
|
||||
import tristanable.queue.queue;
|
||||
import bformat.client;
|
||||
|
||||
/**
|
||||
|
|
@ -204,6 +204,28 @@ unittest
|
|||
writeln("server send status: ", bClient.sendMessage(tEncoded));
|
||||
|
||||
writeln("server send [done]");
|
||||
|
||||
/**
|
||||
* Create a tagged message to send
|
||||
*
|
||||
* tag 100 payload Bye
|
||||
*/
|
||||
message = new TaggedMessage(100, cast(byte[])"DEFQUEUE_1");
|
||||
tEncoded = message.encode();
|
||||
writeln("server send status: ", bClient.sendMessage(tEncoded));
|
||||
|
||||
writeln("server send [done]");
|
||||
|
||||
/**
|
||||
* Create a tagged message to send
|
||||
*
|
||||
* tag 200 payload Bye
|
||||
*/
|
||||
message = new TaggedMessage(200, cast(byte[])"DEFQUEUE_2");
|
||||
tEncoded = message.encode();
|
||||
writeln("server send status: ", bClient.sendMessage(tEncoded));
|
||||
|
||||
writeln("server send [done]");
|
||||
}
|
||||
}
|
||||
|
||||
|
|
@ -223,6 +245,10 @@ unittest
|
|||
manager.registerQueue(sixtyNine);
|
||||
manager.registerQueue(fortyTwo);
|
||||
|
||||
// Register a default queue (tag ignored)
|
||||
Queue defaultQueue = new Queue(2332);
|
||||
manager.setDefaultQueue(defaultQueue);
|
||||
|
||||
|
||||
/* Connect our socket to the server */
|
||||
client.connect(server.localAddress);
|
||||
|
|
@ -252,6 +278,19 @@ unittest
|
|||
assert(dequeuedMessage.getPayload() == cast(byte[])"Cucumber 😳️");
|
||||
|
||||
|
||||
/* Dequeue two messages from the default queue */
|
||||
writeln("unittest thread: Dequeue() blocking...");
|
||||
dequeuedMessage = defaultQueue.dequeue();
|
||||
writeln("unittest thread: Got '"~dequeuedMessage.toString()~"' decode payload to string '"~cast(string)dequeuedMessage.getPayload()~"'");
|
||||
assert(dequeuedMessage.getTag() == 100);
|
||||
assert(dequeuedMessage.getPayload() == cast(byte[])"DEFQUEUE_1");
|
||||
|
||||
writeln("unittest thread: Dequeue() blocking...");
|
||||
dequeuedMessage = defaultQueue.dequeue();
|
||||
writeln("unittest thread: Got '"~dequeuedMessage.toString()~"' decode payload to string '"~cast(string)dequeuedMessage.getPayload()~"'");
|
||||
assert(dequeuedMessage.getTag() == 200);
|
||||
assert(dequeuedMessage.getPayload() == cast(byte[])"DEFQUEUE_2");
|
||||
|
||||
|
||||
/* Stop the manager */
|
||||
manager.stop();
|
||||
|
|
|
|||
|
|
@ -11,9 +11,8 @@ public import tristanable.manager;
|
|||
|
||||
/**
|
||||
* A queue of queue items all of the same tag
|
||||
* and queue-related facilities
|
||||
*/
|
||||
public import tristanable.queue;
|
||||
public import tristanable.queue.queue : Queue;
|
||||
|
||||
/**
|
||||
* Error handling type definitions
|
||||
|
|
|
|||
|
|
@ -5,14 +5,13 @@ module tristanable.queue.queue;
|
|||
|
||||
import tristanable.queue.listener : TListener;
|
||||
|
||||
// TODO: Examine the below import which seemingly fixes stuff for libsnooze
|
||||
import libsnooze.clib;
|
||||
import libsnooze;
|
||||
|
||||
import core.sync.mutex : Mutex;
|
||||
import core.sync.condition : Condition;
|
||||
import core.sync.exception : SyncError;
|
||||
import std.container.slist : SList;
|
||||
import tristanable.encoding;
|
||||
import core.thread : dur;
|
||||
import core.time : Duration, dur;
|
||||
import tristanable.exceptions;
|
||||
|
||||
version(unittest)
|
||||
{
|
||||
|
|
@ -35,8 +34,15 @@ public class Queue
|
|||
/**
|
||||
* The libsnooze event used to sleep/wake
|
||||
* on queue events
|
||||
* Mutex for the condition variable
|
||||
*/
|
||||
private Event event;
|
||||
private Mutex mutex;
|
||||
|
||||
/**
|
||||
* The condition variable used to sleep/wake
|
||||
* on queue of events
|
||||
*/
|
||||
private Condition signal;
|
||||
|
||||
/**
|
||||
* The queue of messages
|
||||
|
|
@ -60,6 +66,15 @@ public class Queue
|
|||
|
||||
// TODO: Add listener add/remove methods
|
||||
// TODO: On queue actions add a notificaiton call to the listeners
|
||||
/**
|
||||
* If a message is enqueued prior
|
||||
* to us sleeping then we won't
|
||||
* wake up and return for it.
|
||||
*
|
||||
* Therefore a periodic wakeup
|
||||
* is required.
|
||||
*/
|
||||
private Duration wakeInterval;
|
||||
|
||||
/**
|
||||
* Constructs a new Queue and immediately sets up the notification
|
||||
|
|
@ -75,14 +90,37 @@ public class Queue
|
|||
/* Initialize the queue lock */
|
||||
this.queueLock = new Mutex();
|
||||
|
||||
/* Initialize the event */
|
||||
this.event = new Event();
|
||||
/* Initialize the condition variable */
|
||||
this.mutex = new Mutex();
|
||||
this.signal = new Condition(this.mutex);
|
||||
|
||||
/* Set the queue id */
|
||||
this.queueID = queueID;
|
||||
|
||||
/* Ensure pipe existence (see https://deavmi.assigned.network/git/deavmi/tristanable/issues/5) */
|
||||
event.wait(dur!("seconds")(0));
|
||||
/* Set the slumber interval */
|
||||
this.wakeInterval = dur!("msecs")(50); // TODO: Decide on value
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the current wake interval
|
||||
* for the queue checker
|
||||
*
|
||||
* Returns: the `Duration`
|
||||
*/
|
||||
public Duration getWakeInterval()
|
||||
{
|
||||
return this.wakeInterval;
|
||||
}
|
||||
|
||||
/**
|
||||
* Sets the wake up interval
|
||||
*
|
||||
* Params:
|
||||
* interval = the new interval
|
||||
*/
|
||||
public void setWakeInterval(Duration interval)
|
||||
{
|
||||
this.wakeInterval = interval;
|
||||
}
|
||||
|
||||
/**
|
||||
|
|
@ -90,6 +128,9 @@ public class Queue
|
|||
* and then wakes up any thread that has called dequeue
|
||||
* on this queue as well
|
||||
*
|
||||
* On error enqueueing a `TristanableException` will be
|
||||
* thrown.
|
||||
*
|
||||
* Params:
|
||||
* message = the TaggedMessage to enqueue
|
||||
*/
|
||||
|
|
@ -121,11 +162,12 @@ public class Queue
|
|||
try
|
||||
{
|
||||
// TODO: Make us wait on the event (optional with a time-out)
|
||||
event.notifyAll();
|
||||
signal.notifyAll();
|
||||
}
|
||||
catch(SnoozeError snozErr)
|
||||
catch(SyncError snozErr)
|
||||
{
|
||||
// TODO: Add error handling for libsnooze exceptions here
|
||||
// Throw an exception on a fatal exception
|
||||
throw new TristanableException(ErrorType.ENQUEUE_FAILED);
|
||||
}
|
||||
}
|
||||
|
||||
|
|
@ -134,6 +176,9 @@ public class Queue
|
|||
/**
|
||||
* Blocks till a message can be dequeued from this queue
|
||||
*
|
||||
* On error dequeueing a `TristanableException` will be
|
||||
* thrown.
|
||||
*
|
||||
* Returns: the dequeued TaggedMessage
|
||||
*/
|
||||
public TaggedMessage dequeue()
|
||||
|
|
@ -157,16 +202,26 @@ public class Queue
|
|||
/* Block till we dequeue a message successfully */
|
||||
while(dequeuedMessage is null)
|
||||
{
|
||||
scope(exit)
|
||||
{
|
||||
// Unlock the mutex
|
||||
this.mutex.unlock();
|
||||
}
|
||||
|
||||
// Lock the mutex
|
||||
this.mutex.lock();
|
||||
|
||||
try
|
||||
{
|
||||
// TODO: Make us wait on the event (optional with a time-out)
|
||||
event.wait();
|
||||
this.signal.wait(this.wakeInterval);
|
||||
}
|
||||
catch(SnoozeError snozErr)
|
||||
catch(SyncError e)
|
||||
{
|
||||
// TODO: Add error handling for libsnooze exceptions here
|
||||
// Throw an exception on a fatal exception
|
||||
throw new TristanableException(ErrorType.DEQUEUE_FAILED);
|
||||
}
|
||||
|
||||
|
||||
/* Lock the item queue */
|
||||
queueLock.lock();
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue