PageRenderTime 72ms CodeModel.GetById 3ms RepoModel.GetById 0ms app.codeStats 0ms

/docs/types/org/zeromq/ZFrame.html

http://github.com/rjsmith/hxzmq
HTML | 563 lines | 387 code | 5 blank | 171 comment | 0 complexity | ccba41258da111ae83d320cb4671de34 MD5 | raw file
Possible License(s): LGPL-3.0
  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/tr/html4/loose.dtd">
  2. <html>
  3. <head>
  4. <!-- Generated by chxdoc (build 606) on 2011-08-26 -->
  5. <title>ZFrame (Haxe Application)</title>
  6. <meta name="date" content="2011-08-26"/>
  7. <meta name="keywords" content="org.zeromq.ZFrame class"/>
  8. <link href="../../../stylesheet.css" type="text/css" rel="stylesheet"/>
  9. <script type="text/javascript">
  10. function windowTitle()
  11. {
  12. if (location.href.indexOf('is-external=true') == -1) {
  13. parent.document.title="ZFrame (Haxe Application)";
  14. }
  15. }
  16. </script>
  17. <noscript></noscript>
  18. </head>
  19. <body onload="windowTitle();">
  20. <script type="text/javascript" language="javascript" src="../../../chxdoc.js"></script>
  21. <div class="type-frame" id="class-frame">
  22. <!-- ======== START OF class DATA ======== -->
  23. <h1 class="class">org.zeromq.ZFrame</h1>
  24. <dl>
  25. <dt>type</dt>
  26. <dd>class</dd>
  27. <dt>available in</dt>
  28. <dd>cpp</dd>
  29. </dl>
  30. <div class="doc">
  31. <!-- Comment block -->
  32. <p>
  33. The ZFrame class provides methods to send and receive single message
  34. frames across 0MQ sockets. A 'frame' corresponds to one underlying zmq_msg_t in the libzmq code.
  35. When you read a frame from a socket, the more() method indicates if the frame is part of an
  36. unfinished multipart message. The send() method normally destroys the frame, but with the ZFRAME_REUSE flag, you can send
  37. the same frame many times. Frames are binary, and this class has no special support for text data.
  38. </p>
  39. <p>
  40. Based on <a href="http://github.com/zeromq/czmq/blob/master/src/zframe.c">zframe.c</a> in czmq
  41. </p>
  42. </div>
  43. <!-- ============ STATIC VAR DETAIL =========== -->
  44. <div class="members-panel">
  45. <h2><a name="static_var_detail"></a>Static Variables</h2>
  46. <div class="members">
  47. <div class="member">
  48. <div class="header">
  49. <h3>
  50. <a name="ZFRAME_MORE"></a>
  51. <span class="name">ZFRAME_MORE</span>(inline,null) : Int
  52. </h3>
  53. </div>
  54. <div class="body">
  55. <!-- platforms -->
  56. <dl>
  57. </dl>
  58. <!-- Comment block -->
  59. </div>
  60. </div>
  61. <div class="member">
  62. <div class="header">
  63. <h3>
  64. <a name="ZFRAME_REUSE"></a>
  65. <span class="name">ZFRAME_REUSE</span>(inline,null) : Int
  66. </h3>
  67. </div>
  68. <div class="body">
  69. <!-- platforms -->
  70. <dl>
  71. </dl>
  72. <!-- Comment block -->
  73. </div>
  74. </div>
  75. </div>
  76. </div>
  77. <!-- ============ STATIC METHOD DETAIL ========== -->
  78. <div class="members-panel">
  79. <h2><a name="function_detail"></a>Static Methods</h2>
  80. <div class="members">
  81. <div class="member">
  82. <div class="header">
  83. <h3>
  84. <a name="newStringFrame()"></a>
  85. <span class="name">newStringFrame</span>(str : String) : <a href="../../org/zeromq/ZFrame.html" class="type">ZFrame</a>
  86. </h3>
  87. </div>
  88. <div class="body">
  89. <dl>
  90. <!-- deprecated -->
  91. <!-- type params -->
  92. <!-- method call parameters -->
  93. <!-- method return types comments -->
  94. <!-- method throws -->
  95. <!-- requires -->
  96. <!-- see -->
  97. <!-- todo -->
  98. <!-- authors -->
  99. <!-- platforms -->
  100. </dl>
  101. <!-- Comment block -->
  102. <div class="comment">
  103. Creates a new ZFrame object from a given string.
  104. Can be used in combination with send method for a one-line command:
  105. <pre>
  106. import org.zeromq.ZFrame;
  107. using org.zeromq.ZFrame;
  108. ...
  109. ZFrame.newStringFrame("Hello".send(mySocket));
  110. var str = "World";
  111. str.newStringFrame().send(mySocket);
  112. </pre>
  113. </div>
  114. </div>
  115. </div>
  116. <div class="member">
  117. <div class="header">
  118. <h3>
  119. <a name="recvFrame()"></a>
  120. <span class="name">recvFrame</span>(socket : <a href="../../org/zeromq/ZMQSocket.html" class="type">ZMQSocket</a>) : <a href="../../org/zeromq/ZFrame.html" class="type">ZFrame</a>
  121. </h3>
  122. </div>
  123. <div class="body">
  124. <dl>
  125. <!-- deprecated -->
  126. <!-- type params -->
  127. <!-- method call parameters -->
  128. <dt>parameters</dt>
  129. <dd><code>socket</code> Socket to read from</dd>
  130. <!-- method return types comments -->
  131. <dt>returns</dt>
  132. <dd>received frame, else null</dd>
  133. <!-- method throws -->
  134. <!-- requires -->
  135. <!-- see -->
  136. <!-- todo -->
  137. <!-- authors -->
  138. <!-- platforms -->
  139. </dl>
  140. <!-- Comment block -->
  141. <div class="comment">
  142. Receives single frame from socket, returns the received frame object, or null if the recv
  143. was interrupted. Does a blocking recv, if you want to not block then use
  144. recvFrameNoWait()
  145. </div>
  146. </div>
  147. </div>
  148. <div class="member">
  149. <div class="header">
  150. <h3>
  151. <a name="recvFrameNoWait()"></a>
  152. <span class="name">recvFrameNoWait</span>(socket : <a href="../../org/zeromq/ZMQSocket.html" class="type">ZMQSocket</a>) : <a href="../../org/zeromq/ZFrame.html" class="type">ZFrame</a>
  153. </h3>
  154. </div>
  155. <div class="body">
  156. <dl>
  157. <!-- deprecated -->
  158. <!-- type params -->
  159. <!-- method call parameters -->
  160. <dt>parameters</dt>
  161. <dd><code>socket</code> </dd>
  162. <!-- method return types comments -->
  163. <dt>returns</dt>
  164. <dd>received frame, else null</dd>
  165. <!-- method throws -->
  166. <!-- requires -->
  167. <!-- see -->
  168. <!-- todo -->
  169. <!-- authors -->
  170. <!-- platforms -->
  171. </dl>
  172. <!-- Comment block -->
  173. <div class="comment">
  174. Receive a new frame off the socket, Returns newly-allocated frame, or
  175. null if there was no input waiting, or if the read was interrupted.</div>
  176. </div>
  177. </div>
  178. </div>
  179. </div>
  180. <!-- ========= CONSTRUCTOR DETAIL ======== -->
  181. <div class="members-panel">
  182. <h2><a name="constructor_detail"></a>Constructor</h2>
  183. <div class="members">
  184. <div class="member">
  185. <div class="header">
  186. <a name="new()"></a>
  187. <span class="name">new</span>(?data : haxe.io.Bytes)
  188. </div>
  189. <div class="body">
  190. <dl>
  191. <!-- deprecated -->
  192. <!-- type params -->
  193. <!-- method call parameters -->
  194. <dt>parameters</dt>
  195. <dd><code>data</code> </dd>
  196. <!-- method return types comments -->
  197. <!-- method throws -->
  198. <!-- requires -->
  199. <!-- see -->
  200. <!-- todo -->
  201. <!-- authors -->
  202. <!-- platforms -->
  203. </dl>
  204. <!-- Comment block -->
  205. <div class="comment">
  206. Constructor.
  207. Copies message data into zframe object</div>
  208. </div>
  209. </div>
  210. </div>
  211. </div>
  212. <!-- ============ FIELD field_detail =========== -->
  213. <div class="members-panel">
  214. <h2><a name="member_var_detail"></a>Instance Variables
  215. </h2>
  216. <div class="members">
  217. <span class="showVar">
  218. <div class="member">
  219. <div class="header">
  220. <h3>
  221. <a name="data"></a>
  222. <span class="name">data</span>(default,null) : haxe.io.Bytes
  223. </h3>
  224. </div>
  225. <div class="body">
  226. <!-- platforms -->
  227. <dl>
  228. </dl>
  229. <!-- Comment block -->
  230. <div class="comment"> Message blob for frame</div>
  231. </div>
  232. </div>
  233. </span>
  234. <span class="showVar">
  235. <div class="member">
  236. <div class="header">
  237. <h3>
  238. <a name="more"></a>
  239. <span class="name">more</span>(default,null) : Bool
  240. </h3>
  241. </div>
  242. <div class="body">
  243. <!-- platforms -->
  244. <dl>
  245. </dl>
  246. <!-- Comment block -->
  247. <div class="comment"> More flag, from last frame read</div>
  248. </div>
  249. </div>
  250. </span>
  251. </div>
  252. </div>
  253. <!-- ============ METHOD DETAIL ========== -->
  254. <div class="members-panel">
  255. <h2><a name="method_detail"></a>Instance Methods
  256. </h2>
  257. <div class="members">
  258. <span class="showMethod">
  259. <div class="member">
  260. <div class="header">
  261. <h3>
  262. <a name="destroy()"></a>
  263. <span class="name">destroy</span>() : Void
  264. </h3>
  265. </div>
  266. <div class="body">
  267. <dl>
  268. <!-- deprecated -->
  269. <!-- type params -->
  270. <!-- method call parameters -->
  271. <!-- method return types comments -->
  272. <!-- method throws -->
  273. <!-- requires -->
  274. <!-- see -->
  275. <!-- todo -->
  276. <!-- authors -->
  277. <!-- platforms -->
  278. </dl>
  279. <!-- Comment block -->
  280. <div class="comment">
  281. Destructor
  282. </div>
  283. </div>
  284. </div>
  285. </span>
  286. <span class="showMethod">
  287. <div class="member">
  288. <div class="header">
  289. <h3>
  290. <a name="duplicate()"></a>
  291. <span class="name">duplicate</span>() : <a href="../../org/zeromq/ZFrame.html" class="type">ZFrame</a>
  292. </h3>
  293. </div>
  294. <div class="body">
  295. <dl>
  296. <!-- deprecated -->
  297. <!-- type params -->
  298. <!-- method call parameters -->
  299. <!-- method return types comments -->
  300. <dt>returns</dt>
  301. <dd>A duplicates ZFrame object</dd>
  302. <!-- method throws -->
  303. <!-- requires -->
  304. <!-- see -->
  305. <!-- todo -->
  306. <!-- authors -->
  307. <!-- platforms -->
  308. </dl>
  309. <!-- Comment block -->
  310. <div class="comment">
  311. Creates a new frame that duplicates an existing frame</div>
  312. </div>
  313. </div>
  314. </span>
  315. <span class="showMethod">
  316. <div class="member">
  317. <div class="header">
  318. <h3>
  319. <a name="equals()"></a>
  320. <span class="name">equals</span>(other : <a href="../../org/zeromq/ZFrame.html" class="type">ZFrame</a>) : Bool
  321. </h3>
  322. </div>
  323. <div class="body">
  324. <dl>
  325. <!-- deprecated -->
  326. <!-- type params -->
  327. <!-- method call parameters -->
  328. <dt>parameters</dt>
  329. <dd><code>other</code> </dd>
  330. <!-- method return types comments -->
  331. <dt>returns</dt>
  332. <dd></dd>
  333. <!-- method throws -->
  334. <!-- requires -->
  335. <!-- see -->
  336. <!-- todo -->
  337. <!-- authors -->
  338. <!-- platforms -->
  339. </dl>
  340. <!-- Comment block -->
  341. <div class="comment">
  342. Returns true if both frames have identical size and data</div>
  343. </div>
  344. </div>
  345. </span>
  346. <span class="showMethod">
  347. <div class="member">
  348. <div class="header">
  349. <h3>
  350. <a name="hasData()"></a>
  351. <span class="name">hasData</span>() : Bool
  352. </h3>
  353. </div>
  354. <div class="body">
  355. <dl>
  356. <!-- deprecated -->
  357. <!-- type params -->
  358. <!-- method call parameters -->
  359. <!-- method return types comments -->
  360. <dt>returns</dt>
  361. <dd></dd>
  362. <!-- method throws -->
  363. <!-- requires -->
  364. <!-- see -->
  365. <!-- todo -->
  366. <!-- authors -->
  367. <!-- platforms -->
  368. </dl>
  369. <!-- Comment block -->
  370. <div class="comment">
  371. Convenience method to ascertain if this frame contains some message data</div>
  372. </div>
  373. </div>
  374. </span>
  375. <span class="showMethod">
  376. <div class="member">
  377. <div class="header">
  378. <h3>
  379. <a name="reset()"></a>
  380. <span class="name">reset</span>(data : haxe.io.Bytes) : Void
  381. </h3>
  382. </div>
  383. <div class="body">
  384. <dl>
  385. <!-- deprecated -->
  386. <!-- type params -->
  387. <!-- method call parameters -->
  388. <dt>parameters</dt>
  389. <dd><code>data</code> New data bytes for this frame</dd>
  390. <!-- method return types comments -->
  391. <!-- method throws -->
  392. <!-- requires -->
  393. <!-- see -->
  394. <!-- todo -->
  395. <!-- authors -->
  396. <!-- platforms -->
  397. </dl>
  398. <!-- Comment block -->
  399. <div class="comment">
  400. Set new contents for frame</div>
  401. </div>
  402. </div>
  403. </span>
  404. <span class="showMethod">
  405. <div class="member">
  406. <div class="header">
  407. <h3>
  408. <a name="send()"></a>
  409. <span class="name">send</span>(socket : <a href="../../org/zeromq/ZMQSocket.html" class="type">ZMQSocket</a>, ?flags : Int) : Void
  410. </h3>
  411. </div>
  412. <div class="body">
  413. <dl>
  414. <!-- deprecated -->
  415. <!-- type params -->
  416. <!-- method call parameters -->
  417. <dt>parameters</dt>
  418. <dd><code>socket</code> </dd>
  419. <dd><code>flags</code> </dd>
  420. <!-- method return types comments -->
  421. <!-- method throws -->
  422. <!-- requires -->
  423. <!-- see -->
  424. <!-- todo -->
  425. <!-- authors -->
  426. <!-- platforms -->
  427. </dl>
  428. <!-- Comment block -->
  429. <div class="comment">
  430. Sends frame to socket, destroy after sending unless ZFRAME_REUSE is set</div>
  431. </div>
  432. </div>
  433. </span>
  434. <span class="showMethod">
  435. <div class="member">
  436. <div class="header">
  437. <h3>
  438. <a name="size()"></a>
  439. <span class="inline">inline</span>
  440. <span class="name">size</span>() : Int
  441. </h3>
  442. </div>
  443. <div class="body">
  444. <dl>
  445. <!-- deprecated -->
  446. <!-- type params -->
  447. <!-- method call parameters -->
  448. <!-- method return types comments -->
  449. <dt>returns</dt>
  450. <dd></dd>
  451. <!-- method throws -->
  452. <!-- requires -->
  453. <!-- see -->
  454. <!-- todo -->
  455. <!-- authors -->
  456. <!-- platforms -->
  457. </dl>
  458. <!-- Comment block -->
  459. <div class="comment">
  460. Returns byte size of frame, if set, else 0</div>
  461. </div>
  462. </div>
  463. </span>
  464. <span class="showMethod">
  465. <div class="member">
  466. <div class="header">
  467. <h3>
  468. <a name="streq()"></a>
  469. <span class="name">streq</span>(str : String) : Bool
  470. </h3>
  471. </div>
  472. <div class="body">
  473. <dl>
  474. <!-- deprecated -->
  475. <!-- type params -->
  476. <!-- method call parameters -->
  477. <dt>parameters</dt>
  478. <dd><code>str</code> </dd>
  479. <!-- method return types comments -->
  480. <dt>returns</dt>
  481. <dd>true if matches, else false</dd>
  482. <!-- method throws -->
  483. <!-- requires -->
  484. <!-- see -->
  485. <!-- todo -->
  486. <!-- authors -->
  487. <!-- platforms -->
  488. </dl>
  489. <!-- Comment block -->
  490. <div class="comment">
  491. Returns true if frame body is equivalent to given string</div>
  492. </div>
  493. </div>
  494. </span>
  495. <span class="showMethod">
  496. <div class="member">
  497. <div class="header">
  498. <h3>
  499. <a name="strhex()"></a>
  500. <span class="name">strhex</span>() : String
  501. </h3>
  502. </div>
  503. <div class="body">
  504. <dl>
  505. <!-- deprecated -->
  506. <!-- type params -->
  507. <!-- method call parameters -->
  508. <!-- method return types comments -->
  509. <dt>returns</dt>
  510. <dd></dd>
  511. <!-- method throws -->
  512. <!-- requires -->
  513. <!-- see -->
  514. <!-- todo -->
  515. <!-- authors -->
  516. <!-- platforms -->
  517. </dl>
  518. <!-- Comment block -->
  519. <div class="comment">
  520. Return frame data encoded as printable hex string</div>
  521. </div>
  522. </div>
  523. </span>
  524. <span class="showMethod">
  525. <div class="member">
  526. <div class="header">
  527. <h3>
  528. <a name="toString()"></a>
  529. <span class="name">toString</span>() : String
  530. </h3>
  531. </div>
  532. <div class="body">
  533. <dl>
  534. <!-- deprecated -->
  535. <!-- type params -->
  536. <!-- method call parameters -->
  537. <!-- method return types comments -->
  538. <dt>returns</dt>
  539. <dd></dd>
  540. <!-- method throws -->
  541. <!-- requires -->
  542. <!-- see -->
  543. <!-- todo -->
  544. <!-- authors -->
  545. <!-- platforms -->
  546. </dl>
  547. <!-- Comment block -->
  548. <div class="comment">
  549. Returns string representation of frame's data bytes</div>
  550. </div>
  551. </div>
  552. </span>
  553. </div>
  554. </div>
  555. </div>
  556. <!-- ========= END OF class DATA ========= -->
  557. </body>
  558. </html>