Old Engine/On Demand Protocol - Revision history

Pazaz at 16:18, 8 September 2021

2021-09-08T16:18:40Z

← Older revision		Revision as of 12:18, 8 September 2021
Line 38:		Line 38:
	*Sixth byte is the part number		*Sixth byte is the part number
	*The remaining (up to) 500 bytes is the file part data		*The remaining (up to) 500 bytes is the file part data

			== Example ==
			<syntaxhighlight lang="javascript">
			while (data.length() > data.offset) {
			let index = data.readByte();
			let entry = data.readWord();
			let priority = data.readByte();

			if (priority === 2) {
			coreQueue.push({ socket, index, entry, priority });
			} else if (priority == 1) {
			preloadQueue.push({ socket, index, entry, priority });
			} else if (priority == 0) {
			ingameQueue.push({ socket, index, entry, priority });
			}
			}

			...

			let sendBuffer = Buffer.alloc(6);
			sendBuffer.writeUInt8(request.index, 0);
			sendBuffer.writeUInt16BE(request.entry, 1);
			sendBuffer.writeUInt16BE(file.length, 3);
			sendBuffer.writeUInt8(request.part, 5);
			let offset = i * 500;
			if (offset + 500 < file.length) {
			sendBuffer = Buffer.concat([sendBuffer, file.slice(offset, offset + 500)]);
			} else {
			sendBuffer = Buffer.concat([sendBuffer, file.slice(offset)]);
			}
			request.socket.write(sendBuffer);
			</syntaxhighlight>

Pazaz at 03:50, 7 September 2021

2021-09-07T03:50:26Z

← Older revision		Revision as of 23:50, 6 September 2021
Line 1:		Line 1:
			[[File:Ondemand Example.png\|thumb\|The client beginning to load extra files via on demand]]

	==Resources==		==Resources==
	[[Data Types]]		[[Data Types]]
Line 11:		Line 13:
	After this point the client stream is dedicated to on demand requests and will begin requesting missing data from the server.		After this point the client stream is dedicated to on demand requests and will begin requesting missing data from the server.

	== Processing ==		==Processing==
	Each request looks like this, and there may be multiple requests appended in a single read:		Each request looks like this, and there may be multiple requests appended in a single read:

	* First byte is the index		*First byte is the index
	* Second word is the entry		*Second word is the entry
	* Third byte is the priority		*Third byte is the priority

	The priority field has 3 possible values:		The priority field has 3 possible values:

	* 2: loading core files		*2: loading core files
	* 1: preloading extra files		*1: preloading extra files
	* 0: loading file in-game		*0: loading file in-game

	== Responding ==		==Responding==
	The client will read up to 506-bytes from the server at a time. 6 bytes are used for the file part header and up to 500 bytes are used for the file data. If a file is longer than 500 bytes (very likely) then the file must be sent in 500-byte increments.		The client will read up to 506-bytes from the server at a time. 6 bytes are used for the file part header and up to 500 bytes are used for the file data. If a file is longer than 500 bytes (very likely) then the file must be sent in 500-byte increments.

Line 31:		Line 33:
	The response looks like this:		The response looks like this:

	* First byte is the index		*First byte is the index
	* Second and third byte is the entry		*Second and third byte is the entry
	* Fourth and fifth byte is the total file size		*Fourth and fifth byte is the total file size
	* Sixth byte is the part number		*Sixth byte is the part number
	* The remaining (up to) 500 bytes is the file part data		*The remaining (up to) 500 bytes is the file part data

Pazaz at 03:46, 7 September 2021

2021-09-07T03:46:56Z

← Older revision		Revision as of 23:46, 6 September 2021
Line 5:		Line 5:

	==Handshaking==		==Handshaking==
			The client begins by sending a single byte, 15.

			The server should respond with eight bytes. Their values are ignored, but send 0s here anyways.

			After this point the client stream is dedicated to on demand requests and will begin requesting missing data from the server.

			== Processing ==
			Each request looks like this, and there may be multiple requests appended in a single read:

			* First byte is the index
			* Second word is the entry
			* Third byte is the priority

			The priority field has 3 possible values:

			* 2: loading core files
			* 1: preloading extra files
			* 0: loading file in-game

			== Responding ==
			The client will read up to 506-bytes from the server at a time. 6 bytes are used for the file part header and up to 500 bytes are used for the file data. If a file is longer than 500 bytes (very likely) then the file must be sent in 500-byte increments.

			File parts may be sent over time and do not need to be sent sequentially. This helps decrease the load on the server assuming it gets processed over time.

			The response looks like this:

			* First byte is the index
			* Second and third byte is the entry
			* Fourth and fifth byte is the total file size
			* Sixth byte is the part number
			* The remaining (up to) 500 bytes is the file part data

Pazaz at 03:29, 7 September 2021

2021-09-07T03:29:40Z

← Older revision		Revision as of 23:29, 6 September 2021
Line 1:		Line 1:
	== Resources ==		==Resources==
	[[Data Types]]		[[Data Types]]

	~~[[Old Engine/Cache Format]]~~

	[[Old Engine/File Store]]		[[Old Engine/File Store]]

	== Handshaking ==		==Handshaking==

Pazaz at 03:27, 7 September 2021

2021-09-07T03:27:11Z

← Older revision	Revision as of 23:27, 6 September 2021
Line 1:	Line 1:
		== Resources ==
		[[Data Types]]

		[[Old Engine/Cache Format]]

		[[Old Engine/File Store]]

		== Handshaking ==

Pazaz: Pazaz moved page On Demand Protocol to Old Engine/On Demand Protocol: Reorganization

2021-09-07T02:44:41Z

Pazaz moved page On Demand Protocol to Old Engine/On Demand Protocol: Reorganization

← Older revision

Revision as of 22:44, 6 September 2021

Pazaz: Created blank page

2021-09-05T21:46:23Z

Created blank page

New page