MQTTClient/dist/documentation/html/index.html

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.9.1"/>
<title>MQTTClient: Main Page</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { init_search(); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td style="padding-left: 0.5em;">
   <div id="projectname">MQTTClient
   </div>
   <div id="projectbrief">an Objective-C Framework for MQTT</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.9.1 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li class="current"><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
</div><!-- top -->
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="headertitle">
<div class="title">MQTTClient Documentation</div>  </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><p>an Objective-C native MQTT Framework <a href="http://mqtt.org">http://mqtt.org</a></p>
<h3>Tested with</h3>
<ul>
<li>mosquitto</li>
<li>paho</li>
<li>rabbitmq</li>
<li>hivemq</li>
<li>rsmb</li>
<li>mosca</li>
<li>vernemq</li>
<li>emqtt</li>
<li>moquette</li>
</ul>
<h3>Howto</h3>
<p>Add MQTTClient.framework from the dist directory to your IOS project or use the CocoaPod MQTTClient</p>
<p><a href="MQTTClient/dist/documentation/html/index.html">Documentation</a></p>
<h3>Usage</h3>
<p>Create a new client and connect to a broker:</p>
<p>```objective-c <a class="el" href="interface_m_q_t_t_session.html">MQTTSession</a> *session = [[<a class="el" href="interface_m_q_t_t_session.html">MQTTSession</a> alloc]initWithClientId:"client_id"]</p>
<p>// Set delegate appropriately to receive various events // See <a class="el" href="_m_q_t_t_session_8h_source.html">MQTTSession.h</a> for information on various handlers // you can subscribe to. [session setDelegate:self];</p>
<p>[session connectAndWaitToHost:"host" port:1883 usingSSL:NO];</p>
<p>```</p>
<p>Subscribe to a topic:</p>
<p>```objective-c [session subscribeToTopic:topic atLevel:MQTTQosLevelAtLeastOnce]; ```</p>
<p>Publish a message to a topic:</p>
<p>```objective-c [session publishAndWaitData:data onTopic:"topic" retain:NO qos:MQTTQosLevelAtLeastOnce] ```</p>
<h4>Framework</h4>
<p>Framework build using instructions and scripts by Jeff Verkoeyen <a href="https://github.com/jverkoey/iOS-Framework">https://github.com/jverkoey/iOS-Framework</a></p>
<h4>docs</h4>
<p>Documentation generated with doxygen <a href="http://doxygen.org">http://doxygen.org</a></p>
<h4>Comparison MQTT Clients for iOS (incomplete)</h4>
<table class="doxtable">
<tr>
<th>Wrapper</th><th>&mdash;</th><th>-&mdash;</th><th>MQTTKit </th><th>Marquette</th><th>Moscapsule</th><th>Musqueteer</th><th>MQTT-Client</th><th>MqttSDK</th><th>CocoaMQTT  </th></tr>
<tr>
<td></td><td></td><td></td><td>Obj-C </td><td>Obj-C </td><td>Swift </td><td>Obj-C </td><td>Obj-C </td><td>Obj-C </td><td>Swift </td></tr>
<tr>
<td>Library</td><td>IBM</td><td>Paho</td><td>Mosquitto</td><td>Mosquitto</td><td>Mosquitto </td><td>Mosquitto </td><td>native </td><td>native </td><td>native </td></tr>
</table>
</div></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Mon Jul 13 2015 14:27:22 for MQTTClient by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.9.1
</small></address>
</body>
</html>