From b8b787f2e2d91635f8edcb41b8c77b37fdad87fb Mon Sep 17 00:00:00 2001
From: Nick O'Leary <nick.oleary@gmail.com>
Date: Mon, 7 Sep 2015 21:27:33 +0100
Subject: [PATCH] Update api.html

---
 api.html | 26 ++++++++++++++++----------
 1 file changed, 16 insertions(+), 10 deletions(-)

diff --git a/api.html b/api.html
index e9c75fc..35ea364 100644
--- a/api.html
+++ b/api.html
@@ -167,8 +167,8 @@ void setup() {
     </ul>
     <h5>Returns</h5>
     <ul>
-        <li>false - publish failed.</li>
-        <li>true - publish succeeded.</li>
+        <li>false - publish failed, either connection lost, or message too large</li>
+        <li>true - publish succeeded</li>
     </ul>
 </section>
 
@@ -183,8 +183,8 @@ void setup() {
     </ul>
     <h5>Returns</h5>
     <ul>
-        <li>false - publish failed.</li>
-        <li>true - publish succeeded.</li>
+        <li>false - publish failed, either connection lost, or message too large</li>
+        <li>true - publish succeeded</li>
     </ul>
 </section>
 
@@ -205,8 +205,8 @@ void setup() {
     </ul>
     <h5>Returns</h5>
     <ul>
-        <li>false - publish failed.</li>
-        <li>true - publish succeeded.</li>
+        <li>false - publish failed, either connection lost, or message too large</li>
+        <li>true - publish succeeded</li>
     </ul>
 </section>
 
@@ -227,8 +227,8 @@ void setup() {
     </ul>
     <h5>Returns</h5>
     <ul>
-        <li>false - publish failed.</li>
-        <li>true - publish succeeded.</li>
+        <li>false - publish failed</li>
+        <li>true - publish succeeded</li>
     </ul>
 </section>
 
@@ -242,7 +242,7 @@ void setup() {
     </ul>
     <h5>Returns</h5>
     <ul>
-        <li>false - sending the subscribe failed.</li>
+        <li>false - sending the subscribe failed, either connection lost, or message too large.</li>
         <li>true - sending the subscribe succeeded. The request completes asynchronously.</li>
     </ul>
 </section>
@@ -256,7 +256,7 @@ void setup() {
     </ul>
     <h5>Returns</h5>
     <ul>
-        <li>false - sending the unsubscribe failed.</li>
+        <li>false - sending the unsubscribe failed, either connection lost, or message too large.</li>
         <li>true - sending the unsubscribe succeeded. The request completes asynchronously.</li>
     </ul>
 </section>
@@ -375,6 +375,12 @@ void setup() {
         <dd>Sets the version of the MQTT protocol to use.</p>
             <p>Default: MQTT 3.1.1</p>
         </dd>
+        <dt><code>MQTT_MAX_TRANSFER_SIZE</code></dt>
+        <dd>Sets the maximum number of bytes passed to the network client in each
+            write call. Some hardware has a limit to how much data can be passed
+            to them in one go, such as the Arduino Wifi Shield.</p>
+            <p>Default: undefined (complete packet passed in each write call)</p>
+        </dd>
     </dl>
 </section>