From 26c0938350bcbefb5c7afc69c7098cbc6de2a79a Mon Sep 17 00:00:00 2001 From: Richard Smith Date: Mon, 27 Jun 2011 17:40:19 +0100 Subject: [PATCH] Added generated haXe class documentation Using the chxdoc haxe project (haxelib install chxdoc), added auto-generated API documentation. To generate, run the builddocs.sh shell script (on linux or Mac) --- buildDocs.hxml | 11 + builddocs.sh | 8 + docs/all_classes.html | 36 + docs/all_packages.html | 28 + docs/chxdoc.js | 64 + docs/cpp.xml | 2962 +++++++++++++++++ docs/images/alias.png | Bin 0 -> 549 bytes docs/images/alltypes.png | Bin 0 -> 797 bytes docs/images/bginherited.png | Bin 0 -> 985 bytes docs/images/class.png | Bin 0 -> 705 bytes docs/images/enum.png | Bin 0 -> 292 bytes docs/images/hide.png | Bin 0 -> 183 bytes docs/images/interface.png | Bin 0 -> 523 bytes docs/images/overview.png | Bin 0 -> 688 bytes docs/images/package.png | Bin 0 -> 567 bytes docs/images/show.png | Bin 0 -> 214 bytes docs/images/todo.png | Bin 0 -> 457 bytes docs/images/todobullet.png | Bin 0 -> 347 bytes docs/images/typedef.png | Bin 0 -> 561 bytes docs/index.html | 13 + docs/overview.html | 16 + docs/packages/org/zeromq/package.html | 44 + .../packages/org/zeromq/remoting/package.html | 24 + docs/stylesheet.css | 319 ++ docs/types/org/zeromq/ErrorType.html | 225 ++ docs/types/org/zeromq/PollResult.html | 74 + .../org/zeromq/PollSocketEventTuple.html | 74 + .../types/org/zeromq/SendReceiveFlagType.html | 71 + docs/types/org/zeromq/SocketOptionsType.html | 270 ++ docs/types/org/zeromq/SocketType.html | 148 + docs/types/org/zeromq/ZMQ.html | 562 ++++ docs/types/org/zeromq/ZMQContext.html | 212 ++ docs/types/org/zeromq/ZMQException.html | 151 + docs/types/org/zeromq/ZMQInt64Type.html | 78 + docs/types/org/zeromq/ZMQPoller.html | 339 ++ docs/types/org/zeromq/ZMQSocket.html | 412 +++ .../org/zeromq/remoting/ZMQConnection.html | 200 ++ .../zeromq/remoting/ZMQSocketProtocol.html | 248 ++ org/zeromq/IncludeAll.hx | 33 + 39 files changed, 6622 insertions(+) create mode 100644 buildDocs.hxml create mode 100755 builddocs.sh create mode 100644 docs/all_classes.html create mode 100644 docs/all_packages.html create mode 100644 docs/chxdoc.js create mode 100644 docs/cpp.xml create mode 100644 docs/images/alias.png create mode 100644 docs/images/alltypes.png create mode 100644 docs/images/bginherited.png create mode 100644 docs/images/class.png create mode 100644 docs/images/enum.png create mode 100644 docs/images/hide.png create mode 100644 docs/images/interface.png create mode 100644 docs/images/overview.png create mode 100644 docs/images/package.png create mode 100644 docs/images/show.png create mode 100644 docs/images/todo.png create mode 100644 docs/images/todobullet.png create mode 100644 docs/images/typedef.png create mode 100644 docs/index.html create mode 100644 docs/overview.html create mode 100644 docs/packages/org/zeromq/package.html create mode 100644 docs/packages/org/zeromq/remoting/package.html create mode 100644 docs/stylesheet.css create mode 100644 docs/types/org/zeromq/ErrorType.html create mode 100644 docs/types/org/zeromq/PollResult.html create mode 100644 docs/types/org/zeromq/PollSocketEventTuple.html create mode 100644 docs/types/org/zeromq/SendReceiveFlagType.html create mode 100644 docs/types/org/zeromq/SocketOptionsType.html create mode 100644 docs/types/org/zeromq/SocketType.html create mode 100644 docs/types/org/zeromq/ZMQ.html create mode 100644 docs/types/org/zeromq/ZMQContext.html create mode 100644 docs/types/org/zeromq/ZMQException.html create mode 100644 docs/types/org/zeromq/ZMQInt64Type.html create mode 100644 docs/types/org/zeromq/ZMQPoller.html create mode 100644 docs/types/org/zeromq/ZMQSocket.html create mode 100644 docs/types/org/zeromq/remoting/ZMQConnection.html create mode 100644 docs/types/org/zeromq/remoting/ZMQSocketProtocol.html create mode 100644 org/zeromq/IncludeAll.hx diff --git a/buildDocs.hxml b/buildDocs.hxml new file mode 100644 index 0000000..5e80313 --- /dev/null +++ b/buildDocs.hxml @@ -0,0 +1,11 @@ +# haXe build file for class documentation +#cpp +-cp . +-cpp out-cpp/Mac64 +--no-output +-D HXCPP_MULTI_THREADED +-D HXCPP_M64 +--remap neko:cpp +-xml docs/cpp.xml +org.zeromq.IncludeAll + diff --git a/builddocs.sh b/builddocs.sh new file mode 100755 index 0000000..05b8381 --- /dev/null +++ b/builddocs.sh @@ -0,0 +1,8 @@ +#!/bin/bash + +echo "** Build documentation:" +haxe buildDocs.hxml + +chxdoc -o docs --developer=false --includeOnly=org.zeromq.* docs/cpp.xml,cpp + +rm -r tmp diff --git a/docs/all_classes.html b/docs/all_classes.html new file mode 100644 index 0000000..7958678 --- /dev/null +++ b/docs/all_classes.html @@ -0,0 +1,36 @@ + + + + + All Types Haxe Application + + + + + +
+

All Types

+ +
+ + \ No newline at end of file diff --git a/docs/all_packages.html b/docs/all_packages.html new file mode 100644 index 0000000..c38fbff --- /dev/null +++ b/docs/all_packages.html @@ -0,0 +1,28 @@ + + + + + Packages List Haxe Application + + + + + +
+

Haxe Application

+

http://www.haxe.org/

+
+ +
+ +
+ + \ No newline at end of file diff --git a/docs/chxdoc.js b/docs/chxdoc.js new file mode 100644 index 0000000..c0611fa --- /dev/null +++ b/docs/chxdoc.js @@ -0,0 +1,64 @@ + +function showInherited(name, visibile) { + //if IE + // document.styleSheets[0].rules + var r = document.styleSheets[0].cssRules; + if(r == undefined) { + document.styleSheets[0].addRule(".hideInherited" + name, visibile ? "display:inline" : "display:none"); + document.styleSheets[0].addRule(".showInherited" + name, visibile ? "display:none" : "display:inline"); + } + else { + for (var i = 0; i < r.length; i++) { + if (r[i].selectorText == ".hideInherited" + name) + r[i].style.display = visibile ? "inline" : "none"; + if (r[i].selectorText == ".showInherited" + name) + r[i].style.display = visibile ? "none" : "inline"; + } + } + + setCookie( + "showInherited" + name, + visibile ? "true" : "false", + 10000, + "/", + document.location.domain); +} + +function initShowInherited() { + showInherited("Var", getCookie("showInheritedVar") == "true"); + showInherited("Method", getCookie("showInheritedMethod") == "true"); +} + +function setCookie(name, value, days, path, domain, secure) { + var endDate=new Date(); + endDate.setDate(endDate.getDate() + days); + + document.cookie = + name + "=" + escape(value) + + ((days==null) ? "" : ";expires=" + endDate.toGMTString()) + + ((path) ? "; path=" + path : "") + + ((domain) ? "; domain=" + domain : "") + + ((secure) ? "; secure" : ""); +} + +function getCookie(name) { + if (document.cookie.length>0) { + begin=document.cookie.indexOf(name + "="); + if (begin != -1) { + begin = begin + name.length + 1; + end = document.cookie.indexOf(";",begin); + if(end==-1) + end=document.cookie.length; + return unescape(document.cookie.substring(begin,end)); + } + } + return ""; +} + +function isIE() { + if(navigator.appName.indexOf("Microsoft") != -1) + return true; + return false; +} + +initShowInherited(); \ No newline at end of file diff --git a/docs/cpp.xml b/docs/cpp.xml new file mode 100644 index 0000000..9373ff0 --- /dev/null +++ b/docs/cpp.xml @@ -0,0 +1,2962 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + <__path> + <__data> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + * This class provides a haXe remoting adapter using the zeroMQ message + * library (via hxzmq) as the transport layer + + + + + + + + + + + + + + + * Enumeration of 0MQ socket types + + + + + + + + + + + + + + + + + + + + + * Enumeration of 0MQ error types + + + + + + + * Enumeration of 0MQ send and receive flags + + + + + + + + + + + + + + + + + + + + + + + + + * Enumeration of 0MQ socket types + * See: http://api.zeromq.org/master:zmq-setsockopt + + + + + + + + + * Used to pass 64 bit ints to setlongsockopt + + + + + + + + + + + + Load and return a Cpp primitive from a DLL library. + + + + + + + + + + + Tries to load, and always returns a valid function, but the function may throw + if called. + + + + + + + + + + + + + + + + + Print the specified value on the default output. + + + + + + + + + This function is used to make porting from neko to cpp easy. + It does not need to do anything because the c-code can work with any Dynamic + + + + + + + + + This function is used to make porting from neko to cpp easy. + It does not need to do anything because the c-code can work with any Dynamic + + + + + + + + + Print the specified value on the default output followed by a newline character. + + + + + + + + + + + * Flag to specify a STREAMER device. + + + + + + * Flag to specify a FORWARDER device. + + + + + + * Flag to specify a QUEUE device. + + + + + + + + + * Gets complete 0MQ library version + * @return 0MQ library version in form MMmmpp (MM=major, mm=minor, pp=patch) + + + + + + * Gets 0MQ library major version + * @return 0MQ major library version (2, 3 etc) + + + + + + * Gets 0MQ library minor version + * @return 0MQ minor library version + + + + + + * Gets 0MQ library patch version + * @return 0MQ library patch version + + + + + + + + + + + * Creates an integer in same form as given by versionFull() + * @param major + * @param minor + * @param patch + * @return + + + + + + + + + * Returns a human-readable description from a ZMQException object errNo number + * @param errNo A valid 0MQ error number. + * Use the errorTypeToErrNo method to convert a ZMQ.ErrorType + * @return A short description of the error + + + + + + + + + * Converts a SocketType enum into a ZMQ socket type integer value + * @param type + * @return + + + + + + + + + * Converts a SocketOptionsType enum into a ZMQ int + * @param option + * @return + + + + + + + + + * Converts a SendReceiveFlagType enum value into the corresponding 0MQ library int value + * @param type + * @return + + + + + + + + + * Converts Haxe ErrorType enum value to ZMQ errNo integer value + * @param e + * @return + + + + + + + + + * Converts ZMQ errNo integer value to Haxe ErrorType enum value + * @param e + * @return + + + + + + * Sets up interrupt signal handling. + * Use isInterrupted() to subsequwnrly test for interruption + + + + + + * Indicates if 0MQ has been interrupted by a system signal (SIGINT or SIGTERM) + * Use this method to detect interrupt, and exit cleanly (close 0MQ sockets and contexts), + * particularly after recvMsg() and poll() calls. + * See: http://zguide.zeromq.org/page:all#Handling-Interrupt-Signals + * + * @return True if 0MQ has been interrupted + + + <_hx_zmq_version_full line="453" static="1"> + <_hx_zmq_version_major line="454" static="1"> + <_hx_zmq_version_minor line="455" static="1"> + <_hx_zmq_version_patch line="456" static="1"> + <_hx_zmq_make_version line="457" static="1"> + + + + + + <_hx_zmq_str_error line="458" static="1"> + + + + <_hx_zmq_catch_signals line="459" static="1"> + <_hx_zmq_interrupted line="460" static="1"> + <_hx_zmq_ZMQ_PUB line="462" static="1"> + <_hx_zmq_ZMQ_SUB line="463" static="1"> + <_hx_zmq_ZMQ_PAIR line="464" static="1"> + <_hx_zmq_ZMQ_REQ line="465" static="1"> + <_hx_zmq_ZMQ_REP line="466" static="1"> + <_hx_zmq_ZMQ_DEALER line="467" static="1"> + <_hx_zmq_ZMQ_ROUTER line="468" static="1"> + <_hx_zmq_ZMQ_PULL line="469" static="1"> + <_hx_zmq_ZMQ_PUSH line="470" static="1"> + <_hx_zmq_ZMQ_LINGER line="472" static="1"> + <_hx_zmq_ZMQ_HWM line="473" static="1"> + <_hx_zmq_ZMQ_RCVMORE line="474" static="1"> + <_hx_zmq_ZMQ_SUBSCRIBE line="475" static="1"> + <_hx_zmq_ZMQ_UNSUBSCRIBE line="476" static="1"> + <_hx_zmq_ZMQ_SWAP line="477" static="1"> + <_hx_zmq_ZMQ_AFFINITY line="478" static="1"> + <_hx_zmq_ZMQ_IDENTITY line="479" static="1"> + <_hx_zmq_ZMQ_RATE line="481" static="1"> + <_hx_zmq_ZMQ_RECOVERY_IVL line="482" static="1"> + <_hx_zmq_ZMQ_RECOVERY_IVL_MSEC line="483" static="1"> + <_hx_zmq_ZMQ_MCAST_LOOP line="484" static="1"> + <_hx_zmq_ZMQ_SNDBUF line="485" static="1"> + <_hx_zmq_ZMQ_RCVBUF line="486" static="1"> + <_hx_zmq_ZMQ_RECONNECT_IVL line="487" static="1"> + <_hx_zmq_ZMQ_RECONNECT_IVL_MAX line="488" static="1"> + <_hx_zmq_ZMQ_BACKLOG line="489" static="1"> + <_hx_zmq_ZMQ_FD line="490" static="1"> + <_hx_zmq_ZMQ_EVENTS line="491" static="1"> + <_hx_zmq_ZMQ_TYPE line="492" static="1"> + <_hx_zmq_ZMQ_POLLIN line="494" static="1"> + <_hx_zmq_ZMQ_POLLOUT line="495" static="1"> + <_hx_zmq_ZMQ_POLLERR line="496" static="1"> + <_hx_zmq_DONTWAIT line="498" static="1"> + <_hx_zmq_SNDMORE line="499" static="1"> + <_hx_zmq_EINVAL line="501" static="1"> + <_hx_zmq_ENOTSUP line="502" static="1"> + <_hx_zmq_EPROTONOSUPPORT line="503" static="1"> + <_hx_zmq_EAGAIN line="504" static="1"> + <_hx_zmq_ENOMEM line="505" static="1"> + <_hx_zmq_ENODEV line="506" static="1"> + <_hx_zmq_ENOBUFS line="507" static="1"> + <_hx_zmq_ENETDOWN line="508" static="1"> + <_hx_zmq_EADDRINUSE line="509" static="1"> + <_hx_zmq_EADDRNOTAVAIL line="510" static="1"> + <_hx_zmq_ECONNREFUSED line="511" static="1"> + <_hx_zmq_EINPROGRESS line="512" static="1"> + <_hx_zmq_EMTHREAD line="513" static="1"> + <_hx_zmq_EFSM line="514" static="1"> + <_hx_zmq_ENOCOMPATPROTO line="515" static="1"> + <_hx_zmq_ETERM line="516" static="1"> + + * Core class for 0MQ Haxe bindings + + + + An abstract type that represents an Enum. + See [Type] for the haXe Reflection API. + + + + + + + + + + Encode an URL by using the standard format. + + + + + + + + + Decode an URL using the standard format. + + + + + + + + + Escape HTML special characters of the string. + + + + + + + + + Unescape HTML special characters of the string. + + + + + + + + + + Tells if the string [s] starts with the string [start]. + + + + + + + + + + Tells if the string [s] ends with the string [end]. + + + + + + + + + + Tells if the character in the string [s] at position [pos] is a space. + + + + + + + + + Removes spaces at the left of the String [s]. + + + + + + + + + Removes spaces at the right of the String [s]. + + + + + + + + + Removes spaces at the beginning and the end of the String [s]. + + + + + + + + + + + Pad the string [s] by appending [c] at its right until it reach [l] characters. + + + + + + + + + + + Pad the string [s] by appending [c] at its left until it reach [l] characters. + + + + + + + + + + + Replace all occurences of the string [sub] in the string [s] by the string [by]. + + + + + + + + + + Encode a number into a hexadecimal representation, with an optional number of zeros for left padding. + + + + + + + + + + Provides a fast native string charCodeAt access. Since the EOF value might vary depending on the platforms, always test with StringTools.isEOF. + Only guaranteed to work if index in [0,s.length] range. Might not work with strings containing \0 char. + + + + + + + + The StringTools class contains some extra functionalities for [String] + manipulation. It's stored in a different class in order to prevent + the standard [String] of being bloated and thus increasing the size of + each application using it. + + + + + + + + + + + Tells if an object has a field set. This doesn't take into account the object prototype (class methods). + + + + + + + + + + Returns the field of an object, or null if [o] is not an object or doesn't have this field. + + + + + + + + + + + Set an object field value. + + + + + + + + + + + Call a method with the given object and arguments. + + + + + + + + + Returns the list of fields of an object, excluding its prototype (class methods). + + + + + + + + + Tells if a value is a function or not. + + + + + + + + + + Generic comparison function, does not work for methods, see [compareMethods] + + + + + + + + + + Compare two methods closures. Returns true if it's the same method of the same instance. + Does not work on Neko platform. + + + + + + + + + Tells if a value is an object or not. + + + + + + + + + + + Delete an object field. + + + + + + + + + Make a copy of the fields of an object. + + + + + + + + + + + + Transform a function taking an array of arguments into a function that can + be called with any number of arguments. + + + + The Reflect API is a way to manipulate values dynamicly through an + abstract interface in an untyped manner. Use with care. + + + + + + + + + + * Returns ZMQ - specified human-readable error description + * @return + + + + + + + + + + * Encapsulates ZMQ Errors + * Provides the ZMQ - specified errno and a human - readable description + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + ZeroMQ - based socket protocol for haXe remoting. + Heavily based on the haxe.remoting.SocketProtocol class implementation. + + The ZeroMQ haXe Remoting Socket Protocol is composed of serialized strings converted into byte data exchanges. + Eeach message (request or answer) is sent as a single-part zeroMQ message. + + A request string is composed of the following serialized values : + - the boolean true for a request + - an array of strings representing the object+method path + - an array of parameters + A response string is composed of the following serialized values : + - the boolean false for a response + - a serialized value representing the result + Exceptions are serialized with [serializeException] so they will be thrown immediatly + when they are unserialized. + + + + <_instance static="1"> + <_hasInstance static="1"> + + + + + + + * Returns a global ZMQContext instance, or null + * + * @param ?ioThreads = 1 + + + <_hx_zmq_construct line="120" static="1"> + + + + <_hx_zmq_term line="121" static="1"> + + + + + + Opaque data used by hxzmq driver + + + + Records if context has been terminated + + + + + * Close or terminate the context + * + * This can be called to close the context by hand. If this is not + * called, the context will automatically be closed when it is + * garbage collected. + + + + + + + + + * Create a Socket associated with this Context + * @param socketType The socket type which can be any of the ZMQ socket types + * @return A ZMQSocket object + + + + + + * Convenience method to create a ZMQPoller object. + * Raises a ENOTSUP ZMQException if context is closed + * @return A ZMQPoller object + + + + + + + + + * Creates a ZMQ Context + * + * Can throw EINVAL if invalid number of iothreads requested + * + * See: http://api.zeromq.org/master:zmq-init + + + + + + + + + + + Adds the representation of any value to the string buffer. + + + + + + + + + + + Adds a part of a string to the string buffer. + + + + + + + + + Adds a character to the string buffer. + + + + + + Returns the content of the string buffer. + The buffer is not emptied by this operation. + + + + + + + Creates a new string buffer. + + + + A String buffer is an efficient way to build a big string by + appending small elements together. + + + + <_hx_zmq_poll line="221" static="1"> + + + + + + + + + * Provides the last-polled set of rececived events + + + + + + + + + + + + * Adds a socket to the internak list of polled sockets + * @param socket A ZMQScxket object + * @param event Bitmasked Int for polled events (ZMQ_POLLIN, ZMQ_POLLOUT) + + + + + + + + + * Removes a previously registered socket + * @param socket + * @return + + + + + + * Removes all current registered sockets + + + + + + + + + * Poll a set of 0MQ sockets, + * @param ?timeout Timeout in microseconds, or 0 to return immediately, or -1 to block indefintely (default) + * @return how many objects signalled, or 0 if none, or -1 if failure + + + + + + + + + * Test if the s'th registered socket has a registered POLLIN event. + * Call this after a poll() method call to test the results. + * + * @param s Valid s parameter range from 1 to revents.length + * @return True if specified registered socket has a current POLLIN event, else False + + + + + + + + + * Test if the s'th registered socket has a registered POLLOUT event. + * Call this after a poll() method call to test the results. + * + * @param s Valid s parameter range from 1 to revents.length + * @return True if specified registered socket has a current POLLOUT event, else False + + + + + + + + + * Test of the s'th registered socket has no received polled events + * @param s Valid s parameter range from 1 to revents.length + * @return True if no received polled events on the socket + + + + + + * Constructor + + + + * Encapsulates ZMQ Poller functions. + * + * Statefull class, maintaining a set of sockets to poll, events to poll for + + + + <_socket> + <_event> + + + <_revents> + <_ret> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + <_hx_zmq_construct_socket line="449" static="1"> + + + + + <_hx_zmq_close line="450" static="1"> + + + + <_hx_zmq_bind line="451" static="1"> + + + + + <_hx_zmq_connect line="452" static="1"> + + + + + <_hx_zmq_send line="453" static="1"> + + + + + + <_hx_zmq_rcv line="454" static="1"> + + + + + <_hx_zmq_setintsockopt line="455" static="1"> + + + + + + <_hx_zmq_setint64sockopt line="456" static="1"> + + + + + + + <_hx_zmq_setbytessockopt line="457" static="1"> + + + + + + <_hx_zmq_getintsockopt line="458" static="1"> + + + + + <_hx_zmq_getint64sockopt line="459" static="1"> + + + + + <_hx_zmq_getbytessockopt line="460" static="1"> + + + + + + + Records if socket has been closed + + + + + * Hold reference to context associated with socket, to stop it being garbage collected + + + <_socketHandle public="1" set="null"> + + Opaque data used by hxzmq driver + + + + + * Close the socket + * + * This can be called to close the socket by hand. If this is not + * called, the socket will automatically be closed when it is + * garbage collected. + + + + + + + + + * Bind a socket to an address + * + * This causes the socket to listen on a network port. Sockets on the + * other side of this connection will use ``Socket.connect(addr)`` to + * connect to this socket. + * + * @param addr The address string. + * This has the form 'protocol://interface:port', + * for example 'tcp://127.0.0.1:5555'. Protocols supported are + * tcp, upd, pgm, inproc and ipc. If the address is unicode, it is + * encoded to utf-8 first. + + + + + + + + + * Connect to a remote ZMQ socket + * + * @param addr The address string + * This has the form 'protocol://interface:port', + * for example 'tcp://127.0.0.1:5555'. Protocols supported are + * tcp, upd, pgm, inproc and ipc. If the address is unicode, it is + * encoded to utf-8 first. + + + + + + + + + + * Set socket options. + * + * See the ZMQ documentation for details on specific options: + * http://api.zeromq.org/master:zmq-setsockopt + * + * C Parameter type optval haXe type expected + * ================= ========================== + * int Int + * int64_t, uint64_t ZMQInt64Type (if neko or cpp) + * Int (if php - will be 64bits on 64bit platforms, else 32 bit) + * binary haxe.io.Bytes + * + * @param option SocketOptionsType (defined in ZMQ.hx) + * @param optval Either Int or String or Bytes + + + + + + + + + * Return a previously set socket option + * + * @param option + * @return + + + + + + + + + + * Send a message on this socket + * + * This queues the message to be sent by the IO thread at a later time. + * + * @param data The content of the message + * @param ?flags Any supported SocketFlag DONTWAIT, SNDMORE + + + + + + + + + * Receive a message on this socket + * + * Will return either a message, null (if DONTWAIT was used and there was no data received) or a ZMQException + * + * @param ?flags + * @return + + + + + + * Convenience method to test if socket has more parts of a multipart message to read + * @return + + + + + + + + + + * Constructor. + * + * Creates a new ZMQ socket + * @param context A ZMQ Context previously created + * @param type A ZMQ socket type + + + + * A 0MQ socket + * + * These objects will generally be created via the socket() method of a ZMQContext object. + * + * Class based on code from pyzmq project + * See: https://github.com/zeromq/pyzmq/blob/master/zmq/core/socket.pyx + + + + + + + Returns a Date representing the current local time. + + + + + + + + + Returns a Date from a timestamp [t] which is the number of + milliseconds elapsed since 1st January 1970. + + + + + + + + + Returns a Date from a formated string of one of the following formats : + [YYYY-MM-DD hh:mm:ss] or [YYYY-MM-DD] or [hh:mm:ss]. The first two formats + are expressed in local time, the third in UTC Epoch. + + + + + + + Returns the timestamp of the date. It's the number of milliseconds + elapsed since 1st January 1970. It might only have a per-second precision + depending on the platforms. + + + + + + Returns the hours value of the date (0-23 range). + + + + + + Returns the minutes value of the date (0-59 range). + + + + + + Returns the seconds of the date (0-59 range). + + + + + + Returns the full year of the date. + + + + + + Returns the month of the date (0-11 range). + + + + + + Returns the day of the date (1-31 range). + + + + + + Returns the week day of the date (0-6 range). + + + + + + Returns a string representation for the Date, by using the + standard format [YYYY-MM-DD HH:MM:SS]. See [DateTools.format] for + other formating rules. + + + + + + + + + + + + + The Date class is used for date manipulation. There is some extra functions + available in the [DateTools] class. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Returns true if the iterator has other items, false otherwise. + + + + + + Moves to the next item of the iterator. + + + + + + + + + + + + Integer iterator. Used for interval implementation. + + + + An integer value is outside its allowed range + An operation on Bytes is outside of its valid range + + + Other errors + + The IO is set into nonblocking mode and some data cannot be read or written + + The possible IO errors that can occur + + + + + + + + + + + + + + + + + + + + Returns the class of a value or [null] if this value is not a Class instance. + + + + + + + + + Returns the enum of a value or [null] if this value is not an Enum instance. + + + + + + + + + Returns the super-class of a class, or null if no super class. + + + + + + + + + Returns the complete name of a class. + + + + + + + + + Returns the complete name of an enum. + + + + + + + + + Evaluates a class from a name. The class must have been compiled + to be accessible. + + + + + + + + + Evaluates an enum from a name. The enum must have been compiled + to be accessible. + + + + + + + + + + Creates an instance of the given class with the list of constructor arguments. + + + + + + + + + Similar to [Reflect.createInstance] excepts that the constructor is not called. + This enables you to create an instance without any side-effect. + + + + + + + + + + + Create an instance of an enum by using a constructor name and parameters. + + + + + + + + + + + Create an instance of an enum by using a constructor index and parameters. + + + + + + + + + Returns the list of instance fields. + + + + + + + + + Returns the list of a class static fields. + + + + + + + + + Returns all the available constructor names for an enum. + + + + + + + + + Returns the runtime type of a value. + + + + + + + + + + Recursively compare two enums constructors and parameters. + + + + + + + + + Returns the constructor of an enum + + + + + + + + + Returns the parameters of an enum + + + + + + + + + Returns the index of the constructor of an enum + + + + The haXe Reflection API enables you to retreive informations about any value, + Classes and Enums at runtime. + + + + + + + + + + + + + + Unserialize a single value and return it. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Tells if a value v is of the type t. + + + + + + + + + Convert any value to a String + + + + + + + + + Convert a Float to an Int, rounded down. + + + + + + + + + Convert a String to an Int, parsing different possible representations. Returns [null] if could not be parsed. + + + + + + + + + Convert a String to a Float, parsing different possible reprensations. + + + + + + + + + Return a random integer between 0 included and x excluded. + + + + The Std class provides standard methods for manipulating basic types. + + + + The standard Void type. Only [null] values can be of the type [Void]. + + + The standard Float type, this is a double-precision IEEE 64bit float. + + + + + The standard Int type. Its precision depends on the platform. + + + + + + [Null] can be useful in two cases. In order to document some methods + that accepts or can return a [null] value, or for the Flash9 compiler and AS3 + generator to distinguish between base values that can be null and others that + can't. + + + + + + + The standard Boolean type is represented as an enum with two choices. + + + + Dynamic is an internal compiler type which has special behavior. + See the haXe language reference for more informations. + + + + + + + + An Iterator is a structure that permits to list a given container + values. It can be used by your own data structures. See the haXe + documentation for more informations. + + + + + + An Iterable is a data structure which has an iterator() method. + See [Lambda] for generic functions on iterable structures. + + + + ArrayAccess is used to indicate a class that can be accessed using brackets. + The type parameter represent the type of the elements stored. + + + + + + + + + Creates an [Array] from an [Iterable] + + + + + + + + + Creates a [List] from an [Iterable] + + + + + + + + + + + + + Creates a new [Iterable] by appling the function 'f' to all + elements of the iterator 'it'. + + + + + + + + + + + + + + Similar to [map], but also pass an index for each item iterated. + + + + + + + + + + + + + + + Tells if the element is part of an iterable. The comparison + is made using the [==] operator. Optionally you can pass as + a third parameter a function that performs the comparison. + That function must take as arguments the two items to + compare and returns a boolean value. + + + + + + + + + + + + + Tells if at least one element of the iterable is found by using the specific function. + + + + + + + + + + + + + Tells if all elements of the iterable have the specified property defined by [f]. + + + + + + + + + + + + + Call the function 'f' on all elements of the [Iterable] 'it'. + + + + + + + + + + + + + Return the list of elements matching the function 'f' + + + + + + + + + + + + + + + Functional 'fold' using an [Iterable] + + + + + + + + + + + + + Count the number of elements in an [Iterable] having [pred] returning true. + + + + + + + + + Tells if an iterable does not contain any element. + + + + + + + + + + Returns the index of the item in the given Iterable, depending on the order of the Iterator. + Returns -1 if the item was not found. + + + + + + + + + + Returns a list containing all items of 'a' followed by all items of 'b' + + + + The [Lambda] class is a collection of functional methods in order to + use functional-style programming with haXe. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + This class defines mathematical functions and constants. + + + + + + + If the values you are serializing can contain + circular references or objects repetitions, you should + set USE_CACHE to true to prevent infinite loops. + + + + + + Use constructor indexes for enums instead of names. + This is less reliable but more compact. + + + + + + + + + + Serialize a single value and return the string. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + The number of elements in this list. + + + + + + + + + Add an element at the end of the list. + + + + + + + + + Push an element at the beginning of the list. + + + + + + Returns the first element of the list, or null + if the list is empty. + + + + + + Returns the last element of the list, or null + if the list is empty. + + + + + + Removes the first element of the list and + returns it or simply returns null if the + list is empty. + + + + + + Tells if a list is empty. + + + + + + Makes the list empty. + + + + + + + + + Remove the first element that is [== v] from the list. + Returns [true] if an element was removed, [false] otherwise. + + + + + + Returns an iterator on the elements of the list. + + + + + + Returns a displayable representation of the String. + + + + + + + + + Join the element of the list by using the separator [sep]. + + + + + + + + + + + + Returns a list filtered with [f]. The returned list + will contain all elements [x] for which [f(x) = true]. + + + + + + + + + + + + Returns a new list where all elements have been converted + by the function [f]. + + + + + + Creates a new empty list. + + + + A linked-list of elements. The list is composed of two-elements arrays + that are chained together. It's optimized so that adding or removing an + element doesn't imply to copy the whole array content everytime. + + + + + + + + + + + + + + + + + + + + + + + Set a value for the given key. + + + + + + + + + Get a value for the given key. + + + + + + + + + Tells if a value exists for the given key. + In particular, it's useful to tells if a key has + a [null] value versus no value. + + + + + + + + + Removes a hashtable entry. Returns [true] if + there was such entry. + + + + + + Returns an iterator of all keys in the hashtable. + + + + + + Returns an iterator of all values in the hashtable. + + + + + + Returns an displayable representation of the hashtable content. + + + + + Hashtable over a set of elements, using [Int] as keys. + On Flash and Javascript, the underlying structure is an Object. + + + + An abstract type that represents a Class. + See [Type] for the haXe Reflection API. + + + + + + + + + + The number of characters in the String. + + + + + + Returns an String where all characters have been uppercased. + + + + + + Returns an String where all characters have been lowercased. + + + + + + + + + Returns the character at the given position. + Returns the empty String if outside of String bounds. + + + + + + + + + Returns the character code at the given position. + Returns [null] if outside of String bounds. + + + + + + + + + + Returns the index of first occurence of [value] + Returns [1-1] if [value] is not found. + The optional [startIndex] parameter allows you to specify at which character to start searching. + The position returned is still relative to the beginning of the string. + + + + + + + + + + Similar to [indexOf] but returns the latest index. + + + + + + + + + Split the string using the specified delimiter. + + + + + + + + + + Returns a part of the String, taking [len] characters starting from [pos]. + If [len] is not specified, it takes all the remaining characters. + + + + + + Returns the String itself. + + + + + + + + + Creates a copy from a given String. + + + + The basic String class. + + + + + + + + The length of the Array + + + + + + + + + Returns a new Array by appending [a] to [this]. + + + + + + + + + Returns a representation of an array with [sep] for separating each element. + + + + + + Removes the last element of the array and returns it. + + + + + + + + + Adds the element [x] at the end of the array. + + + + + + Reverse the order of elements of the Array. + + + + + + Removes the first element and returns it. + + + + + + + + + + Copies the range of the array starting at [pos] up to, + but not including, [end]. Both [pos] and [end] can be + negative to count from the end: -1 is the last item in + the array. + + + + + + + + + + + + 0] if [x > y] + and [<0] if [x < y]. + ]]> + + + + + + + + + Removes [len] elements starting from [pos] an returns them. + + + + + + Returns a displayable representation of the Array content. + + + + + + + + + Adds the element [x] at the start of the array. + + + + + + + + + + Inserts the element [x] at the position [pos]. + All elements after [pos] are moved one index ahead. + + + + + + + + + Removes the first occurence of [x]. + Returns false if [x] was not present. + Elements are compared by using standard equality. + + + + + + Returns a copy of the Array. The values are not + copied, only the Array structure. + + + + + + Returns an iterator of the Array values. + + + + + + Creates a new Array. + + + + An Array is a storage for values. You can access it using indexes or + with its API. On the server side, it's often better to use a [List] which + is less memory and CPU consuming, unless you really need indexed access. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + <_sleep line="93" static="1"> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + <__Internal> + + + + + + + + Set a value for the given key. + + + + + + + + + Get a value for the given key. + + + + + + + + + Tells if a value exists for the given key. + In particular, it's useful to tells if a key has + a [null] value versus no value. + + + + + + + + + Removes a hashtable entry. Returns [true] if + there was such entry. + + + + + + Returns an iterator of all keys in the hashtable. + + + + + + Returns an iterator of all values in the hashtable. + + + + + + Returns an displayable representation of the hashtable content. + + + + + Hashtable over a set of elements, using [String] as keys. + Other kind of keys are not possible on all platforms since they + can't always be implemented efficiently. + + + \ No newline at end of file diff --git a/docs/images/alias.png b/docs/images/alias.png new file mode 100644 index 0000000000000000000000000000000000000000..ade7516d1156f5d8931d4d8c61bf02f78bc79794 GIT binary patch literal 549 zcmV+=0^0qFP)x;fmBDsX`KsB%n!QV_Jo4MDP+U?sjiyXJ%*Sl1Y&Zaie!2DSR+6#e9$7 zdmqCXBW@$P)ii)RSC?k9`A;bAcAFIg09amrJ2DAFQW>DIq_(6k0pm#LNgrCRkBvVF zuH}bhu1Tct=T%)EL!H}|?Ok|{D%KtCt@`B(!| z8B%Fd>8-8z$#58Ar*l#}Iyz3SOhhIa0EGpV1qNnqZTG>#!t zN!0`bZOOu%p8g1jhhHC^pL<`ciP_)(UQg3sj!adI>7)p{Bz3vE`tIS>)P39S_U;;E zW0K%(Y3WN{q^Css;|T!c0OQuzKTj_%&VJk8etEFB_hNT`{_*kVW_LEmfx1~@WsR46 zwyx88^MUN;z`(_5%Z-g^J27U3$e_6FX>0@+fDix|NFPM32TBhZFJeoeut}0tB2)-k ntxpY9bPvFj(fPah-+$u;C^_K_VhRJ#00000NkvXXu0mjfE>i1< literal 0 HcmV?d00001 diff --git a/docs/images/alltypes.png b/docs/images/alltypes.png new file mode 100644 index 0000000000000000000000000000000000000000..05f033e23a15274f0ba6cae80acf34dd8e393605 GIT binary patch literal 797 zcmV+&1LFLNP)tFt%uLdG z_ulv3?IKBabm<>191i#V_@8q)!dlDg$Xy7E#iFcKDxbNo`?1#gZELLqAcROVUgpmv zPJZ@%|GOXv(iZ{3T1$6#x8wW%Xg;6c(6y~=NoV0LtZOl7A{9|8l^D4?I{UO7{!yK( zZXFmHNZJ6sy}e%)3WdHSy+?9JXbkhu8VrUQLt+yypB-fCag{WkGtuAQFC>8DIET0I z+@3Q+bNurY?A@^sWfh8ukGl4Ay6+nlE#BF&k3pGzx`c_raZ9|Lu1oB035=s!tk=AZ)e)thLg*DZ@91sa0!i*t{N%LR-bUch^uY z*SIrs7wu@0#0nw8MjHUYU?`Q#WEW@gmS)gaqfxjW4jC^)rCdP~%@xU)078gVnTT!s z-e*zPW9kB9p;bh42H^nn+>;F4&0n#`Rrn^vY2oW}<44YDh4Qrn@rK~lCnEn@LT8>j|z5-a#(W5uEwr8@;^_zeBD=>cx bucQ9}r@BqT*9LKh00000NkvXXu0mjf4CHKe literal 0 HcmV?d00001 diff --git a/docs/images/bginherited.png b/docs/images/bginherited.png new file mode 100644 index 0000000000000000000000000000000000000000..67bd4f6c604cb0f42a0d5587df86c6b3b4810003 GIT binary patch literal 985 zcmeAS@N?(olHy`uVBq!ia0vp^%plAGA``#4_5vx!;vjb?hIQv;UIIBR>5jgR3=A9l zx&I`x0{IHb9znhg3{`3j3=J&|48MRv4KElNN(~qoUL`OvSj}Ky5HFasE6@gHaDY#U z>!)x3fdHs%6pV(z2n>PiUwXCzz0FzR5n0T@z;_sg8IR|$NC65;l(FMg{vd$@?2>@%JJ?Q`d literal 0 HcmV?d00001 diff --git a/docs/images/class.png b/docs/images/class.png new file mode 100644 index 0000000000000000000000000000000000000000..e04c901ef55dde41eb68af4f7ede380cb987a540 GIT binary patch literal 705 zcmV;y0zUnTP)uYh^?-4yZ}k2So)1x^XqMNQ1(a8~qa`H)SI^<476?Gjs2I?|t7EVI;Rz zp3UJb&cpfr&N-S=itU8Ht!}{hyU1iRda+pSH4Nj55Mr-V$_Jonnp@?sT67(EEE0)4 zN~hCuvq#&MkW40h;c$4asi~!aot`VLudL0l7QY|OX0z@V z387Hvb}SZa>$%wz+|}BQuSQ224$|jBKoQ>8z}XvTg7wjz?ez`yeI5_|et)X-bZ4!t z2}+{GvnS6vmpD%{aeZdO%g@pU?1mW~|vOc0GmAFO;^U6^|Pp;XKj z5w^fpE-ntj5&Xz)F#qOrxtuo_;*t2U=Mn)jnT$~=7VhbWe%Udd-J5P}nkMytz9bzv n9*@L_)9JMHPr(1gw!iTgtxFAvUSI%N00000NkvXXu0mjfO0PAa literal 0 HcmV?d00001 diff --git a/docs/images/enum.png b/docs/images/enum.png new file mode 100644 index 0000000000000000000000000000000000000000..7d87e623a1a0dbdefd236f05995a98bcee9f4e19 GIT binary patch literal 292 zcmeAS@N?(olHy`uVBq!ia0vp^0wB!61|;P_|4#%`EX7WqAsj$Z!;#Vf2?p zUk71ECym(^Ktah8*NBqf{Irtt#G+J&^73-M%)IR4C_-<-hAo%OtmoCvnku1e znjdV+yCQw@R=rI|Jk2#640HT#lhlr!TghY5Y|&l8eNXY=<(}(z7!NFbd+7WBN1N`Z zG2Qzedy;ErLr|91oY=&K=SL1Iv=7EDJgh>aKa7aKG%R g_KEZTE2AFpnQe%D70|H^p00i_>zopr0N3zsK>z>% literal 0 HcmV?d00001 diff --git a/docs/images/hide.png b/docs/images/hide.png new file mode 100644 index 0000000000000000000000000000000000000000..8a471037fd0669643c0ddab2a87da719c6386103 GIT binary patch literal 183 zcmeAS@N?(olHy`uVBq!ia0vp^93afW1|*O0@9PFqEX7WqAsj$Z!;#Vf2?p zUk71ECym(^Ktah8*NBqf{Irtt#G+J&^73-M%)IR4_}hPY>Pt04uud zJ^B_wmnabGB3;73FevceE${6W6$1~w@WSxUJHL6}XBeWC!Yn~& zIt^fc(uU(WJA{xMrPLfDL=ZwGW9+%x?H*D}FN(#YKM|12<+eHJm2B2whOr3Wm$cs( zXf~f$YPITdyZsgha1uCzZQEO%^NM8^LZ%sqQgfhG17jg1601n3_ZDYh`8PnRQSjI+d`l$|BB(wUfPu_Wsh_|p z0M7YKv)PClMqpp=o?hd{CT6ms!czb)*X*3>(3f9)vkxZ@+M{wOI z+}~fm`@VNHroi*O^H%FsE0@pqd%doKfMATfzV97HA`7QqHS+Jj@dJXI&g(=FW(fcQ N002ovPDHLkV1hu2-=P2i literal 0 HcmV?d00001 diff --git a/docs/images/overview.png b/docs/images/overview.png new file mode 100644 index 0000000000000000000000000000000000000000..4e05460f554362263f9e0a352872b31ba386fef5 GIT binary patch literal 688 zcmV;h0#E&kP)S)%acY z6?WC)d~AYPF_*Z*T?> zkM$1@+ZGXQA&^W6*cL$$K@dOy3PU3)H+nLG2FhdzepbWHO7-ld429WN` zfB)1Ba|9aGo&_9hH-q*fYEBBEugfn)@v(4qznRS5J-(s8HDN# ziKW8U`f4)@!{xRBG0*O7Z=TlIY8)z!KByDffo14_sTT)sAAVZ~DIf`2qj{Gcz+ztJRuvQ>jS;6^vFJ zQ5Y^0(MJFqJ>lump_~4uL8HF!A6@|dmPe)Or%7<>s$-k43j4}%(f9r4r2zo&D&=Qg zuJa(1zG8hjKG}|?x+5;V4L~ubPhzziLs&|iTLA9=Qv(1fm&;Bfk$7v2d9k>-=zj-S WpeAf%9&fz>0000%r0}bz`F``w>`o)4 zgyX1rEH{AVx)=-wb5Z*JKC&!ZXdI13jX3}S42Q!60EsEBb=I3VuU>X+Ewi&C&PDN+ zL<(tp_r-<364Z(m5*f|ttgnPz5toIqEmeOsY;<-5!*u8IgzTANYxwwDJ7(oFqur!zbebJRQrA<7>~!e ze*TQ1Li43tw^v)IPA>(c`NQK!Uk=~DHDry5D@DAI*~!hVUatq>kAJ|WmDSCQtxC-Z z0QR5n9$vX~w?kzitaA!#MqW+nch4L^Dktr;=USilUMT=Lc=KAjuLu6xz55$MD-QXL zNKM1SC5o@&$7fHzg`Zu-mGbW4gZ<|65~wg7OwM90F9gKkV+=k@`0>`_eI#onsA-VO z30uRID_RKHe)@8wu0QSUVB$~QK)VaHyFeF5s`1~i@jIX&XZr^3WE21Z002ovPDHLk FV1iM}_HzIL literal 0 HcmV?d00001 diff --git a/docs/images/show.png b/docs/images/show.png new file mode 100644 index 0000000000000000000000000000000000000000..28a46940bea6ee26303ecf5048cea9597f77ff58 GIT binary patch literal 214 zcmeAS@N?(olHy`uVBq!ia0vp^93afW1|*O0@9PFqEX7WqAsj$Z!;#Vf2?p zUk71ECym(^Ktah8*NBqf{Irtt#G+J&^73-M%)IR43D6a`2eYyra-#z%h^z>c%x*g>cTb2lIPzozyRY^?S za*g4|-pMmvTx<&uF(^ICX6i9KXP@${GSO&yS=`!nV!U1V*$x1WXYh3Ob6Mw<&;$Sv CWkmh} literal 0 HcmV?d00001 diff --git a/docs/images/todo.png b/docs/images/todo.png new file mode 100644 index 0000000000000000000000000000000000000000..04d75e85ff1ea95b85b0f7eeca6f9e91d03d4bc2 GIT binary patch literal 457 zcmV;)0XF`LP)(U_Vx-jw6!w~^9ZRQHCU(XG2&-8#76K6iEYX|1>dn2mb4FB^X_AImz#-sj zUMo|FfY1!{CU6Hl0nRKlfH5?bGxwQ;_-mYgxR04O@xop~^LjDQ3?QnCG-M;%i?%we zof5E~d`_0zyKM2?p zUk71ECym(^Ktah8*NBqf{Irtt#G+J&^73-M%)IR4>CTZ@eyq@@cf;ocXH=HD@W~{fsoJ1?BkfF+GslW~ zw)UZYck>?z97<+wsCd8m!E(_K4>6hKl*nnq2S19Y%u;JhbOK4#nt0X<`^W$xZI?-IL!r zUoO4(xQ*miuK^T)UK)+YKcTc*E#?dWU~B8;l}R=vRSalL8cUi4h#l!tGR>OJw~K!e z{8Bn3BSR_!C`)Qf#uhM6#HHT5?Dy$w9b`i?GHYuuic3rN`{Y22^ws?Q^M|Xeucm=s zME0T^4M-J}%IxgyPt@zR?;@cFLcP5F__*EvJVg$a$QT1a+uhwZy4^uxVPU!pM1~A? zt@hxo*Ng9NZ+|F@^wk&wW6#e|FG{82<>VyvsEf#y%UKu%GCVoy6uj?`i(rzKm8aiI zrQ*fW(Wg6P6qAuTIQVie2$*hcRNssAZYBU?2gGh}ZYo?~fAfemRz%s&&5yN8CHU%n zsIHfoTjOZY*6r;*d)MilCP3o6x5?q*lh-pdNq1DLwqqi=49GITWz}k6L~IHq>Fn%f zBw`al+d^TGi;yE|Huo2i(*%IZ)%m;l-+$u|4#?7^&V-f%00000NkvXXu0mjfzjFPf literal 0 HcmV?d00001 diff --git a/docs/index.html b/docs/index.html new file mode 100644 index 0000000..393bfde --- /dev/null +++ b/docs/index.html @@ -0,0 +1,13 @@ + + + + Haxe Application + + + + + + + + + \ No newline at end of file diff --git a/docs/overview.html b/docs/overview.html new file mode 100644 index 0000000..ea982be --- /dev/null +++ b/docs/overview.html @@ -0,0 +1,16 @@ + + + + Haxe Application + + + +
+

Haxe Application

+

http://www.haxe.org/

+
+ +
+
+ + \ No newline at end of file diff --git a/docs/packages/org/zeromq/package.html b/docs/packages/org/zeromq/package.html new file mode 100644 index 0000000..3c2bbc4 --- /dev/null +++ b/docs/packages/org/zeromq/package.html @@ -0,0 +1,44 @@ + + + + + Package zeromq Type List + + + + + + + + + + diff --git a/docs/packages/org/zeromq/remoting/package.html b/docs/packages/org/zeromq/remoting/package.html new file mode 100644 index 0000000..5a998e8 --- /dev/null +++ b/docs/packages/org/zeromq/remoting/package.html @@ -0,0 +1,24 @@ + + + + + Package remoting Type List + + + + + +
+

org.zeromq.remoting

+ +
+ + + + diff --git a/docs/stylesheet.css b/docs/stylesheet.css new file mode 100644 index 0000000..b161907 --- /dev/null +++ b/docs/stylesheet.css @@ -0,0 +1,319 @@ +/* CSS reset */ +html, body, div, span, applet, object, iframe, +h1, h2, h3, h4, h5, h6, p, blockquote, pre, +a, abbr, acronym, address, big, cite, code, +del, dfn, em, font, img, ins, kbd, q, s, samp, +small, strike, strong, sub, sup, tt, var, +dl, dt, dd, ol, ul, li, +fieldset, form, label, legend, +table, caption, tbody, tfoot, thead, tr, th, td { + margin: 0; + padding: 0; + border: 0; + outline: 0; + font-weight: inherit; + font-style: inherit; + font-size: 100%; + font-family: inherit; + vertical-align: baseline; +} +/* remember to define focus styles! */ +:focus { + outline: 0; +} +body { + line-height: 1; + color: black; + background: white; +} +ol, ul { + list-style: none; +} +/* tables still need 'cellspacing="0"' in the markup */ +table { + border-collapse: separate; + border-spacing: 0; +} +caption, th, td { + text-align: left; + font-weight: normal; +} +blockquote:before, blockquote:after, +q:before, q:after { + content: ""; +} +blockquote, q { + quotes: "" ""; +} + +/** STYLE **/ +body { + font-family:Tahoma,Verdana,Arial,Helvetica,sans-serif; + font-size: 13px; +} + +a, a:active, a:visited { + color: #0000cc; +} + +.type-frame { + margin: 10px; +} + +#types-frame, #packages-frame { + margin: 0px; +} + +ul.types, ul.packages, #packages-header ul{ + margin: 5px 5px 10px 5px; +} + +#types-frame h1, #packages-frame h1 { + font-size: 77%; + font-weight: bold; + padding: 2px; + color: #ffffff; + background-color: #666666; + text-align: center; +} + +#packages-frame h2 { + font-size: 77%; + padding: 2px; + border-bottom: 1px solid #666666; + text-align: center; + margin-bottom: 0.75em; +} + +.type-frame h1 { + font-size: 117%; + font-weight: bold; + margin-bottom: 0.75em; + padding-left: 20px; + background-repeat: no-repeat; + min-height: 16px; +} + +ul.types li { + background-repeat: no-repeat; + min-height: 16px; + padding-left: 18px; +} + +.class { + background-image: url(images/class.png); +} + +.interface { + background-image: url(images/interface.png); +} + +.typedef { + background-image: url(images/typedef.png); +} + +.alias { + background-image: url(images/alias.png); +} + +.enum { + background-image: url(images/enum.png); +} + +.overview { + background-image: url(images/overview.png); +} + +.todo { + background-image: url(images/todo.png); +} + +.alltypes { + background-image: url(images/alltypes.png); +} + +dl { + margin: 8px 0; +} + +.doc { + padding: 0 0 0.75em 0; + margin: 0.75em 0; +} + +dt { + display: block; + float: left; + width: 80px; + font-weight: bold; + font-size: 85%; + min-height: 1.2em; + vertical-align: bottom; + border-bottom: 1px solid #dddddd; + background-color: #f0f0f0; + padding: 2px 2px 2px 4px; + line-height: 1.2em; +} + +dd { + display: block; + margin-left: 86px; + min-height: 1.2em; + padding: 2px 2px 2px 4px; + border-left: 1px solid #cccccc; + border-bottom: 1px solid #dddddd; + font-size: 85%; + background-color: #f9f9f9; + line-height: 1.2em; +} + +pre { + border-top: 1px dashed #dddddd; + border-bottom: 1px dashed #dddddd; + background-color: #f9f9f9; + font-family: "Courier New", Courier, mono; + font-weight: normal; + padding: 0.75em 0 0 0; + margin: 0.75em 0; + font-size: 85%; +} + +.members-panel { + border: 1px solid #cccccc; + margin: 0 0 0.75em 0; +} + +.members-panel h2 { + border-top: 1px solid #ffffff; + border-bottom: 1px solid #e9e9e9; + background-color: #f3f3f3; + padding: 2px 4px; + font-weight: bold; + font-size: 85%; +} + +.member .header { + padding: 8px 4px 4px; + color: #666666; + font-size: 87%; + border-top: 1px solid #cccccc; +} + +.member .header .name { + color: #000000; + font-size: 114%; + font-weight: bold; +} + +.member .body { + padding: 4px 16px; +} + +.member .platforms { + padding: 4px 16px; +} + +.member .platforms-list { + padding: 4px 16px; + font-weight: bold; +} + +#packages-frame li, #types-frame li { + background-repeat: no-repeat; + min-height: 16px; + padding-left: 18px; +} + +#packages-frame ul.packages li { + background-image: url(images/package.png); +} + +#packages-header li { + font-weight: bold; + font-size: 85%; +} + +div.inherited, div.overrides { + margin: 2px 0; +} + +.deprecated { + color: #CC0000; +} + +.keyword { + color: #50C2FF; +} + +.hideInheritedVar { + display: none; +} +.showInheritedVar { + display: inline; +} +.hideInheritedMethod { + display: none; +} +.showInheritedMethod { + display: inline; +} + +#todo h1, #overview h1 { + font-size: 113%; + font-weight: bold; + padding: 2px; + color: #ffffff; + background-color: #666666; + text-align: center; +} + +#todo h2, #overview h2 { + font-size: 100%; + padding: 2px; + border-bottom: 1px solid #666666; + text-align: center; + margin-bottom: 0.75em; +} + +#main { + padding: 8px; +} + +p { + margin-bottom: 0.5em; +} + +ul.todolist { + margin: 0.5em 0; +} + +ul.todolist li { + background-repeat: no-repeat; + min-height: 16px; + padding-left: 18px; + background-image: url(images/todobullet.png); +} + +a.showHideLink { + margin-left: 8px; + font-size: 77%; + text-decoration: none; + border: 1px solid #cccccc; + background-color: #ffffff; + color: #666666; + padding: 1px 2px 0 13px; + background-repeat: no-repeat; + background-position: 2px 2px; +} + +.hideInheritedVar a.showHideLink, .hideInheritedMethod a.showHideLink { + background-image: url(images/hide.png); +} + +.showInheritedVar a.showHideLink, .showInheritedMethod a.showHideLink { + background-image: url(images/show.png); +} + +.hideInheritedVar div.member, .hideInheritedMethod div.member { + background-image: url(images/bginherited.png); +} \ No newline at end of file diff --git a/docs/types/org/zeromq/ErrorType.html b/docs/types/org/zeromq/ErrorType.html new file mode 100644 index 0000000..e8fed3d --- /dev/null +++ b/docs/types/org/zeromq/ErrorType.html @@ -0,0 +1,225 @@ + + + + + ErrorType (Haxe Application) + + + + + + + + +
+ +

org.zeromq.ErrorType

+
+
defined in
+
org.zeromq.ZMQ
+
available in
+
cpp
+
+ +
+ + + Enumeration of 0MQ error types + +
+ + +
+

Constructors

+
+
+
+ EADDRINUSE +
+
+
+ +
+ +
+
+
+
+ EADDRNOTAVAIL +
+
+
+ +
+ +
+
+
+
+ EAGAIN +
+
+
+ +
+ +
+
+
+
+ ECONNREFUSED +
+
+
+ +
+ +
+
+
+
+ EFSM +
+
+
+ +
+ +
+
+
+
+ EINPROGRESS +
+
+
+ +
+ +
+
+
+
+ EINVAL +
+
+
+ +
+ +
+
+
+
+ EMTHREAD +
+
+
+ +
+ +
+
+
+
+ ENETDOWN +
+
+
+ +
+ +
+
+
+
+ ENOBUFS +
+
+
+ +
+ +
+
+
+
+ ENOCOMPATPROTO +
+
+
+ +
+ +
+
+
+
+ ENODEV +
+
+
+ +
+ +
+
+
+
+ ENOMEM +
+
+
+ +
+ +
+
+
+
+ ENOTSUP +
+
+
+ +
+ +
+
+
+
+ EPROTONOSUPPORT +
+
+
+ +
+ +
+
+
+
+ ETERM +
+
+
+ +
+ +
+
+
+
+ +
+ + + + diff --git a/docs/types/org/zeromq/PollResult.html b/docs/types/org/zeromq/PollResult.html new file mode 100644 index 0000000..4efb97c --- /dev/null +++ b/docs/types/org/zeromq/PollResult.html @@ -0,0 +1,74 @@ + + + + + PollResult (Haxe Application) + + + + + + + +
+ +

org.zeromq.PollResult

+
+
defined in
+
org.zeromq.ZMQPoller
+
available in
+
cpp
+ +
+ +
+
+ +
+ +

Fields in +cpp +

+
+
+
+

+ var _ret : Int +

+
+
+ +
+
+ +
+
+
+
+

+ var _revents : Array<Int> +

+
+
+ +
+
+ +
+
+
+
+ +
+ + + + + diff --git a/docs/types/org/zeromq/PollSocketEventTuple.html b/docs/types/org/zeromq/PollSocketEventTuple.html new file mode 100644 index 0000000..af22038 --- /dev/null +++ b/docs/types/org/zeromq/PollSocketEventTuple.html @@ -0,0 +1,74 @@ + + + + + PollSocketEventTuple (Haxe Application) + + + + + + + +
+ +

org.zeromq.PollSocketEventTuple

+
+
defined in
+
org.zeromq.ZMQPoller
+
available in
+
cpp
+ +
+ +
+
+ +
+ +

Fields in +cpp +

+
+
+
+

+ var _event : Int +

+
+
+ +
+
+ +
+
+
+
+

+ var _socket : ZMQSocket +

+
+
+ +
+
+ +
+
+
+
+ +
+ + + + + diff --git a/docs/types/org/zeromq/SendReceiveFlagType.html b/docs/types/org/zeromq/SendReceiveFlagType.html new file mode 100644 index 0000000..23a8a1d --- /dev/null +++ b/docs/types/org/zeromq/SendReceiveFlagType.html @@ -0,0 +1,71 @@ + + + + + SendReceiveFlagType (Haxe Application) + + + + + + + + +
+ +

org.zeromq.SendReceiveFlagType

+
+
defined in
+
org.zeromq.ZMQ
+
available in
+
cpp
+
+ +
+ + + Enumeration of 0MQ send and receive flags + +
+ + +
+

Constructors

+
+
+
+ DONTWAIT +
+
+
+ +
+ +
+
+
+
+ SNDMORE +
+
+
+ +
+ +
+
+
+
+ +
+ + + + diff --git a/docs/types/org/zeromq/SocketOptionsType.html b/docs/types/org/zeromq/SocketOptionsType.html new file mode 100644 index 0000000..86dddb6 --- /dev/null +++ b/docs/types/org/zeromq/SocketOptionsType.html @@ -0,0 +1,270 @@ + + + + + SocketOptionsType (Haxe Application) + + + + + + + + +
+ +

org.zeromq.SocketOptionsType

+
+
defined in
+
org.zeromq.ZMQ
+
available in
+
cpp
+
+ +
+ + + Enumeration of 0MQ socket types + See: http://api.zeromq.org/master:zmq-setsockopt + +
+ + +
+

Constructors

+
+
+
+ ZMQ_AFFINITY +
+
+
+ +
+ +
+
+
+
+ ZMQ_BACKLOG +
+
+
+ +
+ +
+
+
+
+ ZMQ_EVENTS +
+
+
+ +
+ +
+
+
+
+ ZMQ_FD +
+
+
+ +
+ +
+
+
+
+ ZMQ_HWM +
+
+
+ +
+ +
+
+
+
+ ZMQ_IDENTITY +
+
+
+ +
+ +
+
+
+
+ ZMQ_LINGER +
+
+
+ +
+ +
+
+
+
+ ZMQ_MCAST_LOOP +
+
+
+ +
+ +
+
+
+
+ ZMQ_RATE +
+
+
+ +
+ +
+
+
+
+ ZMQ_RCVBUF +
+
+
+ +
+ +
+
+
+
+ ZMQ_RCVMORE +
+
+
+ +
+ +
+
+
+
+ ZMQ_RECONNECT_IVL +
+
+
+ +
+ +
+
+
+
+ ZMQ_RECONNECT_IVL_MAX +
+
+
+ +
+ +
+
+
+
+ ZMQ_RECOVERY_IVL +
+
+
+ +
+ +
+
+
+
+ ZMQ_RECOVERY_IVL_MSEC +
+
+
+ +
+ +
+
+
+
+ ZMQ_SNDBUF +
+
+
+ +
+ +
+
+
+
+ ZMQ_SUBSCRIBE +
+
+
+ +
+ +
+
+
+
+ ZMQ_SWAP +
+
+
+ +
+ +
+
+
+
+ ZMQ_TYPE +
+
+
+ +
+ +
+
+
+
+ ZMQ_UNSUBSCRIBE +
+
+
+ +
+ +
+
+
+
+ +
+ + + + diff --git a/docs/types/org/zeromq/SocketType.html b/docs/types/org/zeromq/SocketType.html new file mode 100644 index 0000000..a800b4e --- /dev/null +++ b/docs/types/org/zeromq/SocketType.html @@ -0,0 +1,148 @@ + + + + + SocketType (Haxe Application) + + + + + + + + +
+ +

org.zeromq.SocketType

+
+
defined in
+
org.zeromq.ZMQ
+
available in
+
cpp
+
+ +
+ + + Enumeration of 0MQ socket types + +
+ + +
+

Constructors

+
+
+
+ ZMQ_DEALER +
+
+
+ +
+ +
+
+
+
+ ZMQ_PAIR +
+
+
+ +
+ +
+
+
+
+ ZMQ_PUB +
+
+
+ +
+ +
+
+
+
+ ZMQ_PULL +
+
+
+ +
+ +
+
+
+
+ ZMQ_PUSH +
+
+
+ +
+ +
+
+
+
+ ZMQ_REP +
+
+
+ +
+ +
+
+
+
+ ZMQ_REQ +
+
+
+ +
+ +
+
+
+
+ ZMQ_ROUTER +
+
+
+ +
+ +
+
+
+
+ ZMQ_SUB +
+
+
+ +
+ +
+
+
+
+ +
+ + + + diff --git a/docs/types/org/zeromq/ZMQ.html b/docs/types/org/zeromq/ZMQ.html new file mode 100644 index 0000000..07ae488 --- /dev/null +++ b/docs/types/org/zeromq/ZMQ.html @@ -0,0 +1,562 @@ + + + + + ZMQ (Haxe Application) + + + + + + + + +
+ +

org.zeromq.ZMQ

+
+
type
+
class
+
available in
+
cpp
+
+ +
+ + + Core class for 0MQ Haxe bindings + +
+ +
+

Static Variables

+
+
+
+

+ + FORWARDER(inline,null) : Int +

+
+
+ +
+
+ +
+ Flag to specify a FORWARDER device. +
+
+
+
+
+

+ + QUEUE(inline,null) : Int +

+
+
+ +
+
+ +
+ Flag to specify a QUEUE device. +
+
+
+
+
+

+ + STREAMER(inline,null) : Int +

+
+
+ +
+
+ +
+ Flag to specify a STREAMER device. +
+
+
+
+
+

+ + bytesSocketOptionTypes : Array<SocketOptionsType> +

+
+
+ +
+
+ +
+
+
+
+

+ + int64SocketOptionTypes : Array<SocketOptionsType> +

+
+
+ +
+
+ +
+
+
+
+

+ + intSocketOptionTypes : Array<SocketOptionsType> +

+
+
+ +
+
+ +
+
+
+
+ +
+

Static Methods

+
+
+
+

+ + inline + ZMQ_POLLERR() : Int +

+
+
+
+ +
+ +
+
+
+
+

+ + inline + ZMQ_POLLIN() : Int +

+
+
+
+ +
+ +
+
+
+
+

+ + inline + ZMQ_POLLOUT() : Int +

+
+
+
+ +
+ +
+
+
+
+

+ + catchSignals() : Void +

+
+
+
+ + + + + + + + + + +
+ +
+ Sets up interrupt signal handling. + Use isInterrupted() to subsequwnrly test for interruption +
+
+
+
+
+

+ + errNoToErrorType(e : Int) : ErrorType +

+
+
+
+ + + +
parameters
+
e
+ +
returns
+
+ + + + + + +
+ +
+ Converts ZMQ errNo integer value to Haxe ErrorType enum value
+
+
+
+
+

+ + errorTypeToErrNo(e : ErrorType) : Int +

+
+
+
+ + + +
parameters
+
e
+ +
returns
+
+ + + + + + +
+ +
+ Converts Haxe ErrorType enum value to ZMQ errNo integer value
+
+
+
+
+

+ + isInterrupted() : Bool +

+
+
+
+ + + + +
returns
+
True if 0MQ has been interrupted
+ + + + + + +
+ +
+ Indicates if 0MQ has been interrupted by a system signal (SIGINT or SIGTERM) + Use this method to detect interrupt, and exit cleanly (close 0MQ sockets and contexts), + particularly after recvMsg() and poll() calls. + See: http://zguide.zeromq.org/page:all#Handling-Interrupt-Signals +
+
+
+
+
+

+ + makeVersion(major : Int, minor : Int, patch : Int) : Int +

+
+
+
+ + + +
parameters
+
major
+
minor
+
patch
+ +
returns
+
+ + + + + + +
+ +
+ Creates an integer in same form as given by versionFull()
+
+
+
+
+

+ + sendReceiveFlagNo(type : SendReceiveFlagType) : Int +

+
+
+
+ + + +
parameters
+
type
+ +
returns
+
+ + + + + + +
+ +
+ Converts a SendReceiveFlagType enum value into the corresponding 0MQ library int value
+
+
+
+
+

+ + socketOptionTypeNo(option : SocketOptionsType) : Int +

+
+
+
+ + + +
parameters
+
option
+ +
returns
+
+ + + + + + +
+ +
+ Converts a SocketOptionsType enum into a ZMQ int
+
+
+
+
+

+ + socketTypeNo(type : SocketType) : Int +

+
+
+
+ + + +
parameters
+
type
+ +
returns
+
+ + + + + + +
+ +
+ Converts a SocketType enum into a ZMQ socket type integer value
+
+
+
+
+

+ + strError(e : Int) : String +

+
+
+
+ + + +
parameters
+
errNo A valid 0MQ error number. Use the errorTypeToErrNo method to convert a ZMQ.ErrorType
+ +
returns
+
A short description of the error
+ + + + + + +
+ +
+ Returns a human-readable description from a ZMQException object errNo number
+
+
+
+
+

+ + versionMajor() : Int +

+
+
+
+ + + + +
returns
+
0MQ major library version (2, 3 etc)
+ + + + + + +
+ +
+ Gets 0MQ library major version
+
+
+
+
+

+ + versionMinor() : Int +

+
+
+
+ + + + +
returns
+
0MQ minor library version
+ + + + + + +
+ +
+ Gets 0MQ library minor version
+
+
+
+
+

+ + versionPatch() : Int +

+
+
+
+ + + + +
returns
+
0MQ library patch version
+ + + + + + +
+ +
+ Gets 0MQ library patch version
+
+
+
+
+

+ + version_full() : Int +

+
+
+
+ + + + +
returns
+
0MQ library version in form MMmmpp (MM=major, mm=minor, pp=patch)
+ + + + + + +
+ +
+ Gets complete 0MQ library version
+
+
+
+
+
+ + + + diff --git a/docs/types/org/zeromq/ZMQContext.html b/docs/types/org/zeromq/ZMQContext.html new file mode 100644 index 0000000..7def7fe --- /dev/null +++ b/docs/types/org/zeromq/ZMQContext.html @@ -0,0 +1,212 @@ + + + + + ZMQContext (Haxe Application) + + + + + + + + +
+ +

org.zeromq.ZMQContext

+
+
type
+
class
+
available in
+
cpp
+
+ +
+
+ +
+

Static Methods

+
+
+
+

+ + instance(?ioThreads : Int) : ZMQContext +

+
+
+
+ + + +
parameters
+
?ioThreads = 1
+ + + + + + + +
+ +
+ Returns a global ZMQContext instance, or null +
+
+
+
+
+ +
+

Instance Variables +

+
+ +
+
+

+ + closed(default,null) : Bool +

+
+
+ +
+
+ +
Records if context has been terminated
+
+
+ + +
+
+

+ + contextHandle(default,null) : Dynamic +

+
+
+ +
+
+ +
Opaque data used by hxzmq driver
+
+
+ +
+
+ +
+

Instance Methods +

+
+ +
+
+

+ + poller() : ZMQPoller +

+
+
+
+ + + + +
returns
+
A ZMQPoller object
+ + + + + + +
+ +
+ Convenience method to create a ZMQPoller object. + Raises a ENOTSUP ZMQException if context is closed
+
+
+ + +
+
+

+ + socket(type : SocketType) : ZMQSocket +

+
+
+
+ + + +
parameters
+
socketType The socket type which can be any of the ZMQ socket types
+ +
returns
+
A ZMQSocket object
+ + + + + + +
+ +
+ Create a Socket associated with this Context
+
+
+ + +
+
+

+ + term() : Void +

+
+
+
+ + + + + + + + + + +
+ +
+ Close or terminate the context + + This can be called to close the context by hand. If this is not + called, the context will automatically be closed when it is + garbage collected. +
+
+
+ +
+
+
+ + + + diff --git a/docs/types/org/zeromq/ZMQException.html b/docs/types/org/zeromq/ZMQException.html new file mode 100644 index 0000000..d26984d --- /dev/null +++ b/docs/types/org/zeromq/ZMQException.html @@ -0,0 +1,151 @@ + + + + + ZMQException (Haxe Application) + + + + + + + + +
+ +

org.zeromq.ZMQException

+
+
type
+
class
+
available in
+
cpp
+
+ +
+ + + Encapsulates ZMQ Errors + Provides the ZMQ - specified errno and a human - readable description + +
+ +
+

Constructor

+
+
+
+ + new(e : ErrorType, ?str : String) +
+
+
+ +
+ +
+
+
+
+ +
+

Instance Variables +

+
+ +
+
+

+ + err(default,null) : ErrorType +

+
+
+ +
+
+ +
+
+ + +
+
+

+ + errNo(default,null) : Int +

+
+
+ +
+
+ +
+
+ +
+
+ +
+

Instance Methods +

+
+ +
+
+

+ + str() : String +

+
+
+
+ + + + +
returns
+
+ + + + + + +
+ +
+ Returns ZMQ - specified human-readable error description
+
+
+ + +
+
+

+ + toString() : String +

+
+
+
+ +
+ +
+
+ +
+
+
+ + + + diff --git a/docs/types/org/zeromq/ZMQInt64Type.html b/docs/types/org/zeromq/ZMQInt64Type.html new file mode 100644 index 0000000..f573e22 --- /dev/null +++ b/docs/types/org/zeromq/ZMQInt64Type.html @@ -0,0 +1,78 @@ + + + + + ZMQInt64Type (Haxe Application) + + + + + + + +
+ +

org.zeromq.ZMQInt64Type

+
+
defined in
+
org.zeromq.ZMQ
+
available in
+
cpp
+ +
+ +
+ + + Used to pass 64 bit ints to setlongsockopt + +
+ +
+ +

Fields in +cpp +

+
+
+
+

+ var hi : Int +

+
+
+ +
+
+ +
+
+
+
+

+ var lo : Int +

+
+
+ +
+
+ +
+
+
+
+ +
+ + + + + diff --git a/docs/types/org/zeromq/ZMQPoller.html b/docs/types/org/zeromq/ZMQPoller.html new file mode 100644 index 0000000..7673f3c --- /dev/null +++ b/docs/types/org/zeromq/ZMQPoller.html @@ -0,0 +1,339 @@ + + + + + ZMQPoller (Haxe Application) + + + + + + + + +
+ +

org.zeromq.ZMQPoller

+
+
type
+
class
+
available in
+
cpp
+
+ +
+ + + Encapsulates ZMQ Poller functions. + + Statefull class, maintaining a set of sockets to poll, events to poll for + +
+ +
+

Constructor

+
+
+
+ + new() +
+
+
+ + + + + + + + + + +
+ +
+ Constructor +
+
+
+
+
+ +
+

Instance Variables +

+
+ +
+
+

+ + revents(default,null) : Array<Int> +

+
+
+ +
+
+ +
+ Provides the last-polled set of rececived events +
+
+
+ +
+
+ +
+

Instance Methods +

+
+ +
+
+

+ + getSize() : Int +

+
+
+
+ +
+ +
+
+ + +
+
+

+ + noevents(s : Int) : Bool +

+
+
+
+ + + +
parameters
+
s Valid s parameter range from 1 to revents.length
+ +
returns
+
True if no received polled events on the socket
+ + + + + + +
+ +
+ Test of the s'th registered socket has no received polled events
+
+
+ + +
+
+

+ + poll(?timeout : Int) : Int +

+
+
+
+ + + +
parameters
+
?timeout Timeout in microseconds, or 0 to return immediately, or -1 to block indefintely (default)
+ +
returns
+
how many objects signalled, or 0 if none, or -1 if failure
+ + + + + + +
+ +
+ Poll a set of 0MQ sockets,
+
+
+ + +
+
+

+ + pollin(s : Int) : Bool +

+
+
+
+ + + +
parameters
+
s Valid s parameter range from 1 to revents.length
+ +
returns
+
True if specified registered socket has a current POLLIN event, else False
+ + + + + + +
+ +
+ Test if the s'th registered socket has a registered POLLIN event. + Call this after a poll() method call to test the results. +
+
+
+ + +
+
+

+ + pollout(s : Int) : Bool +

+
+
+
+ + + +
parameters
+
s Valid s parameter range from 1 to revents.length
+ +
returns
+
True if specified registered socket has a current POLLOUT event, else False
+ + + + + + +
+ +
+ Test if the s'th registered socket has a registered POLLOUT event. + Call this after a poll() method call to test the results. +
+
+
+ + +
+
+

+ + registerSocket(socket : ZMQSocket, event : Int) : Void +

+
+
+
+ + + +
parameters
+
socket A ZMQScxket object
+
event Bitmasked Int for polled events (ZMQ_POLLIN, ZMQ_POLLOUT)
+ + + + + + + +
+ +
+ Adds a socket to the internak list of polled sockets
+
+
+ + +
+
+

+ + unregisterAllSockets() : Void +

+
+
+
+ + + + + + + + + + +
+ +
+ Removes all current registered sockets +
+
+
+ + +
+
+

+ + unregisterSocket(socket : ZMQSocket) : Bool +

+
+
+
+ + + +
parameters
+
socket
+ +
returns
+
+ + + + + + +
+ +
+ Removes a previously registered socket
+
+
+ +
+
+
+ + + + diff --git a/docs/types/org/zeromq/ZMQSocket.html b/docs/types/org/zeromq/ZMQSocket.html new file mode 100644 index 0000000..bfd45b7 --- /dev/null +++ b/docs/types/org/zeromq/ZMQSocket.html @@ -0,0 +1,412 @@ + + + + + ZMQSocket (Haxe Application) + + + + + + + + +
+ +

org.zeromq.ZMQSocket

+
+
type
+
class
+
available in
+
cpp
+
+ +
+ + + A 0MQ socket + + These objects will generally be created via the socket() method of a ZMQContext object. + + Class based on code from pyzmq project + See: https://github.com/zeromq/pyzmq/blob/master/zmq/core/socket.pyx + +
+ +
+

Constructor

+
+
+
+ + new(context : ZMQContext, type : SocketType) +
+
+
+ + + +
parameters
+
context A ZMQ Context previously created
+
type A ZMQ socket type
+ + + + + + + +
+ +
+ Constructor. + + Creates a new ZMQ socket
+
+
+
+
+ +
+

Instance Variables +

+
+ +
+
+

+ + _socketHandle(default,null) : Dynamic +

+
+
+ +
+
+ +
Opaque data used by hxzmq driver
+
+
+ + +
+
+

+ + closed(default,null) : Bool +

+
+
+ +
+
+ +
Records if socket has been closed
+
+
+ + +
+
+

+ + context(default,null) : ZMQContext +

+
+
+ +
+
+ +
+ Hold reference to context associated with socket, to stop it being garbage collected +
+
+
+ +
+
+ +
+

Instance Methods +

+
+ +
+
+

+ + bind(addr : String) : Void +

+
+
+
+ + + +
parameters
+
addr The address string. This has the form 'protocol://interface:port', for example 'tcp://127.0.0.1:5555'. Protocols supported are tcp, upd, pgm, inproc and ipc. If the address is unicode, it is encoded to utf-8 first.
+ + + + + + + +
+ +
+ Bind a socket to an address + + This causes the socket to listen on a network port. Sockets on the + other side of this connection will use ``Socket.connect(addr)`` to + connect to this socket. +
+
+
+ + +
+
+

+ + close() : Void +

+
+
+
+ + + + + + + + + + +
+ +
+ Close the socket + + This can be called to close the socket by hand. If this is not + called, the socket will automatically be closed when it is + garbage collected. +
+
+
+ + +
+
+

+ + connect(addr : String) : Void +

+
+
+
+ + + +
parameters
+
addr The address string This has the form 'protocol://interface:port', for example 'tcp://127.0.0.1:5555'. Protocols supported are tcp, upd, pgm, inproc and ipc. If the address is unicode, it is encoded to utf-8 first.
+ + + + + + + +
+ +
+ Connect to a remote ZMQ socket +
+
+
+ + +
+
+

+ + getsockopt(option : SocketOptionsType) : Dynamic +

+
+
+
+ + + +
parameters
+
option
+ +
returns
+
+ + + + + + +
+ +
+ Return a previously set socket option +
+
+
+ + +
+
+

+ + hasReceiveMore() : Bool +

+
+
+
+ + + + +
returns
+
+ + + + + + +
+ +
+ Convenience method to test if socket has more parts of a multipart message to read
+
+
+ + +
+
+

+ + recvMsg(?flags : SendReceiveFlagType) : haxe.io.Bytes +

+
+
+
+ + + +
parameters
+
?flags
+ +
returns
+
+ + + + + + +
+ +
+ Receive a message on this socket + + Will return either a message, null (if DONTWAIT was used and there was no data received) or a ZMQException +
+
+
+ + +
+
+

+ + sendMsg(data : haxe.io.Bytes, ?flags : SendReceiveFlagType) : Void +

+
+
+
+ + + +
parameters
+
data The content of the message
+
?flags Any supported SocketFlag DONTWAIT, SNDMORE
+ + + + + + + +
+ +
+ Send a message on this socket + + This queues the message to be sent by the IO thread at a later time. +
+
+
+ + +
+
+

+ + setsockopt(option : SocketOptionsType, optval : Dynamic) : Void +

+
+
+
+ + + +
parameters
+
option SocketOptionsType (defined in ZMQ.hx)
+
optval Either Int or String or Bytes
+ + + + + + + +
+ +
+ Set socket options. + + See the ZMQ documentation for details on specific options: + http://api.zeromq.org/master:zmq-setsockopt + + C Parameter type optval haXe type expected + ================= ========================== + int Int + int64_t, uint64_t ZMQInt64Type (if neko or cpp) + Int (if php - will be 64bits on 64bit platforms, else 32 bit) + binary haxe.io.Bytes +
+
+
+ +
+
+
+ + + + diff --git a/docs/types/org/zeromq/remoting/ZMQConnection.html b/docs/types/org/zeromq/remoting/ZMQConnection.html new file mode 100644 index 0000000..fc66d02 --- /dev/null +++ b/docs/types/org/zeromq/remoting/ZMQConnection.html @@ -0,0 +1,200 @@ + + + + + ZMQConnection (Haxe Application) + + + + + + + + +
+ +

org.zeromq.remoting.ZMQConnection

+
+
type
+
class
+
implements
+
haxe.remoting.AsyncConnection
+
Dynamic
+
available in
+
cpp
+
+ +
+ + + This class provides a haXe remoting adapter using the zeroMQ message + library (via hxzmq) as the transport layer + +
+ +
+

Static Methods

+
+
+
+

+ + create(s : org.zeromq.ZMQSocket, ?ctx : haxe.remoting.Context) : ZMQConnection +

+
+
+
+ +
+ +
+
+
+
+ +
+

Instance Methods +

+
+ +
+
+

+ + call(params : Array<Dynamic>, ?onResult : Dynamic -> Void) : Void +

+
+
+
+ +
+ +
+
+ + +
+
+

+ + close() : Void +

+
+
+
+ +
+ +
+
+ + +
+
+

+ + getProtocol() : ZMQSocketProtocol +

+
+
+
+ +
+ +
+
+ + +
+
+

+ + processMessage(data : String) : Void +

+
+
+
+ +
+ +
+
+ + +
+
+

+ + resolve(name : String) : haxe.remoting.AsyncConnection +

+
+
+
+ +
+ +
+
+ + +
+
+

+ + setErrorHandler(h : Dynamic -> Void) : Void +

+
+
+
+ +
+ +
+
+ + +
+
+

+ + setErrorLogger(h : Array<String> -> Array<Dynamic> -> Dynamic -> Void) : Void +

+
+
+
+ +
+ +
+
+ + +
+
+

+ + setProtocol(p : ZMQSocketProtocol) : Void +

+
+
+
+ +
+ +
+
+ +
+
+
+ + + + diff --git a/docs/types/org/zeromq/remoting/ZMQSocketProtocol.html b/docs/types/org/zeromq/remoting/ZMQSocketProtocol.html new file mode 100644 index 0000000..5cfa77d --- /dev/null +++ b/docs/types/org/zeromq/remoting/ZMQSocketProtocol.html @@ -0,0 +1,248 @@ + + + + + ZMQSocketProtocol (Haxe Application) + + + + + + + + +
+ +

org.zeromq.remoting.ZMQSocketProtocol

+
+
type
+
class
+
available in
+
cpp
+
+ +
+ + + ZeroMQ - based socket protocol for haXe remoting. + Heavily based on the haxe.remoting.SocketProtocol class implementation. + + The ZeroMQ haXe Remoting Socket Protocol is composed of serialized strings converted into byte data exchanges. + Eeach message (request or answer) is sent as a single-part zeroMQ message. + + A request string is composed of the following serialized values : + - the boolean true for a request + - an array of strings representing the object+method path + - an array of parameters + A response string is composed of the following serialized values : + - the boolean false for a response + - a serialized value representing the result + Exceptions are serialized with serializeException so they will be thrown immediatly + when they are unserialized. + +
+ +
+

Constructor

+
+
+
+ + new(sock : org.zeromq.ZMQSocket, ctx : haxe.remoting.Context) +
+
+
+ +
+ +
+
+
+
+ +
+

Instance Variables +

+
+ +
+
+

+ + context : haxe.remoting.Context +

+
+
+ +
+
+ +
+
+ + +
+
+

+ + socket : org.zeromq.ZMQSocket +

+
+
+ +
+
+ +
+
+ +
+
+ +
+

Instance Methods +

+
+ +
+
+

+ + dynamic + decodeData(data : String) : String +

+
+
+
+ +
+ +
+
+ + +
+
+

+ + isRequest(data : String) : Bool +

+
+
+
+ +
+ +
+
+ + +
+
+

+ + processAnswer(data : String) : Dynamic +

+
+
+
+ +
+ +
+
+ + +
+
+

+ + processRequest(data : String, ?onError : Array<String> -> Array<Dynamic> -> Dynamic -> Void) : Void +

+
+
+
+ +
+ +
+
+ + +
+
+

+ + readMessage() : String +

+
+
+
+ +
+ +
+
+ + +
+
+

+ + sendAnswer(answer : Dynamic, ?isException : Bool) : Void +

+
+
+
+ +
+ +
+
+ + +
+
+

+ + sendMessage(msg : String) : Void +

+
+
+
+ +
+ +
+
+ + +
+
+

+ + sendRequest(path : Array<String>, params : Array<Dynamic>) : Void +

+
+
+
+ +
+ +
+
+ +
+
+
+ + + + diff --git a/org/zeromq/IncludeAll.hx b/org/zeromq/IncludeAll.hx new file mode 100644 index 0000000..3e3f7f8 --- /dev/null +++ b/org/zeromq/IncludeAll.hx @@ -0,0 +1,33 @@ +/** + * (c) 2011 Richard J Smith + * + * This file is part of hxzmq + * + * hxzmq is free software; you can redistribute it and/or modify it under + * the terms of the Lesser GNU General Public License as published by + * the Free Software Foundation; either version 3 of the License, or + * (at your option) any later version. + * + * hxzmq is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * Lesser GNU General Public License for more details. + * + * You should have received a copy of the Lesser GNU General Public License + * along with this program. If not, see . + */ + +package org.zeromq; + +import org.zeromq.ZMQ; +import org.zeromq.ZMQContext; +import org.zeromq.ZMQException; +import org.zeromq.ZMQPoller; +import org.zeromq.ZMQSocket; +import org.zeromq.remoting.ZMQConnection; +import org.zeromq.remoting.ZMQSocketProtocol; + +#if php +import org.zeromq.externals.phpzmq.ZMQException; +import org.zeromq.externals.phpzmq.ZMQSocketException; +#end