[go: nahoru, domu]
Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Websock API cleanup #1782

Merged
merged 18 commits into from
Jun 30, 2023
Merged

Websock API cleanup #1782

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
18 commits
Select commit Hold shift + click to select a range
87143b3
Reduce kept state in JPEG decoder
CendioOssman May 15, 2023
ae9b042
Change rQslice() to rQpeekBytes()
CendioOssman May 11, 2023
fb3c8f6
Switch Display.flush() to use a promise
CendioOssman May 11, 2023
0180bc8
Stop direct access to socket buffer
CendioOssman May 11, 2023
55ffe8f
Stop exposing Websock queue length
CendioOssman May 14, 2023
e01dd27
Remove Websock implicit read length
CendioOssman May 14, 2023
aaa4eb8
Use proper socket helpers for FBU header
CendioOssman Jun 4, 2023
d0203a5
Always return copy of data from socket
CendioOssman May 16, 2023
0ccc679
Return unsigned values from rQshift32()
CendioOssman Jun 4, 2023
12d2e78
Properly decode ExtendedDesktopSize fields
CendioOssman Jun 4, 2023
45cedea
Don't send SetDesktopSize too early
CendioOssman Jun 4, 2023
2a7db6f
Make ExtendedDesktopSize tests more realistic
CendioOssman Jun 4, 2023
b298bf9
Don't split large WebSocket data in tests
CendioOssman Jun 4, 2023
b146de6
Avoid internal variables in recv queue tests
CendioOssman Jun 4, 2023
3fc0cb0
Remove Base64 WebSocket remnants
CendioOssman May 15, 2023
7356d4e
Move WebSocket queue index reset to receive
CendioOssman May 21, 2023
f8b65f9
Add Websock send queue helpers
CendioOssman May 28, 2023
ccef89f
Implicitly flush Websock if needed
CendioOssman May 30, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Implicitly flush Websock if needed 
Callers shouldn't have to deal with the internal buffering limits of
Websock, so implicitly flush the buffer if more room is needed.
  • Loading branch information
@CendioOssman
CendioOssman committed Jun 4, 2023
commit ccef89f55651e083fc2e818a251d09ff0bf9e75a
19 changes: 2 additions & 17 deletions core/rfb.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3047,23 +3047,8 @@ RFB.messages = {
}

sock.sQpush32(length);

// We have to keep track of from where in the data we begin creating the
// buffer for the flush in the next iteration.
let dataOffset = 0;

let remaining = data.length;
while (remaining > 0) {

let flushSize = Math.min(remaining, (sock._sQbufferSize - sock._sQlen));

sock.sQpushBytes(data.subarray(dataOffset, dataOffset + flushSize));
sock.flush();

remaining -= flushSize;
dataOffset += flushSize;
}

sock.sQpushBytes(data);
sock.flush();
},

setDesktopSize(sock, width, height, id, flags) {
Expand Down
23 changes: 21 additions & 2 deletions core/websock.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -176,15 +176,18 @@ export default class Websock {
// Send Queue

sQpush8(num) {
this._sQensureSpace(1);
this._sQ[this._sQlen++] = num;
}

sQpush16(num) {
this._sQensureSpace(2);
this._sQ[this._sQlen++] = (num >> 8) & 0xff;
this._sQ[this._sQlen++] = (num >> 0) & 0xff;
}

sQpush32(num) {
this._sQensureSpace(4);
this._sQ[this._sQlen++] = (num >> 24) & 0xff;
this._sQ[this._sQlen++] = (num >> 16) & 0xff;
this._sQ[this._sQlen++] = (num >> 8) & 0xff;
Expand All @@ -197,8 +200,18 @@ export default class Websock {
}

sQpushBytes(bytes) {
this._sQ.set(bytes, this._sQlen);
this._sQlen += bytes.length;
for (let offset = 0;offset < bytes.length;) {
this._sQensureSpace(1);

let chunkSize = this._sQbufferSize - this._sQlen;
if (chunkSize > bytes.length - offset) {
chunkSize = bytes.length - offset;
}

this._sQ.set(bytes.subarray(offset, chunkSize), this._sQlen);
this._sQlen += chunkSize;
offset += chunkSize;
}
}

flush() {
Expand All @@ -208,6 +221,12 @@ export default class Websock {
}
}

_sQensureSpace(bytes) {
if (this._sQbufferSize - this._sQlen < bytes) {
this.flush();
}
}

// Event Handlers
off(evt) {
this._eventHandlers[evt] = () => {};
Expand Down
116 changes: 116 additions & 0 deletions tests/test.websock.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -150,6 +150,8 @@ describe('Websock', function () {
describe('Send queue methods', function () {
let sock;

const bufferSize = 10 * 1024;

beforeEach(function () {
let websock = new FakeWebSocket();
websock._open();
Expand All @@ -167,6 +169,18 @@ describe('Websock', function () {
sock.sQpush8(42);
expect(sock).to.have.sent(new Uint8Array([]));
});
it('should implicitly flush if the queue is full', function () {
for (let i = 0;i <= bufferSize;i++) {
sock.sQpush8(42);
}

let expected = [];
for (let i = 0;i < bufferSize;i++) {
expected.push(42);
}

expect(sock).to.have.sent(new Uint8Array(expected));
});
});

describe('sQpush16()', function () {
Expand All @@ -179,6 +193,19 @@ describe('Websock', function () {
sock.sQpush16(420);
expect(sock).to.have.sent(new Uint8Array([]));
});
it('should implicitly flush if the queue is full', function () {
for (let i = 0;i <= bufferSize/2;i++) {
sock.sQpush16(420);
}

let expected = [];
for (let i = 0;i < bufferSize/2;i++) {
expected.push(1);
expected.push(164);
}

expect(sock).to.have.sent(new Uint8Array(expected));
});
});

describe('sQpush32()', function () {
Expand All @@ -191,6 +218,21 @@ describe('Websock', function () {
sock.sQpush32(420420);
expect(sock).to.have.sent(new Uint8Array([]));
});
it('should implicitly flush if the queue is full', function () {
for (let i = 0;i <= bufferSize/4;i++) {
sock.sQpush32(420420);
}

let expected = [];
for (let i = 0;i < bufferSize/4;i++) {
expected.push(0);
expected.push(6);
expected.push(106);
expected.push(68);
}

expect(sock).to.have.sent(new Uint8Array(expected));
});
});

describe('sQpushString()', function () {
Expand All @@ -203,6 +245,41 @@ describe('Websock', function () {
sock.sQpushString('\x12\x34\x56\x78\x90');
expect(sock).to.have.sent(new Uint8Array([]));
});
it('should implicitly flush if the queue is full', function () {
for (let i = 0;i <= bufferSize/5;i++) {
sock.sQpushString('\x12\x34\x56\x78\x90');
}

let expected = [];
for (let i = 0;i < bufferSize/5;i++) {
expected.push(0x12);
expected.push(0x34);
expected.push(0x56);
expected.push(0x78);
expected.push(0x90);
}

expect(sock).to.have.sent(new Uint8Array(expected));
});
it('should implicitly split a large buffer', function () {
let str = '';
for (let i = 0;i <= bufferSize/5;i++) {
str += '\x12\x34\x56\x78\x90';
}

sock.sQpushString(str);

let expected = [];
for (let i = 0;i < bufferSize/5;i++) {
expected.push(0x12);
expected.push(0x34);
expected.push(0x56);
expected.push(0x78);
expected.push(0x90);
}

expect(sock).to.have.sent(new Uint8Array(expected));
});
});

describe('sQpushBytes()', function () {
Expand All @@ -215,6 +292,45 @@ describe('Websock', function () {
sock.sQpushBytes(new Uint8Array([0x12, 0x34, 0x56, 0x78, 0x90]));
expect(sock).to.have.sent(new Uint8Array([]));
});
it('should implicitly flush if the queue is full', function () {
for (let i = 0;i <= bufferSize/5;i++) {
sock.sQpushBytes(new Uint8Array([0x12, 0x34, 0x56, 0x78, 0x90]));
}

let expected = [];
for (let i = 0;i < bufferSize/5;i++) {
expected.push(0x12);
expected.push(0x34);
expected.push(0x56);
expected.push(0x78);
expected.push(0x90);
}

expect(sock).to.have.sent(new Uint8Array(expected));
});
it('should implicitly split a large buffer', function () {
let buffer = [];
for (let i = 0;i <= bufferSize/5;i++) {
buffer.push(0x12);
buffer.push(0x34);
buffer.push(0x56);
buffer.push(0x78);
buffer.push(0x90);
}

sock.sQpushBytes(new Uint8Array(buffer));

let expected = [];
for (let i = 0;i < bufferSize/5;i++) {
expected.push(0x12);
expected.push(0x34);
expected.push(0x56);
expected.push(0x78);
expected.push(0x90);
}

expect(sock).to.have.sent(new Uint8Array(expected));
});
});

describe('flush', function () {
Expand Down