forked from novastone-media/MQTT-Client-Framework
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathindex.html
More file actions
160 lines (158 loc) · 8.96 KB
/
index.html
File metadata and controls
160 lines (158 loc) · 8.96 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
<!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.10"/>
<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 id="projectalign" 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.10 -->
<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 Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</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>
<li>ActiveMQ</li>
<li>Apollo</li>
<li>CloudMQTT</li>
<li>aws</li>
</ul>
<h3>Howto</h3>
<p>Use the CocoaPod MQTTClient!</p>
<p>Or use the dynamic library created in the MQTTFramework target.</p>
<p>Or include the source from here.</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>
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> \@interface MyDelegate : ... MQTTSessionDelegate></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> ...</div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> </div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>  MQTTCFSocketTransport *transport = [[MQTTCFSocketTransport alloc] init];</div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>  transport.host = @"localhost";</div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>  transport.port = 1883;</div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> </div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>  session = [[MQTTSession alloc] init];</div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>  session.transport = transport;</div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> </div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>  session.delegate=self;</div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> </div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>  [session connectAndWaitTimeout:30]; //this is part of the synchronous API</div>
</div><!-- fragment --><p>Subscribe to a topic:</p>
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> [session subscribeToTopic:@"example/#" atLevel:2 subscribeHandler:^(NSError *error, NSArray<NSNumber *> *gQoss){</div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>  if (error) {</div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>  NSLog(@"Subscription failed %@", error.localizedDescription);</div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>  } else {</div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>  NSLog(@"Subscription sucessfull! Granted Qos: %@", gQoss);</div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>  }</div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>  }]; // this is part of the block API</div>
</div><!-- fragment --><p>Add the following to receive messages for the subscribed topics </p><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>  - (void)newMessage:(MQTTSession *)session</div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>  data:(NSData *)data</div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>  onTopic:(NSString *)topic</div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>  qos:(MQTTQosLevel)qos</div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>  retained:(BOOL)retained</div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>  mid:(unsigned int)mid {</div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>  // this is one of the delegate callbacks</div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> }</div>
</div><!-- fragment --><p>Publish a message to a topic:</p>
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> [session publishAndWaitData:data</div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>  onTopic:@"topic"</div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>  retain:NO</div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>  qos:MQTTQosLevelAtLeastOnce]; // this is part of the asynchronous API</div>
</div><!-- fragment --><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>—</th><th>-—</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 Wed Jan 13 2016 22:45:17 for MQTTClient by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.10
</small></address>
</body>
</html>