Skip to content

Commit

Permalink
Deprecate vibe.internal.array.FixedRingBuffer.
Browse files Browse the repository at this point in the history
  • Loading branch information
s-ludwig committed Feb 14, 2024
1 parent c34d773 commit bba6ab4
Show file tree
Hide file tree
Showing 5 changed files with 36 additions and 12 deletions.
2 changes: 1 addition & 1 deletion dub.sdl
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ copyright "Copyright © 2016-2020, Sönke Ludwig"
license "MIT"

dependency "eventcore" version="~>0.9.27"
dependency "vibe-container" version=">=1.0.2 <2.0.0-0"
dependency "vibe-container" version=">=1.1.0 <2.0.0-0"

targetName "vibe_core"

Expand Down
27 changes: 25 additions & 2 deletions source/vibe/core/channel.d
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
*/
module vibe.core.channel;

import vibe.container.ringbuffer : RingBuffer;
import vibe.core.sync : TaskCondition;
import vibe.internal.array : FixedRingBuffer;

Expand Down Expand Up @@ -135,10 +136,20 @@ struct Channel(T, size_t buffer_size = 100) {
If the `empty` property is or becomes `true` before data becomes
avaiable, `dst` will be left untouched and `false` is returned.
*/
bool consumeAll(ref RingBuffer!(T, buffer_size) dst)
in { assert(dst.empty); }
do { return m_impl.consumeAll(dst); }
/// ditto
bool consumeAll(ref RingBuffer!(T, buffer_size) dst) shared
in { assert(dst.empty); }
do { return m_impl.consumeAll(dst); }
/// ditto
deprecated("Pass a reference to `vibe.container.ringbuffer.RingBuffer` instead.")
bool consumeAll(ref FixedRingBuffer!(T, buffer_size) dst)
in { assert(dst.empty); }
do { return m_impl.consumeAll(dst); }
/// ditto
deprecated("Pass a reference to `vibe.container.ringbuffer.RingBuffer` instead.")
bool consumeAll(ref FixedRingBuffer!(T, buffer_size) dst) shared
in { assert(dst.empty); }
do { return m_impl.consumeAll(dst); }
Expand All @@ -161,7 +172,7 @@ private final class ChannelImpl(T, size_t buffer_size) {
private {
Mutex m_mutex;
TaskCondition m_condition;
FixedRingBuffer!(T, buffer_size) m_items;
RingBuffer!(T, buffer_size) m_items;
bool m_closed = false;
ChannelConfig m_config;
int m_refCount = 1;
Expand Down Expand Up @@ -260,7 +271,7 @@ private final class ChannelImpl(T, size_t buffer_size) {
need_notify = thisus.m_items.full;

move(thisus.m_items.front, dst);
thisus.m_items.popFront();
thisus.m_items.removeFront();

if (m_config.priority == ChannelPriority.overhead)
need_notify = thisus.m_items.empty;
Expand All @@ -284,7 +295,19 @@ private final class ChannelImpl(T, size_t buffer_size) {
return ret;
}

deprecated
bool consumeAll(ref FixedRingBuffer!(T, buffer_size) dst)
shared nothrow {
RingBuffer!(T, buffer_size) tmp;
if (!consumeAll(tmp))
return false;
dst.clear();
foreach (ref el; tmp[])
dst.put(el);
return true;
}

bool consumeAll(ref RingBuffer!(T, buffer_size) dst)
shared nothrow {
auto thisus = () @trusted { return cast(ChannelImpl)this; } ();
bool need_notify = false;
Expand Down
6 changes: 3 additions & 3 deletions source/vibe/core/core.d
Original file line number Diff line number Diff line change
Expand Up @@ -10,14 +10,14 @@ module vibe.core.core;
public import vibe.core.task;

import eventcore.core;
import vibe.container.ringbuffer : RingBuffer;
import vibe.core.args;
import vibe.core.concurrency;
import vibe.core.internal.release;
import vibe.core.log;
import vibe.core.sync : ManualEvent, createSharedManualEvent;
import vibe.core.taskpool : TaskPool;
import vibe.internal.async;
import vibe.internal.array : FixedRingBuffer;
//import vibe.utils.array;
import std.algorithm;
import std.conv;
Expand Down Expand Up @@ -407,7 +407,7 @@ package Task runTask_internal(alias TFI_SETUP)()
TaskFiber f;
while (!f && !s_availableFibers.empty) {
f = s_availableFibers.back;
s_availableFibers.popBack();
s_availableFibers.removeBack();
if (() @trusted nothrow { return f.state; } () != Fiber.State.HOLD) f = null;
}

Expand Down Expand Up @@ -1765,7 +1765,7 @@ private {
bool delegate() @safe nothrow s_idleHandler;

TaskScheduler s_scheduler;
FixedRingBuffer!TaskFiber s_availableFibers;
RingBuffer!TaskFiber s_availableFibers;
size_t s_maxRecycledFibers = 100;

string s_privilegeLoweringUserName;
Expand Down
8 changes: 4 additions & 4 deletions source/vibe/core/taskpool.d
Original file line number Diff line number Diff line change
Expand Up @@ -437,12 +437,12 @@ private struct TaskQueue {
nothrow @safe:
// TODO: avoid use of GC

import vibe.internal.array : FixedRingBuffer;
FixedRingBuffer!TaskFuncInfo* m_queue;
import vibe.container.ringbuffer : RingBuffer;
RingBuffer!TaskFuncInfo* m_queue;

void setup()
{
m_queue = new FixedRingBuffer!TaskFuncInfo;
m_queue = new RingBuffer!TaskFuncInfo;
}

@property bool empty() const { return m_queue.empty; }
Expand All @@ -466,7 +466,7 @@ nothrow @safe:

if (m_queue.empty) return false;
swap(tfi, m_queue.front);
m_queue.popFront();
m_queue.removeFront();
return true;
}
}
5 changes: 3 additions & 2 deletions source/vibe/internal/array.d
Original file line number Diff line number Diff line change
Expand Up @@ -291,6 +291,7 @@ struct FixedAppender(ArrayType : E[], size_t NELEM, E) {
/**
TODO: clear ring buffer fields upon removal (to run struct destructors, if T is a struct)
*/
deprecated("Use `vibe.container.ringbuffer.RingBuffer` instead.")
struct FixedRingBuffer(T, size_t N = 0, bool INITIALIZE = true) {
private {
static if( N > 0 ) {
Expand Down Expand Up @@ -559,7 +560,7 @@ struct FixedRingBuffer(T, size_t N = 0, bool INITIALIZE = true) {
}
}

unittest {
deprecated unittest {
static assert(isInputRange!(FixedRingBuffer!int) && isOutputRange!(FixedRingBuffer!int, int));

FixedRingBuffer!(int, 5) buf;
Expand Down Expand Up @@ -595,7 +596,7 @@ unittest {
}
}

unittest {
deprecated unittest {
int* pcnt = new int;

static struct S {
Expand Down

0 comments on commit bba6ab4

Please sign in to comment.