Skip to content

Commit

Permalink
Update docs: Add examples for proto v3
Browse files Browse the repository at this point in the history
  • Loading branch information
thevindu-w committed Jul 1, 2024
1 parent ca0d3fd commit 4db7ef6
Show file tree
Hide file tree
Showing 5 changed files with 883 additions and 8 deletions.
15 changes: 15 additions & 0 deletions docs/examples/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,21 @@ <h3>Protocol Version 2</h3>
<li><a href="v2.html#info">Info</a></li>
</ul>
</p>
<h3>Protocol Version 3</h3>
<p>
<ul>
<li><a href="v3.html#get_text-success">Get text</a></li>
<li><a href="v3.html#get_text-no_data">Get text (No data)</a></li>
<li><a href="v3.html#send_text">Send text</a></li>
<li><a href="v3.html#get_files-success">Get files</a></li>
<li><a href="v3.html#get_files-no_data">Get files (No data)</a></li>
<li><a href="v3.html#send_files">Send files</a></li>
<li><a href="v3.html#get_image">Get image</a></li>
<li><a href="v3.html#get_copied_image_only">Get Copied Image Only</a></li>
<li><a href="v3.html#get_copied_image_only_no_data">Get Copied Image Only (no data)</a></li>
<li><a href="v3.html#info">Info</a></li>
</ul>
</p>
</div>
<div id="fill-page"></div>
<div id="foot">
Expand Down
2 changes: 1 addition & 1 deletion docs/examples/v1.html
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<link rel="stylesheet" href="../style.css">
<title>Protocol Version Negotiation</title>
<title>Protocol Version 1</title>
</head>

<body>
Expand Down
12 changes: 7 additions & 5 deletions docs/examples/v2.html
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,14 @@
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<link rel="stylesheet" href="../style.css">
<title>Protocol Version Negotiation</title>
<title>Protocol Version 2</title>
</head>

<body>
<div id="nav">
<span><a href="v1.html">&lt (Examples v1) Previous</a></span>
<span class="growx"></span>
<span><a href="v3.html">Next (Examples v3) &gt</a></span>
</div>
<div class="page">
<h1>Protocol Version 2</h1>
Expand Down Expand Up @@ -229,8 +231,8 @@ <h2 id="get_files-success">Get Files</h2>
<td class="center">File count</td>
<td class="center">8</td>
<td></td>
<td class="mono">00 00 00 00 00 00 00 03</td>
<td>Server sends the number of files as 3 in a 64-bit signed integer in big-endian
<td class="mono">00 00 00 00 00 00 00 04</td>
<td>Server sends the number of files as 4 in a 64-bit signed integer in big-endian
format.</td>
</tr>
<tr>
Expand Down Expand Up @@ -462,9 +464,9 @@ <h2 id="send_files">Send Files</h2>
<td class="center" rowspan="17">Get files</td>
<td class="center">File count</td>
<td class="center">8</td>
<td class="mono">00 00 00 00 00 00 00 03</td>
<td class="mono">00 00 00 00 00 00 00 04</td>
<td></td>
<td>Client sends the number of files as 3 in a 64-bit signed integer in big-endian
<td>Client sends the number of files as 4 in a 64-bit signed integer in big-endian
format.</td>
</tr>
<tr>
Expand Down
Loading

0 comments on commit 4db7ef6

Please sign in to comment.