/docs/types/org/zeromq/ZFrame.html
HTML | 563 lines | 387 code | 5 blank | 171 comment | 0 complexity | ccba41258da111ae83d320cb4671de34 MD5 | raw file
Possible License(s): LGPL-3.0
- <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/tr/html4/loose.dtd">
- <html>
- <head>
- <!-- Generated by chxdoc (build 606) on 2011-08-26 -->
- <title>ZFrame (Haxe Application)</title>
- <meta name="date" content="2011-08-26"/>
- <meta name="keywords" content="org.zeromq.ZFrame class"/>
- <link href="../../../stylesheet.css" type="text/css" rel="stylesheet"/>
- <script type="text/javascript">
- function windowTitle()
- {
- if (location.href.indexOf('is-external=true') == -1) {
- parent.document.title="ZFrame (Haxe Application)";
- }
- }
- </script>
- <noscript></noscript>
- </head>
- <body onload="windowTitle();">
- <script type="text/javascript" language="javascript" src="../../../chxdoc.js"></script>
- <div class="type-frame" id="class-frame">
- <!-- ======== START OF class DATA ======== -->
- <h1 class="class">org.zeromq.ZFrame</h1>
- <dl>
- <dt>type</dt>
- <dd>class</dd>
- <dt>available in</dt>
- <dd>cpp</dd>
- </dl>
- <div class="doc">
- <!-- Comment block -->
-
- <p>
- The ZFrame class provides methods to send and receive single message
- frames across 0MQ sockets. A 'frame' corresponds to one underlying zmq_msg_t in the libzmq code.
- When you read a frame from a socket, the more() method indicates if the frame is part of an
- unfinished multipart message. The send() method normally destroys the frame, but with the ZFRAME_REUSE flag, you can send
- the same frame many times. Frames are binary, and this class has no special support for text data.
- </p>
- <p>
- Based on <a href="http://github.com/zeromq/czmq/blob/master/src/zframe.c">zframe.c</a> in czmq
- </p>
- </div>
- <!-- ============ STATIC VAR DETAIL =========== -->
- <div class="members-panel">
- <h2><a name="static_var_detail"></a>Static Variables</h2>
- <div class="members">
- <div class="member">
- <div class="header">
- <h3>
- <a name="ZFRAME_MORE"></a>
- <span class="name">ZFRAME_MORE</span>(inline,null) : Int
- </h3>
- </div>
- <div class="body">
- <!-- platforms -->
- <dl>
- </dl>
- <!-- Comment block -->
- </div>
- </div>
- <div class="member">
- <div class="header">
- <h3>
- <a name="ZFRAME_REUSE"></a>
- <span class="name">ZFRAME_REUSE</span>(inline,null) : Int
- </h3>
- </div>
- <div class="body">
- <!-- platforms -->
- <dl>
- </dl>
- <!-- Comment block -->
- </div>
- </div>
- </div>
- </div>
- <!-- ============ STATIC METHOD DETAIL ========== -->
- <div class="members-panel">
- <h2><a name="function_detail"></a>Static Methods</h2>
- <div class="members">
- <div class="member">
- <div class="header">
- <h3>
- <a name="newStringFrame()"></a>
- <span class="name">newStringFrame</span>(str : String) : <a href="../../org/zeromq/ZFrame.html" class="type">ZFrame</a>
- </h3>
- </div>
- <div class="body">
- <dl>
- <!-- deprecated -->
- <!-- type params -->
- <!-- method call parameters -->
- <!-- method return types comments -->
- <!-- method throws -->
- <!-- requires -->
- <!-- see -->
- <!-- todo -->
- <!-- authors -->
- <!-- platforms -->
- </dl>
- <!-- Comment block -->
- <div class="comment">
- Creates a new ZFrame object from a given string.
- Can be used in combination with send method for a one-line command:
- <pre>
- import org.zeromq.ZFrame;
- using org.zeromq.ZFrame;
- ...
- ZFrame.newStringFrame("Hello".send(mySocket));
- var str = "World";
- str.newStringFrame().send(mySocket);
- </pre>
- </div>
- </div>
- </div>
- <div class="member">
- <div class="header">
- <h3>
- <a name="recvFrame()"></a>
- <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>
- </h3>
- </div>
- <div class="body">
- <dl>
- <!-- deprecated -->
- <!-- type params -->
- <!-- method call parameters -->
- <dt>parameters</dt>
- <dd><code>socket</code> Socket to read from</dd>
- <!-- method return types comments -->
- <dt>returns</dt>
- <dd>received frame, else null</dd>
- <!-- method throws -->
- <!-- requires -->
- <!-- see -->
- <!-- todo -->
- <!-- authors -->
- <!-- platforms -->
- </dl>
- <!-- Comment block -->
- <div class="comment">
- Receives single frame from socket, returns the received frame object, or null if the recv
- was interrupted. Does a blocking recv, if you want to not block then use
- recvFrameNoWait()
- </div>
- </div>
- </div>
- <div class="member">
- <div class="header">
- <h3>
- <a name="recvFrameNoWait()"></a>
- <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>
- </h3>
- </div>
- <div class="body">
- <dl>
- <!-- deprecated -->
- <!-- type params -->
- <!-- method call parameters -->
- <dt>parameters</dt>
- <dd><code>socket</code> </dd>
- <!-- method return types comments -->
- <dt>returns</dt>
- <dd>received frame, else null</dd>
- <!-- method throws -->
- <!-- requires -->
- <!-- see -->
- <!-- todo -->
- <!-- authors -->
- <!-- platforms -->
- </dl>
- <!-- Comment block -->
- <div class="comment">
- Receive a new frame off the socket, Returns newly-allocated frame, or
- null if there was no input waiting, or if the read was interrupted.</div>
- </div>
- </div>
- </div>
- </div>
- <!-- ========= CONSTRUCTOR DETAIL ======== -->
- <div class="members-panel">
- <h2><a name="constructor_detail"></a>Constructor</h2>
- <div class="members">
- <div class="member">
- <div class="header">
- <a name="new()"></a>
- <span class="name">new</span>(?data : haxe.io.Bytes)
- </div>
- <div class="body">
- <dl>
- <!-- deprecated -->
- <!-- type params -->
- <!-- method call parameters -->
- <dt>parameters</dt>
- <dd><code>data</code> </dd>
- <!-- method return types comments -->
- <!-- method throws -->
- <!-- requires -->
- <!-- see -->
- <!-- todo -->
- <!-- authors -->
- <!-- platforms -->
- </dl>
- <!-- Comment block -->
- <div class="comment">
- Constructor.
- Copies message data into zframe object</div>
- </div>
- </div>
- </div>
- </div>
- <!-- ============ FIELD field_detail =========== -->
- <div class="members-panel">
- <h2><a name="member_var_detail"></a>Instance Variables
- </h2>
- <div class="members">
- <span class="showVar">
- <div class="member">
- <div class="header">
- <h3>
- <a name="data"></a>
- <span class="name">data</span>(default,null) : haxe.io.Bytes
- </h3>
- </div>
- <div class="body">
- <!-- platforms -->
- <dl>
- </dl>
- <!-- Comment block -->
- <div class="comment"> Message blob for frame</div>
- </div>
- </div>
- </span>
- <span class="showVar">
- <div class="member">
- <div class="header">
- <h3>
- <a name="more"></a>
- <span class="name">more</span>(default,null) : Bool
- </h3>
- </div>
- <div class="body">
- <!-- platforms -->
- <dl>
- </dl>
- <!-- Comment block -->
- <div class="comment"> More flag, from last frame read</div>
- </div>
- </div>
- </span>
- </div>
- </div>
- <!-- ============ METHOD DETAIL ========== -->
- <div class="members-panel">
- <h2><a name="method_detail"></a>Instance Methods
- </h2>
- <div class="members">
- <span class="showMethod">
- <div class="member">
- <div class="header">
- <h3>
- <a name="destroy()"></a>
- <span class="name">destroy</span>() : Void
- </h3>
- </div>
- <div class="body">
- <dl>
- <!-- deprecated -->
- <!-- type params -->
- <!-- method call parameters -->
- <!-- method return types comments -->
- <!-- method throws -->
- <!-- requires -->
- <!-- see -->
- <!-- todo -->
- <!-- authors -->
- <!-- platforms -->
- </dl>
- <!-- Comment block -->
- <div class="comment">
- Destructor
- </div>
- </div>
- </div>
- </span>
- <span class="showMethod">
- <div class="member">
- <div class="header">
- <h3>
- <a name="duplicate()"></a>
- <span class="name">duplicate</span>() : <a href="../../org/zeromq/ZFrame.html" class="type">ZFrame</a>
- </h3>
- </div>
- <div class="body">
- <dl>
- <!-- deprecated -->
- <!-- type params -->
- <!-- method call parameters -->
- <!-- method return types comments -->
- <dt>returns</dt>
- <dd>A duplicates ZFrame object</dd>
- <!-- method throws -->
- <!-- requires -->
- <!-- see -->
- <!-- todo -->
- <!-- authors -->
- <!-- platforms -->
- </dl>
- <!-- Comment block -->
- <div class="comment">
- Creates a new frame that duplicates an existing frame</div>
- </div>
- </div>
- </span>
- <span class="showMethod">
- <div class="member">
- <div class="header">
- <h3>
- <a name="equals()"></a>
- <span class="name">equals</span>(other : <a href="../../org/zeromq/ZFrame.html" class="type">ZFrame</a>) : Bool
- </h3>
- </div>
- <div class="body">
- <dl>
- <!-- deprecated -->
- <!-- type params -->
- <!-- method call parameters -->
- <dt>parameters</dt>
- <dd><code>other</code> </dd>
- <!-- method return types comments -->
- <dt>returns</dt>
- <dd></dd>
- <!-- method throws -->
- <!-- requires -->
- <!-- see -->
- <!-- todo -->
- <!-- authors -->
- <!-- platforms -->
- </dl>
- <!-- Comment block -->
- <div class="comment">
- Returns true if both frames have identical size and data</div>
- </div>
- </div>
- </span>
- <span class="showMethod">
- <div class="member">
- <div class="header">
- <h3>
- <a name="hasData()"></a>
- <span class="name">hasData</span>() : Bool
- </h3>
- </div>
- <div class="body">
- <dl>
- <!-- deprecated -->
- <!-- type params -->
- <!-- method call parameters -->
- <!-- method return types comments -->
- <dt>returns</dt>
- <dd></dd>
- <!-- method throws -->
- <!-- requires -->
- <!-- see -->
- <!-- todo -->
- <!-- authors -->
- <!-- platforms -->
- </dl>
- <!-- Comment block -->
- <div class="comment">
- Convenience method to ascertain if this frame contains some message data</div>
- </div>
- </div>
- </span>
- <span class="showMethod">
- <div class="member">
- <div class="header">
- <h3>
- <a name="reset()"></a>
- <span class="name">reset</span>(data : haxe.io.Bytes) : Void
- </h3>
- </div>
- <div class="body">
- <dl>
- <!-- deprecated -->
- <!-- type params -->
- <!-- method call parameters -->
- <dt>parameters</dt>
- <dd><code>data</code> New data bytes for this frame</dd>
- <!-- method return types comments -->
- <!-- method throws -->
- <!-- requires -->
- <!-- see -->
- <!-- todo -->
- <!-- authors -->
- <!-- platforms -->
- </dl>
- <!-- Comment block -->
- <div class="comment">
- Set new contents for frame</div>
- </div>
- </div>
- </span>
- <span class="showMethod">
- <div class="member">
- <div class="header">
- <h3>
- <a name="send()"></a>
- <span class="name">send</span>(socket : <a href="../../org/zeromq/ZMQSocket.html" class="type">ZMQSocket</a>, ?flags : Int) : Void
- </h3>
- </div>
- <div class="body">
- <dl>
- <!-- deprecated -->
- <!-- type params -->
- <!-- method call parameters -->
- <dt>parameters</dt>
- <dd><code>socket</code> </dd>
- <dd><code>flags</code> </dd>
- <!-- method return types comments -->
- <!-- method throws -->
- <!-- requires -->
- <!-- see -->
- <!-- todo -->
- <!-- authors -->
- <!-- platforms -->
- </dl>
- <!-- Comment block -->
- <div class="comment">
- Sends frame to socket, destroy after sending unless ZFRAME_REUSE is set</div>
- </div>
- </div>
- </span>
- <span class="showMethod">
- <div class="member">
- <div class="header">
- <h3>
- <a name="size()"></a>
- <span class="inline">inline</span>
- <span class="name">size</span>() : Int
- </h3>
- </div>
- <div class="body">
- <dl>
- <!-- deprecated -->
- <!-- type params -->
- <!-- method call parameters -->
- <!-- method return types comments -->
- <dt>returns</dt>
- <dd></dd>
- <!-- method throws -->
- <!-- requires -->
- <!-- see -->
- <!-- todo -->
- <!-- authors -->
- <!-- platforms -->
- </dl>
- <!-- Comment block -->
- <div class="comment">
- Returns byte size of frame, if set, else 0</div>
- </div>
- </div>
- </span>
- <span class="showMethod">
- <div class="member">
- <div class="header">
- <h3>
- <a name="streq()"></a>
- <span class="name">streq</span>(str : String) : Bool
- </h3>
- </div>
- <div class="body">
- <dl>
- <!-- deprecated -->
- <!-- type params -->
- <!-- method call parameters -->
- <dt>parameters</dt>
- <dd><code>str</code> </dd>
- <!-- method return types comments -->
- <dt>returns</dt>
- <dd>true if matches, else false</dd>
- <!-- method throws -->
- <!-- requires -->
- <!-- see -->
- <!-- todo -->
- <!-- authors -->
- <!-- platforms -->
- </dl>
- <!-- Comment block -->
- <div class="comment">
- Returns true if frame body is equivalent to given string</div>
- </div>
- </div>
- </span>
- <span class="showMethod">
- <div class="member">
- <div class="header">
- <h3>
- <a name="strhex()"></a>
- <span class="name">strhex</span>() : String
- </h3>
- </div>
- <div class="body">
- <dl>
- <!-- deprecated -->
- <!-- type params -->
- <!-- method call parameters -->
- <!-- method return types comments -->
- <dt>returns</dt>
- <dd></dd>
- <!-- method throws -->
- <!-- requires -->
- <!-- see -->
- <!-- todo -->
- <!-- authors -->
- <!-- platforms -->
- </dl>
- <!-- Comment block -->
- <div class="comment">
- Return frame data encoded as printable hex string</div>
- </div>
- </div>
- </span>
- <span class="showMethod">
- <div class="member">
- <div class="header">
- <h3>
- <a name="toString()"></a>
- <span class="name">toString</span>() : String
- </h3>
- </div>
- <div class="body">
- <dl>
- <!-- deprecated -->
- <!-- type params -->
- <!-- method call parameters -->
- <!-- method return types comments -->
- <dt>returns</dt>
- <dd></dd>
- <!-- method throws -->
- <!-- requires -->
- <!-- see -->
- <!-- todo -->
- <!-- authors -->
- <!-- platforms -->
- </dl>
- <!-- Comment block -->
- <div class="comment">
- Returns string representation of frame's data bytes</div>
- </div>
- </div>
- </span>
- </div>
- </div>
- </div>
- <!-- ========= END OF class DATA ========= -->
-
- </body>
- </html>