/builddir/build/BUILD/qpid-proton-0.7/proton-c/include/proton/selectable.h File Reference

The selectable API provides an interface for integration with third party event loops. More...

#include <proton/import_export.h>
#include <proton/object.h>
#include <proton/io.h>
#include <proton/type_compat.h>

Go to the source code of this file.

Defines

#define PROTON_SELECTABLE_H   1

Typedefs

typedef pn_iterator_t pn_selectables_t
 An iterator for selectables.
typedef struct pn_selectable_t pn_selectable_t
 A selectable object provides an interface that can be used to incorporate proton's I/O into third party event loops.

Functions

PN_EXTERN pn_selectables_tpn_selectables (void)
 Construct a new selectables iterator.
PN_EXTERN pn_selectable_tpn_selectables_next (pn_selectables_t *selectables)
 Get the next selectable from an iterator.
PN_EXTERN void pn_selectables_free (pn_selectables_t *selectables)
 Free a selectables iterator.
PN_EXTERN pn_socket_t pn_selectable_fd (pn_selectable_t *selectable)
 Get the file descriptor associated with a selectable.
PN_EXTERN ssize_t pn_selectable_capacity (pn_selectable_t *selectable)
 Get the capacity of a selectable.
PN_EXTERN ssize_t pn_selectable_pending (pn_selectable_t *selectable)
 Get the number of bytes pending for a selectable.
PN_EXTERN pn_timestamp_t pn_selectable_deadline (pn_selectable_t *selectable)
 Get the next deadline for a selectable.
PN_EXTERN void pn_selectable_readable (pn_selectable_t *selectable)
 Notify a selectable that the file descriptor is readable.
PN_EXTERN void pn_selectable_writable (pn_selectable_t *selectable)
 Notify a selectable that the file descriptor is writable.
PN_EXTERN void pn_selectable_expired (pn_selectable_t *selectable)
 Notify a selectable that its deadline has expired.
PN_EXTERN bool pn_selectable_is_registered (pn_selectable_t *selectable)
 Check if a selectable is registered.
PN_EXTERN void pn_selectable_set_registered (pn_selectable_t *selectable, bool registered)
 Set the registered flag for a selectable.
PN_EXTERN bool pn_selectable_is_terminal (pn_selectable_t *selectable)
 Check if a selectable is in the terminal state.
PN_EXTERN void pn_selectable_free (pn_selectable_t *selectable)
 Free a selectable object.

Detailed Description

The selectable API provides an interface for integration with third party event loops.


Define Documentation

#define PROTON_SELECTABLE_H   1
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Defines

Generated on 24 Sep 2014 for proton by  doxygen 1.6.1