Skip to content

Commit 8fccedf

Browse files
ethanhannethanhann
committed
Merge branch '3.4-dev'
2 parents 1403eb5 + 2be2b20 commit 8fccedf

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

45 files changed

+530
-613
lines changed

‎.travis.yml‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
sudo: required
2+
services: docker
3+
before_install:
4+
- docker run -d -p 6379:6379 redislabs/redisearch:latest --protected-mode no --loadmodule /var/lib/redis/modules/redisearch.so
5+
language: csharp
6+
solution: InEngine.Net.sln
7+
8+
sudo: false
9+
cache: apt
10+
11+
script:
12+
- xbuild /p:Configuration=Release ./src
13+
- mono src/packages/NUnit.ConsoleRunner.3.7.0/tools/nunit3-console.exe ./src/InEngine.Core.Test/bin/Release/InEngine.Core.Test.dll
14+

‎docs-src/commands.md‎

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,6 @@ namespace MyCommandPlugin
3939
public void Run()
4040
{
4141
Console.WriteLine("Hello, world!");
42-
return new void(true);
4342
}
4443
}
4544
}
@@ -59,7 +58,6 @@ namespace MyCommandPlugin
5958
public override void Run()
6059
{
6160
Console.WriteLine("Hello, world!");
62-
return new void(true);
6361
}
6462
}
6563
}
@@ -223,7 +221,6 @@ public override void Run()
223221
Logger.Warn("Sample warning message");
224222
Logger.Error("Sample error message");
225223
Logger.Fatal("Sample fatal error message");
226-
return new void(true);
227224
}
228225
```
229226

@@ -263,8 +260,6 @@ public override void Run()
263260
// Update the command's progress
264261
UpdateProgress(i);
265262
}
266-
267-
return new void(true);
268263
}
269264
```
270265

‎docs-src/queuing.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -93,3 +93,13 @@ What about 3, 4, or 900 queues? Numerous queues gets to be a pain to manage and,
9393
If it is desirable, different [configuration files](configuration) can be used to run multiple instances of InEngine.NET.
9494
Simply create a new config file with a new QueueName setting and point inengine.exe at it.
9595

96+
## Message Compression
97+
98+
Messages can be compressed when saved in the queue.
99+
It is important to understand the trade-offs of this feature before enabling it.
100+
Compressing messages takes more CPU resources and might negatively impact queueing throughput if the queued commands do not have a lot of internal state.
101+
Put simply, if the commands are too small to benefit from being compressed, then compressing them wastes resources.
102+
103+
If the commands have a lot of internal state, then this feature will reduce the queue's memory consumption.
104+
Also, in a high-throughput scenario, where network bandwidth is limited, this feature can greatly reduce the amount of bandwidth used.
105+

‎docs/commands/index.html‎

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -504,7 +504,6 @@ <h2 id="create-a-command">Create a Command<a class="headerlink" href="#create-a-
504504
<span class="k">public</span> <span class="k">void</span> <span class="nf">Run</span><span class="p">()</span>
505505
<span class="p">{</span>
506506
<span class="n">Console</span><span class="p">.</span><span class="n">WriteLine</span><span class="p">(</span><span class="s">&quot;Hello, world!&quot;</span><span class="p">);</span>
507-
<span class="k">return</span> <span class="k">new</span> <span class="nf">void</span><span class="p">(</span><span class="k">true</span><span class="p">);</span>
508507
<span class="p">}</span>
509508
<span class="p">}</span>
510509
<span class="p">}</span>
@@ -523,7 +522,6 @@ <h2 id="create-a-command">Create a Command<a class="headerlink" href="#create-a-
523522
<span class="k">public</span> <span class="k">override</span> <span class="k">void</span> <span class="nf">Run</span><span class="p">()</span>
524523
<span class="p">{</span>
525524
<span class="n">Console</span><span class="p">.</span><span class="n">WriteLine</span><span class="p">(</span><span class="s">&quot;Hello, world!&quot;</span><span class="p">);</span>
526-
<span class="k">return</span> <span class="k">new</span> <span class="nf">void</span><span class="p">(</span><span class="k">true</span><span class="p">);</span>
527525
<span class="p">}</span>
528526
<span class="p">}</span>
529527
<span class="p">}</span>
@@ -663,7 +661,6 @@ <h2 id="logging">Logging<a class="headerlink" href="#logging" title="Permanent l
663661
<span class="n">Logger</span><span class="p">.</span><span class="n">Warn</span><span class="p">(</span><span class="s">&quot;Sample warning message&quot;</span><span class="p">);</span>
664662
<span class="n">Logger</span><span class="p">.</span><span class="n">Error</span><span class="p">(</span><span class="s">&quot;Sample error message&quot;</span><span class="p">);</span>
665663
<span class="n">Logger</span><span class="p">.</span><span class="n">Fatal</span><span class="p">(</span><span class="s">&quot;Sample fatal error message&quot;</span><span class="p">);</span>
666-
<span class="k">return</span> <span class="k">new</span> <span class="nf">void</span><span class="p">(</span><span class="k">true</span><span class="p">);</span>
667664
<span class="p">}</span>
668665
</pre></div>
669666

@@ -700,8 +697,6 @@ <h2 id="progress-bar">Progress Bar<a class="headerlink" href="#progress-bar" tit
700697
<span class="c1">// Update the command&#39;s progress</span>
701698
<span class="n">UpdateProgress</span><span class="p">(</span><span class="n">i</span><span class="p">);</span>
702699
<span class="p">}</span>
703-
704-
<span class="k">return</span> <span class="k">new</span> <span class="nf">void</span><span class="p">(</span><span class="k">true</span><span class="p">);</span>
705700
<span class="p">}</span>
706701
</pre></div>
707702

‎docs/queuing/index.html‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -384,6 +384,13 @@
384384

385385
</li>
386386

387+
<li class="md-nav__item">
388+
<a href="#message-compression" title="Message Compression" class="md-nav__link">
389+
Message Compression
390+
</a>
391+
392+
</li>
393+
387394

388395

389396
</ul>
@@ -518,6 +525,13 @@
518525

519526
</li>
520527

528+
<li class="md-nav__item">
529+
<a href="#message-compression" title="Message Compression" class="md-nav__link">
530+
Message Compression
531+
</a>
532+
533+
</li>
534+
521535

522536

523537
</ul>
@@ -606,6 +620,13 @@ <h2 id="primary-and-secondary-queue">Primary and Secondary Queue<a class="header
606620
<p>What about 3, 4, or 900 queues? Numerous queues gets to be a pain to manage and, practically speaking, is probably unnecessary.
607621
If it is desirable, different <a href="../configuration">configuration files</a> can be used to run multiple instances of InEngine.NET.
608622
Simply create a new config file with a new QueueName setting and point inengine.exe at it.</p>
623+
<h2 id="message-compression">Message Compression<a class="headerlink" href="#message-compression" title="Permanent link">&para;</a></h2>
624+
<p>Messages can be compressed when saved in the queue.
625+
It is important to understand the trade-offs of this feature before enabling it.
626+
Compressing messages takes more CPU resources and might negatively impact queueing throughput if the queued commands do not have a lot of internal state.
627+
Put simply, if the commands are too small to benefit from being compressed, then compressing them wastes resources.</p>
628+
<p>If the commands have a lot of internal state, then this feature will reduce the queue's memory consumption.
629+
Also, in a high-throughput scenario, where network bandwidth is limited, this feature can greatly reduce the amount of bandwidth used.</p>
609630

610631

611632

0 commit comments

Comments
 (0)