laag-libczmq 4.1.0.0

data/vendor/github.com/zeromq/czmq/api/ziflist.api

@@ -0,0 +1,73 @@
+<class name = "ziflist" state = "stable">
+    <!--
+    Copyright (c) the Contributors as noted in the AUTHORS file.
+    This file is part of CZMQ, the high-level C binding for 0MQ:
+    http://czmq.zeromq.org.
+
+    This Source Code Form is subject to the terms of the Mozilla Public
+    License, v. 2.0. If a copy of the MPL was not distributed with this
+    file, You can obtain one at http://mozilla.org/MPL/2.0/.
+    -->
+    List of network interfaces available on system
+
+    <constructor>
+        Get a list of network interfaces currently defined on the system
+    </constructor>
+
+    <destructor>
+        Destroy a ziflist instance
+    </destructor>
+
+    <method name = "reload">
+        Reload network interfaces from system
+    </method>
+
+    <method name = "size">
+        Return the number of network interfaces on system
+        <return type = "size" />
+    </method>
+
+    <method name = "first">
+        Get first network interface, return NULL if there are none
+        <return type = "string" />
+    </method>
+
+    <method name = "next">
+        Get next network interface, return NULL if we hit the last one
+        <return type = "string" />
+    </method>
+
+    <method name = "address">
+        Return the current interface IP address as a printable string
+        <return type = "string" />
+    </method>
+
+    <method name = "broadcast">
+        Return the current interface broadcast address as a printable string
+        <return type = "string" />
+    </method>
+
+    <method name = "netmask">
+        Return the current interface network mask as a printable string
+        <return type = "string" />
+    </method>
+
+    <method name = "print">
+        Return the list of interfaces.
+    </method>
+
+    <method name = "new ipv6" singleton = "1" state = "draft">
+        Get a list of network interfaces currently defined on the system
+        Includes IPv6 interfaces
+        <return type = "ziflist" fresh = "1" />
+    </method>
+
+    <method name = "reload ipv6" state = "draft">
+        Reload network interfaces from system, including IPv6
+    </method>
+
+    <method name = "is ipv6" state = "draft">
+        Return true if the current interface uses IPv6
+        <return type = "boolean" />
+    </method>
+</class>

data/vendor/github.com/zeromq/czmq/api/zlist.api

@@ -0,0 +1,158 @@
+<class name = "zlist" state = "stable">
+    <!--
+    Copyright (c) the Contributors as noted in the AUTHORS file.
+    This file is part of CZMQ, the high-level C binding for 0MQ:
+    http://czmq.zeromq.org.
+
+    This Source Code Form is subject to the terms of the Mozilla Public
+    License, v. 2.0. If a copy of the MPL was not distributed with this
+    file, You can obtain one at http://mozilla.org/MPL/2.0/.
+    -->
+    simple generic list container
+
+    <callback_type name = "compare_fn">
+        Comparison function e.g. for sorting and removing.
+        <argument name = "item1" type = "anything" />
+        <argument name = "item2" type = "anything" />
+        <return type = "integer" />
+    </callback_type>
+
+    <callback_type name = "free_fn">
+        Callback function for zlist_freefn method
+        <argument name = "data" type = "anything" />
+    </callback_type>
+
+    <constructor>
+        Create a new list container
+    </constructor>
+
+    <destructor>
+        Destroy a list container
+    </destructor>
+
+    <method name = "first">
+        Return the item at the head of list. If the list is empty, returns NULL.
+        Leaves cursor pointing at the head item, or NULL if the list is empty.
+        <return type = "anything" />
+    </method>
+
+    <method name = "next">
+        Return the next item. If the list is empty, returns NULL. To move to
+        the start of the list call zlist_first (). Advances the cursor.
+        <return type = "anything" />
+    </method>
+
+    <method name = "last">
+        Return the item at the tail of list. If the list is empty, returns NULL.
+        Leaves cursor pointing at the tail item, or NULL if the list is empty.
+        <return type = "anything" />
+    </method>
+
+    <method name = "head">
+        Return first item in the list, or null, leaves the cursor
+        <return type = "anything" />
+    </method>
+
+    <method name = "tail">
+        Return last item in the list, or null, leaves the cursor
+        <return type = "anything" />
+    </method>
+
+    <method name = "item">
+        Return the current item of list. If the list is empty, returns NULL.
+        Leaves cursor pointing at the current item, or NULL if the list is empty.
+        <return type = "anything" />
+    </method>
+
+    <method name = "append">
+        Append an item to the end of the list, return 0 if OK or -1 if this
+        failed for some reason (out of memory). Note that if a duplicator has
+        been set, this method will also duplicate the item.
+        <argument name = "item" type = "anything" />
+        <return type = "integer" />
+    </method>
+
+    <method name = "push">
+        Push an item to the start of the list, return 0 if OK or -1 if this
+        failed for some reason (out of memory). Note that if a duplicator has
+        been set, this method will also duplicate the item.
+        <argument name = "item" type = "anything" />
+        <return type = "integer" />
+    </method>
+
+    <method name = "pop">
+        Pop the item off the start of the list, if any
+        <return type = "anything" />
+    </method>
+
+    <method name = "exists">
+        Checks if an item already is present. Uses compare method to determine if
+        items are equal. If the compare method is NULL the check will only compare
+        pointers. Returns true if item is present else false.
+        <argument name = "item" type = "anything" />
+        <return type = "boolean" />
+    </method>
+
+    <method name = "remove">
+        Remove the specified item from the list if present
+        <argument name = "item" type = "anything" />
+    </method>
+
+    <method name = "dup">
+        Make a copy of list. If the list has autofree set, the copied list will
+        duplicate all items, which must be strings. Otherwise, the list will hold
+        pointers back to the items in the original list. If list is null, returns
+        NULL.
+        <return type = "zlist" fresh = "1" />
+    </method>
+
+    <method name = "purge">
+        Purge all items from list
+    </method>
+
+    <method name = "size">
+        Return number of items in the list
+        <return type = "size" />
+    </method>
+
+    <method name = "sort">
+        Sort the list. If the compare function is null, sorts the list by
+        ascending key value using a straight ASCII comparison. If you specify
+        a compare function, this decides how items are sorted. The sort is not
+        stable, so may reorder items with the same keys. The algorithm used is
+        combsort, a compromise between performance and simplicity.
+        <argument name = "compare" type = "zlist_compare_fn" callback = "1" />
+    </method>
+
+    <method name = "autofree">
+        Set list for automatic item destruction; item values MUST be strings.
+        By default a list item refers to a value held elsewhere. When you set
+        this, each time you append or push a list item, zlist will take a copy
+        of the string value. Then, when you destroy the list, it will free all
+        item values automatically. If you use any other technique to allocate
+        list values, you must free them explicitly before destroying the list.
+        The usual technique is to pop list items and destroy them, until the
+        list is empty.
+    </method>
+
+    <method name = "comparefn">
+        Sets a compare function for this list. The function compares two items.
+        It returns an integer less than, equal to, or greater than zero if the
+        first item is found, respectively, to be less than, to match, or be
+        greater than the second item.
+        This function is used for sorting, removal and exists checking.
+        <argument name = "fn" type = "zlist_compare_fn" callback = "1" />
+    </method>
+
+    <method name = "freefn">
+        Set a free function for the specified list item. When the item is
+        destroyed, the free function, if any, is called on that item.
+        Use this when list items are dynamically allocated, to ensure that
+        you don't have memory leaks. You can pass 'free' or NULL as a free_fn.
+        Returns the item, or NULL if there is no such item.
+        <argument name = "item" type = "anything" />
+        <argument name = "fn" type = "zlist_free_fn" callback = "1" />
+        <argument name = "at tail" type = "boolean" />
+        <return type = "anything" />
+    </method>
+</class>

data/vendor/github.com/zeromq/czmq/api/zlistx.api

@@ -0,0 +1,220 @@
+<class name = "zlistx" state = "stable">
+    <!--
+    Copyright (c) the Contributors as noted in the AUTHORS file.
+    This file is part of CZMQ, the high-level C binding for 0MQ:
+    http://czmq.zeromq.org.
+
+    This Source Code Form is subject to the terms of the Mozilla Public
+    License, v. 2.0. If a copy of the MPL was not distributed with this
+    file, You can obtain one at http://mozilla.org/MPL/2.0/.
+    -->
+    extended generic list container
+
+    <callback_type name = "destructor_fn">
+        Destroy an item
+        <argument name = "item" type = "anything" by_reference = "1" />
+    </callback_type>
+
+    <callback_type name = "duplicator_fn">
+        Duplicate an item
+        <argument name = "item" type = "anything" mutable = "0" />
+        <return type = "anything" />
+    </callback_type>
+
+    <callback_type name = "comparator_fn">
+        Compare two items, for sorting
+        <argument name = "item1" type = "anything" mutable = "0" />
+        <argument name = "item2" type = "anything" mutable = "0" />
+        <return type = "integer" />
+    </callback_type>
+
+    <constructor>
+        Create a new, empty list.
+    </constructor>
+
+    <destructor>
+        Destroy a list. If an item destructor was specified, all items in the
+        list are automatically destroyed as well.
+    </destructor>
+
+    <method name = "add_start">
+        Add an item to the head of the list. Calls the item duplicator, if any,
+        on the item. Resets cursor to list head. Returns an item handle on
+        success, NULL if memory was exhausted.
+        <argument name = "item" type = "anything" mutable = "1" />
+        <return type = "anything" mutable = "1" />
+    </method>
+
+    <method name = "add_end">
+        Add an item to the tail of the list. Calls the item duplicator, if any,
+        on the item. Resets cursor to list head. Returns an item handle on
+        success, NULL if memory was exhausted.
+        <argument name = "item" type = "anything" mutable = "1" />
+        <return type = "anything" mutable = "1" />
+    </method>
+
+    <method name = "size">
+        Return the number of items in the list
+        <return type = "size" />
+    </method>
+
+    <method name = "head">
+        Return first item in the list, or null, leaves the cursor
+        <return type = "anything" mutable = "1" />
+    </method>
+
+    <method name = "tail">
+        Return last item in the list, or null, leaves the cursor
+        <return type = "anything" mutable = "1" />
+    </method>
+
+    <method name = "first">
+        Return the item at the head of list. If the list is empty, returns NULL.
+        Leaves cursor pointing at the head item, or NULL if the list is empty.
+        <return type = "anything" mutable = "1" />
+    </method>
+
+    <method name = "next">
+        Return the next item. At the end of the list (or in an empty list),
+        returns NULL. Use repeated zlistx_next () calls to work through the list
+        from zlistx_first (). First time, acts as zlistx_first().
+        <return type = "anything" mutable = "1" />
+    </method>
+
+    <method name = "prev">
+        Return the previous item. At the start of the list (or in an empty list),
+        returns NULL. Use repeated zlistx_prev () calls to work through the list
+        backwards from zlistx_last (). First time, acts as zlistx_last().
+        <return type = "anything" mutable = "1" />
+    </method>
+
+    <method name = "last">
+        Return the item at the tail of list. If the list is empty, returns NULL.
+        Leaves cursor pointing at the tail item, or NULL if the list is empty.
+        <return type = "anything" mutable = "1" />
+    </method>
+
+    <method name = "item">
+        Returns the value of the item at the cursor, or NULL if the cursor is
+        not pointing to an item.
+        <return type = "anything" mutable = "1" />
+    </method>
+
+    <method name = "cursor">
+        Returns the handle of the item at the cursor, or NULL if the cursor is
+        not pointing to an item.
+        <return type = "anything" mutable = "1" />
+    </method>
+
+    <method name = "handle_item" singleton = "1">
+        Returns the item associated with the given list handle, or NULL if passed
+        in handle is NULL. Asserts that the passed in handle points to a list element.
+        <argument name = "handle" type = "anything" mutable = "1" />
+        <return type = "anything" mutable = "1" />
+    </method>
+
+    <method name = "find">
+        Find an item in the list, searching from the start. Uses the item
+        comparator, if any, else compares item values directly. Returns the
+        item handle found, or NULL. Sets the cursor to the found item, if any.
+        <argument name = "item" type = "anything" mutable = "1" />
+        <return type = "anything" mutable = "1" />
+    </method>
+
+    <method name = "detach">
+        Detach an item from the list, using its handle. The item is not modified,
+        and the caller is responsible for destroying it if necessary. If handle is
+        null, detaches the first item on the list. Returns item that was detached,
+        or null if none was. If cursor was at item, moves cursor to previous item,
+        so you can detach items while iterating forwards through a list.
+        <argument name = "handle" type = "anything" mutable = "1" />
+        <return type = "anything" mutable = "1" />
+    </method>
+
+    <method name = "detach_cur">
+        Detach item at the cursor, if any, from the list. The item is not modified,
+        and the caller is responsible for destroying it as necessary. Returns item
+        that was detached, or null if none was. Moves cursor to previous item, so
+        you can detach items while iterating forwards through a list.
+        <return type = "anything" mutable = "1" />
+    </method>
+
+    <method name = "delete">
+        Delete an item, using its handle. Calls the item destructor is any is
+        set. If handle is null, deletes the first item on the list. Returns 0
+        if an item was deleted, -1 if not. If cursor was at item, moves cursor
+        to previous item, so you can delete items while iterating forwards
+        through a list.
+        <argument name = "handle" type = "anything" mutable = "1" />
+        <return type = "integer" />
+    </method>
+
+    <method name = "move_start">
+        Move an item to the start of the list, via its handle.
+        <argument name = "handle" type = "anything" mutable = "1" />
+    </method>
+
+    <method name = "move_end">
+        Move an item to the end of the list, via its handle.
+        <argument name = "handle" type = "anything" mutable = "1" />
+    </method>
+
+    <method name = "purge">
+        Remove all items from the list, and destroy them if the item destructor
+        is set.
+    </method>
+
+    <method name = "sort">
+        Sort the list. If an item comparator was set, calls that to compare
+        items, otherwise compares on item value. The sort is not stable, so may
+        reorder equal items.
+    </method>
+
+    <method name = "insert">
+        Create a new node and insert it into a sorted list. Calls the item
+        duplicator, if any, on the item. If low_value is true, starts searching
+        from the start of the list, otherwise searches from the end. Use the item
+        comparator, if any, to find where to place the new node. Returns a handle
+        to the new node, or NULL if memory was exhausted. Resets the cursor to the
+        list head.
+        <argument name = "item" type = "anything" mutable = "1" />
+        <argument name = "low_value" type = "boolean" />
+        <return type = "anything" mutable = "1" />
+    </method>
+
+    <method name = "reorder">
+        Move an item, specified by handle, into position in a sorted list. Uses
+        the item comparator, if any, to determine the new location. If low_value
+        is true, starts searching from the start of the list, otherwise searches
+        from the end.
+        <argument name = "handle" type = "anything" mutable = "1" />
+        <argument name = "low_value" type = "boolean" />
+    </method>
+
+    <method name = "dup">
+        Make a copy of the list; items are duplicated if you set a duplicator
+        for the list, otherwise not. Copying a null reference returns a null
+        reference.
+        <return type = "zlistx" fresh = "0" />
+    </method>
+
+    <method name = "set destructor">
+        Set a user-defined deallocator for list items; by default items are not
+        freed when the list is destroyed.
+        <argument name = "destructor" type = "zlistx_destructor_fn" callback = "1" />
+    </method>
+
+    <method name = "set duplicator">
+        Set a user-defined duplicator for list items; by default items are not
+        copied when the list is duplicated.
+        <argument name = "duplicator" type = "zlistx_duplicator_fn" callback = "1" />
+    </method>
+
+    <method name = "set comparator">
+        Set a user-defined comparator for zlistx_find and zlistx_sort; the method
+        must return -1, 0, or 1 depending on whether item1 is less than, equal to,
+        or greater than, item2.
+        <argument name = "comparator" type = "zlistx_comparator_fn" callback = "1" />
+    </method>
+
+</class>